Skip to content

Commit

Permalink
docs: proofreading complete
Browse files Browse the repository at this point in the history
  • Loading branch information
dfguerrerom committed Dec 11, 2023
1 parent 4921c59 commit 4378d02
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions doc/en.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
ALOS Kyoto & Carbon Mosaics by JAXA
===================================
ALOS K&C mosaics
================

This module was adapted to the SEPAL environment from `this script by Vollrath <https://code.earthengine.google.com/3784ea8db0b93bcaa41d1a3ada0c055e>`_.
This module allows users to:

Designed on top of the interactive framework `sepal_ui <https://github.com/12rambau/sepal_ui>`_, this module allows users to extract ALOS K&C mosaics.
- extract ALOS Kyoto & Carbon (ALOS K&C) mosaics by JAXA;
- display the mosaics in interactive maps; and
- export the mosaics as Google Earth Engine (GEE) assets and/or SEPAL .tif files.

Designed on top of the interactive framework `sepal_ui <https://github.com/12rambau/sepal_ui>`_, it was adapted to the SEPAL environment from `this script by Vollrath <https://code.earthengine.google.com/3784ea8db0b93bcaa41d1a3ada0c055e>`_.

Necessary inputs include:

- an area of interest (AOI)
- a year
- select filters

The user will be able to display the mosaic in an interactive map and export it as a Google Earth Engine (GEE) asset and/or SEPAL .tif file.

The three-step process is described in the sections below, as well as presented in the following video tutorial.
The three-step process is described in the subsections below, as well as presented in the following video tutorial.

.. youtube:: Asc8Nz0B1DI

Expand All @@ -28,7 +30,7 @@ Using the provided **AOI selector**, select an AOI of your choice between the di

.. note::

If a custom AOI from a shape or drawing is selected, you will be able to use it directly. The upload to GEE will be launched in the background.
If a custom AOI from a shape or drawing is selected, you will be able to use it directly (the upload to GEE will be launched in the background).

Process mosaic
--------------
Expand All @@ -38,12 +40,12 @@ In the **Process** tile, set the different parameters of your mosaic:
- **Year**: the year of interest
- **Speckle filter**: the speckle filter to use during the process
- no filter
- refined lee: speckle noise removal technique based on the Lee Filter (for more information, see `A.S. Yommy et al.<https://doi.org/10.1109/IHMSC.2015.236>`_
- refined lee: speckle noise removal technique based on the Lee Filter (for more information, see `A.S. Yommy et al. <https://doi.org/10.1109/IHMSC.2015.236>`_).
- Quegan filter: See `Quegan et al. <https://doi.org/10.1109/36.964973>`_
- **Shadow masking**: activate or deactivate shadow masking
- **Db**: whether or not to scale the output to Db

After setting your parameters, select the button. The dataset will be automatically sent to the **Vizualization** tile.
After setting your parameters, select the button (the dataset will be automatically sent to the **Vizualization** tile).

.. figure:: https://raw.githubusercontent.com/lecrabe/alos_mosaics/main/doc/img/parameters.png

Expand All @@ -67,7 +69,10 @@ Choose from three diplay options:
Export dataset
--------------

When you're satified with the information displayed, it can be exported for further use in GIS software or in a GEE process. The tool provides two main exportation options: as an asset (in GEE) or a .tif file (in SEPAL).
When you're satified with the information displayed, it can be exported for further use in GIS software or in a GEE process. The tool provides two main exportation options:

- an asset (in GEE), or
- a .tif file (in SEPAL).

Both use the GEE export system and share the same set of parameters:

Expand All @@ -80,12 +85,12 @@ Both use the GEE export system and share the same set of parameters:

.. note::

The default export parameters include: 25 metre resolution with backscatter and RFDI.
The default export parameters include: 25 m resolution with backscatter and RFDI.

.. figure:: https://raw.githubusercontent.com/lecrabe/alos_mosaics/main/doc/img/export.png

Export

.. attention::

When exporting images to SEPAL, do not quit the application until the downloading process is complete.
When exporting images to SEPAL, do not quit the application until the downloading process is complete.

0 comments on commit 4378d02

Please sign in to comment.