diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 687437c317..59e049c871 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,7 +4,7 @@ version: 2 build: - os: ubuntu-20.04 + os: ubuntu-22.04 apt_packages: - graphviz tools: diff --git a/docs/source/_images/cookbook/optical_mosaic/composite_options.png b/docs/source/_images/cookbook/optical_mosaic/composite_options.png index 43023982cc..0b7f8945ee 100644 Binary files a/docs/source/_images/cookbook/optical_mosaic/composite_options.png and b/docs/source/_images/cookbook/optical_mosaic/composite_options.png differ diff --git a/docs/source/_images/cookbook/optical_mosaic/composite_options_advanced.png b/docs/source/_images/cookbook/optical_mosaic/composite_options_advanced.png new file mode 100644 index 0000000000..00101a544f Binary files /dev/null and b/docs/source/_images/cookbook/optical_mosaic/composite_options_advanced.png differ diff --git a/docs/source/_images/cookbook/optical_mosaic/retrieve.png b/docs/source/_images/cookbook/optical_mosaic/retrieve.png index c9b548ab2e..c0022d88cc 100644 Binary files a/docs/source/_images/cookbook/optical_mosaic/retrieve.png and b/docs/source/_images/cookbook/optical_mosaic/retrieve.png differ diff --git a/docs/source/_images/cookbook/optical_mosaic/select_source.png b/docs/source/_images/cookbook/optical_mosaic/select_source.png index 76b0529128..0678e808ba 100644 Binary files a/docs/source/_images/cookbook/optical_mosaic/select_source.png and b/docs/source/_images/cookbook/optical_mosaic/select_source.png differ diff --git a/docs/source/cookbook/optical_mosaic.rst b/docs/source/cookbook/optical_mosaic.rst index 57bd248f55..fe8d82ab9c 100644 --- a/docs/source/cookbook/optical_mosaic.rst +++ b/docs/source/cookbook/optical_mosaic.rst @@ -42,7 +42,7 @@ Once the mosaic recipe is selected, SEPAL will display the recipe process in a n :group: optical-mosaic-recipe :title: The landing page of the optical mosaic recipe -The first step is to change the name of the recipe. This name will be used to identify your files and recipes in SEPAL folders. Use the best-suited convention for your needs. Simply double-click the tab and write a new name. It will default to :code:`Optical_mosaic___`. +The first step is to change the name of the recipe. This name will be used to identify your files and recipes in SEPAL folders. Use the best-suited convention for your needs. Simply double-click the tab and write a new name. It defaults to :code:`Optical_mosaic___`. .. thumbnail:: ../_images/cookbook/optical_mosaic/default_title.png :title: Optical mosaics default title @@ -118,39 +118,33 @@ When the selection is done, select the :icon:`fa-solid fa-check` :guilabel:`Appl Sources ^^^^^^^ -As mentioned in the introduction, a mosaic uses different raster datasets that can be obtained from multiple sources. SEPAL allows you to select data from multiple entry points. Below, you can find a description of these sources (select a link to see the corresponding dataset information): +As mentioned in the introduction, a mosaic combines raster datasets that can come from multiple satellite sources. In the :guilabel:`SRC` tab, select one or more **optical** data sources to build the mosaic from. -- :guilabel:`L8`: `Landsat 8 Tier 1 `__. Landsat scenes with the highest available data quality are placed into **Tier 1** and considered suitable for time-series processing analysis. **Tier 1** includes Level-1 Precision Terrain (L1TP) processed data that have well-characterized radiometry and are intercalibrated across different Landsat sensors. The geo-registration of **Tier 1** scenes will be consistent and within prescribed tolerances (< = 12 m root mean square error [RMSE]). All **Tier 1** Landsat data can be considered consistent and intercalibrated (regardless of the sensor used) across the full collection. +**Landsat** scenes are distributed in two quality tiers: - .. line-break:: +- **Tier 1** holds the scenes with the highest data quality. They are processed to Level-1 Precision Terrain (L1TP), have well-characterized radiometry, are intercalibrated across the different Landsat sensors and are geo-registered within prescribed tolerances (12 m root mean square error [RMSE] or less). Tier 1 scenes are consistent across the full collection and suitable for time-series analysis. +- **Tier 2** (marked :guilabel:`T2`) holds scenes that do not meet the Tier 1 criteria, for example because of significant cloud cover, insufficient ground control or systematic-only terrain correction (L1GT/L1GS). They can still be useful; analyze the RMSE and other properties to determine their suitability for your study. -- :guilabel:`L8 T2`: `Landsat 8 Tier 2 `__. Scenes not meeting **Tier 1** criteria during processing are assigned to **Tier 2**. This includes Systematic terrain (L1GT) and Systematic (L1GS) processed scenes, as well as any L1TP scenes that do not meet the **Tier 1** specifications due to significant cloud cover, insufficient ground control and other factors. Users interested in **Tier 2** scenes can analyze the RMSE and other properties to determine the suitability for use in individual applications and studies. +The following optical sources are available (select a link to open the corresponding Google Earth Engine dataset): - .. line-break:: +- :guilabel:`L9`: `Landsat 9 `__ (Tier 1; from 2021). +- :guilabel:`L8`: `Landsat 8 `__ (Tier 1; from 2013). +- :guilabel:`L7`: `Landsat 7 `__ (Tier 1; from 1999). +- :guilabel:`L4-5`: `Landsat 4 `__ combined with `Landsat 5 `__ (Tier 1; 1982–2012). +- :guilabel:`L9 T2`, :guilabel:`L8 T2`, :guilabel:`L7 T2`, :guilabel:`L4-5 T2`: the **Tier 2** equivalents of the datasets listed above. +- :guilabel:`S2`: `Sentinel-2 `__ (Sentinel-2A and Sentinel-2B; from 2015). A wide-swath, high-resolution, multispectral imaging mission supporting Copernicus Land Monitoring studies, including the monitoring of vegetation, soil and water cover, as well as the observation of inland waterways and coastal areas. -- :guilabel:`L7`: `Landsat 7 Tier 1 `__. Landsat scenes with the highest available data quality are placed into **Tier 1** and are considered suitable for time-series processing analysis. **Tier 1** includes Level-1 Precision Terrain (L1TP) processed data that have well-characterized radiometry and are intercalibrated across different Landsat sensors. The geo-registration of **Tier 1** scenes will be consistent and within prescribed tolerances (< = 12 m RMSE). All **Tier 1** Landsat data can be considered consistent and intercalibrated across the full collection (regardless of the sensor used). - - .. line-break:: - -- :guilabel:`L7 T2`: `Landsat 7 Tier 2 `__. Scenes not meeting **Tier 1** criteria during processing are assigned to **Tier 2**. This includes Systematic terrain (L1GT) and Systematic (L1GS) processed scenes, as well as any L1TP scenes that do not meet the **Tier 1** specifications due to significant cloud cover, insufficient ground control and other factors. Users interested in **Tier 2** scenes can analyze the RMSE and other properties to determine the suitability for use in individual applications and studies. - - .. line-break:: - -- :guilabel:`L4-5`: `Landsat 4 Tier 1 `__ combined with `Landsat 5 Tier 1 `__. Landsat scenes with the highest available data quality are placed into **Tier 1** and are considered suitable for time-series processing analysis. **Tier 1** includes Level-1 Precision Terrain (L1TP) processed data that have well-characterized radiometry and are intercalibrated across different Landsat sensors. The geo-registration of **Tier 1** scenes will be consistent and within prescribed tolerances (< = 12 m RMSE). All **Tier 1** Landsat data can be considered consistent and intercalibrated across the full collection (regardless of the sensor used). - - .. line-break:: - -- :guilabel:`L4-5 T2`: `Landsat 4 TM Tier 2 `__ combined with `Landsat 5 TM Tier 2 `__. Scenes not meeting **Tier 1** criteria during processing are assigned to **Tier 2**. This includes Systematic terrain (L1GT) and Systematic (L1GS) processed scenes, as well as any L1TP scenes that do not meet the **Tier 1** specifications due to significant cloud cover, insufficient ground control and other factors. Users interested in **Tier 2** scenes can analyze the RMSE and other properties to determine the suitability for use in individual applications and studies. - - .. line-break:: +.. note:: -- :guilabel:`A+B`: `Sentinel-2 Multispectral instrument `__ is a wide-swath, high-resolution, multispectral imaging mission supporting Copernicus Land Monitoring studies, including the monitoring of vegetation, soil and water cover, as well as the observation of inland waterways and coastal areas. + SEPAL uses the Landsat **Collection 2** archive and the **harmonized** Sentinel-2 collection. .. thumbnail:: ../_images/cookbook/optical_mosaic/select_source.png :title: The **Source selection** pane :group: optical-mosaic-recipe -To validate your selection, select the :icon:`fa-solid fa-check` :guilabel:`Apply` button. +You can also restrict the imagery with the :code:`Max cloud cover %` slider: scenes whose cloud cover is higher than this threshold are excluded before the mosaic is built. + +To validate your selection, select the :icon:`fa-solid fa-check` :guilabel:`Apply` button (labelled :guilabel:`Done` when you first create the recipe through the setup wizard). Scenes ^^^^^^ @@ -161,121 +155,139 @@ Scenes You can use multiple options to select the best scenes for your mosaic. The most simple is to use every image available based on the date parameters. Select :guilabel:`Use all scenes` and all images will be integrated into the mosaic. -Choose :guilabel:`Select scenes` and choose one of the three available :code:`Priority` options, based on the needs of your analysis (SEPAL sorts the images available for each tile): +Choose :guilabel:`Select scenes` and pick one of the three available :code:`Priority` options, based on the needs of your analysis (SEPAL sorts the images available for each tile): -- :guilabel:`Cloud free`: Prioritizes images with zero or few clouds. -- :guilabel:`Target date`: Prioritizes images that match the target date. -- :guilabel:`Balanced`: Prioritizes images that maximize both cloud and target date. +- :guilabel:`Cloud free`: Prioritizes imagery as cloud-free as possible, ignoring the date. +- :guilabel:`Balanced`: Prioritizes imagery that is neither too cloudy nor too far from the target date. +- :guilabel:`Target date`: Prioritizes imagery as close as possible to the target date. To validate your selection, select the :icon:`fa-solid fa-check` :guilabel:`Apply` button. .. thumbnail:: ../_images/cookbook/optical_mosaic/scene_method.png - :title: The **Source selection** pane + :title: The **Scenes** pane :group: optical-mosaic-recipe Composite ^^^^^^^^^ +The :guilabel:`CMP` tab controls how the selected scenes are corrected, how clouds and snow are masked, and how the final pixel values are computed. The panel opens in a **simple** view showing the most common options; select :guilabel:`More` to reveal the **advanced** options (and :guilabel:`Less` to hide them again). + .. note:: - This step is optional. SEPAL provides the following options by default: + This step is optional. By default, SEPAL applies: - - **Correction**: :guilabel:`SR`, :guilabel:`BRDF` - - **Pixel filters**: No filters - - **Cloud detection**: :guilabel:`QA bands`, :guilabel:`Cloud score` + - **Corrections**: :guilabel:`SR` and :guilabel:`BRDF` - **Cloud masking**: :guilabel:`Moderate` - - **Cloud buffering**: :guilabel:`None` - - **Snow masking**: :guilabel:`On` - **Composing method**: :guilabel:`Medoid` -To create a mosaic, provide SEPAL with the compositing method to create the final image. See the following image for all possible compositing options available. + The advanced view additionally defaults to no pixel filters, no cloud buffering and snow/ice masking turned on. .. thumbnail:: ../_images/cookbook/optical_mosaic/composite_options.png - :title: The pane to select the composite options of your mosaic :group: optical-mosaic-recipe + :title: The composite options pane (simple view) + +.. dropdown:: Show the advanced view (opened with **More**) + :icon: image + :margin: 3 0 0 0 + + .. thumbnail:: ../_images/cookbook/optical_mosaic/composite_options_advanced.png + :width: 30% + :group: optical-mosaic-recipe + :title: The composite options pane (advanced view, opened with **More**) Corrections """"""""""" -This will apply corrections on the stacked pixels to improve the quality of the mosaic. +Corrections are applied to the stacked pixels to improve the quality of the mosaic. -- :guilabel:`SR`: Surface reflectance improves comparison between multiple images over the same region by accounting for atmospheric effects such as aerosol scattering and thin clouds, which can help in the detection and characterization of Earth surface change. Top-of-atmosphere images are used if not selected. -- :guilabel:`BRDF`: Uses a bidirectional reflectance distribution function (BRDF) model to characterize surface reflectance anisotropy. For a given land area, the BRDF is established based on selected multi-angular observations of surface reflectance. -- :guilabel:`Calibrate`: Calibrates Sentinel and Landsat data to make them compatible. +- :guilabel:`SR`: Surface reflectance improves comparison between multiple images over the same region by accounting for atmospheric effects such as aerosol scattering and thin clouds, which can help in the detection and characterization of Earth surface change. Top-of-atmosphere (TOA) images are used if not selected. +- :guilabel:`BRDF`: Uses a bidirectional reflectance distribution function (BRDF) model to characterize surface reflectance anisotropy. For a given land area, the BRDF is established based on selected multi-angular observations of surface reflectance. When BRDF is enabled, the advanced view shows a :code:`BRDF Multiplier` field that controls how much correction is applied (values of 3–4 usually work well; lower it if the effect is overcompensated, raise it if it is not compensated enough). +- :guilabel:`Calibrate`: Calibrates the bands to improve a cross-sensor mosaic. .. note:: This option is only available if: - - Landsat and Sentinel data are mixed; and - - BRDF and surface reflectance (SR) corrections are disabled. + - Landsat and Sentinel-2 data are mixed; and + - surface reflectance (:guilabel:`SR`) correction is disabled. -Pixel filters +Cloud masking """"""""""""" -Activating any of the filters will remove some pixels from the stack. Removing pixels improves the quality of the mosaic, as they are not taken into account in the median value computation. +Controls how clouds are detected and masked. In the simple view, choose a preset: -.. note:: +- :guilabel:`Moderate`: Relies only on the image source QA bands for cloud masking. +- :guilabel:`Aggressive`: Relies on the image source QA bands together with a cloud-scoring algorithm. This will probably mask out some built-up areas and other bright features. +- :guilabel:`Custom`: Automatically selected (and otherwise disabled) when you fine-tune the individual cloud-masking algorithms in the advanced view. - Each filter is applied iteratively (e.g. if the normalized difference vegetation index [NDVI] is already filtering all pixels but one, there will be nothing left in the stack to be filtered by day of year). +In the advanced view you can add and configure the individual cloud-masking algorithms with the :icon:`fa-solid fa-plus` button. The available algorithms depend on the sources you selected: - Note as well that adding filters significantly increases the creation time of the mosaic. +- :guilabel:`SEPAL cloud score`: SEPAL's own cloud-scoring algorithm, with a configurable *maximum cloud probability*. Always available. +- :guilabel:`S2 Cloud Score+`: Sentinel-2 Cloud Score+, with a *maximum cloud probability* and a choice of scoring band — :guilabel:`cs` (instantaneous clear-sky similarity) or :guilabel:`cs_cdf` (likelihood of being clear over time). Sentinel-2 sources only. +- :guilabel:`S2 Cloud Probability`: the Sentinel-2 cloud-probability dataset, with a configurable *maximum cloud probability*. Sentinel-2 sources only. +- :guilabel:`Landsat CFMask`: the Landsat CFMask QA bands. You can set :code:`Cloud Masking`, :code:`Cloud Shadow Masking` and :code:`Cirrus Masking` each to :guilabel:`Off`, :guilabel:`Moderate` or :guilabel:`Aggressive`, and choose whether to :guilabel:`Keep` or :guilabel:`Remove` dilated clouds. Landsat sources only. +- :guilabel:`Pino 26`: the Pan-Tropical Sentinel-2 cloud-detection algorithm developed by Dario Simonetti (for more information, see `D. Simonetti [2021] `__). Only available for a Sentinel-2-exclusive source when :guilabel:`SR` correction is disabled. -- **Shadow**: Filters the XX percent darkest pixels of the stack. -- **Haze**: Computes a haze index and filters the XX percent highest values. -- **NDVI**: Computes the NDVI and only keeps the XX percent highest values. -- **Day of the year**: Computes the distance from target day in days and filters out the XX percent farthest. - -Cloud detection +Cloud buffering """"""""""""""" -Refers to the algorithm used to detect clouds. +(Advanced view.) When pixels are identified as clouds, SEPAL can also mask a small buffer around them to prevent hazy pixels at the borders of clouds from being included in the mosaic. -- :guilabel:`QA bands`: Uses quality assessment (QA) bands to identify clouds in Sentinel data. -- :guilabel:`Cloud score`: Uses the computed cloud score to identify clouds in Landsat data. -- :guilabel:`Pino 26`: Uses the Pino_26 algorithm to identify clouds (for more information, see `D. Simonetti [2021] `__). +.. note:: - .. Note:: + Buffering is done at the pixel level, so using this option significantly increases the creation time of the mosaic. - This filter is only available for Sentinel exclusive source when both :guilabel:`BRDF` and :guilabel:`SR` correction are disabled. +- :guilabel:`None`: Doesn't use cloud buffering. +- :guilabel:`Moderate`: Masks an additional **120 m** around each larger cloud. +- :guilabel:`Aggressive`: Masks an additional **600 m** around each larger cloud. -Cloud masking -""""""""""""" +Snow/ice masking +"""""""""""""""" -Controls how clouds will be masked based on the cloud detection algorithm selected. +(Advanced view.) Defines how snowy or icy pixels are masked. -- :guilabel:`off`: Uses cloud-free pixels if possible, but doesn't mask areas without cloud-free pixels. -- :guilabel:`moderate`: Relies only on image source QA bands for cloud masking (a moderate threshold is used). -- :guilabel:`aggressive`: Relies on image source QA bands and a cloud scoring algorithm for cloud masking with an aggressive threshold (this will probably mask out some built-up areas and other bright features). +- :guilabel:`On`: Masks snow. This tends to leave some pixels with shadowy snow. +- :guilabel:`Off`: Doesn't mask snow. Note that some clouds might get misclassified as snow; therefore, disabling snow masking might lead to cloud artifacts. -Cloud buffering -""""""""""""""" +Masked out pixels +""""""""""""""""" + +(Advanced view.) Controls whether a pixel can end up completely masked when every available acquisition is cloudy and/or snowy. -When pixels are identified as clouds, SEPAL can remove pixels in a small buffer around it to prevent hazy pixels at the borders of clouds to be included in the mosaic. +- :guilabel:`Prevent`: Prevents pixels from being completely masked out, keeping the best available (possibly cloudy/snowy) value. +- :guilabel:`Allow`: Allows pixels to be completely masked out, leaving holes in the mosaic where no clear observation exists. + +Pixel filters +""""""""""""" + +(Advanced view.) Add filters with the :icon:`fa-solid fa-plus` button to remove pixels from the stack before compositing. Each filter excludes a percentage of the stack (set with a slider, defaulting to 50%); removing low-quality pixels improves the quality of the mosaic. .. note:: - Buffering is done on the pixel level, so using this option will significantly increase the creation time of the mosaic. + Each filter is applied iteratively (e.g. if the normalized difference vegetation index [NDVI] is already filtering all pixels but one, there will be nothing left in the stack to be filtered by date). -- :guilabel:`none`: Doesn't use cloud buffering. -- :guilabel:`moderate`: Masks an additional **120 m** around each larger cloud. -- :guilabel:`aggressive`: Masks an additional **600 m** around each larger cloud. + Note as well that adding filters significantly increases the creation time of the mosaic. -Snow masking -"""""""""""" +- **Shadow**: Excludes the selected percentage of pixels with the most shadow. +- **Haze**: Excludes the selected percentage of pixels with the most haze. Only available when :guilabel:`SR` correction is disabled. +- **NDVI**: Excludes the selected percentage of pixels with the lowest NDVI. +- **Date**: Excludes the selected percentage of pixels farthest from the target date. + +Sentinel-2 overlap +"""""""""""""""""" -Defines how snowy pixels will be masked. +(Advanced view; shown only when Sentinel-2 is selected.) Sentinel-2 acquisitions overlap both between orbits and between neighbouring tiles, which can result in duplicated observations. -- :guilabel:`on`: Masks snow. This tends to leave some pixels with shadowy snow. -- :guilabel:`off`: Doesn't mask snow. Note that some clouds might get misclassified as snow; therefore, disabling snow masking might lead to cloud artifacts. +- **Orbit Overlap**: :guilabel:`Keep` the overlap between Sentinel-2 orbits (more data, better models) or :guilabel:`Remove` it. +- **Tile Overlap**: :guilabel:`Keep` the overlap between Sentinel-2 tiles, :guilabel:`Quick remove` most of it, or :guilabel:`Remove` all of it. Removing overlap adds an extra preprocessing step. Composing method """""""""""""""" -After filtering the stack of pixels, SEPAL will compute the median value on the different bands of the image. The composing method will define how the final pixel value is extracted. +After filtering the stack of pixels, the composing method defines how the final pixel value is extracted. -- :guilabel:`Medoid`: Uses the closest pixel from the median value. As a real pixel from the stack, the final value will embed metadata (e.g. the date of observation). -- :guilabel:`Median`: Uses the computed value of the median. If no pixel is matching this value, the pixel will not embed any metadata. It tends to produce smoother mosaics. +- :guilabel:`Medoid`: Uses the pixel closest to the median value. As a real pixel from the stack, the final value embeds metadata (e.g. the date of observation). +- :guilabel:`Median`: Uses the computed median value. If no pixel matches this value, the pixel will not embed any metadata. It tends to produce smoother mosaics. Analysis -------- @@ -284,7 +296,7 @@ After selecting the parameters, you can start interacting with the scenes and be In the upper-right corner, three tabs are available, which allow you to customize the mosaic scene selection and export the final result: -- :btn:``: auto-select scenes +- :btn:``: auto-select scenes - :btn:``: clear selected scenes - :btn:``: retrieve mosaic @@ -294,7 +306,7 @@ In the upper-right corner, three tabs are available, which allow you to customiz .. note:: - If you have not selected the option :guilabel:`Select scenes` in the :guilabel:`SCN` tab, the :icon:`fa-solid fa-wand-magic` button will be disabled and the scene areas will be hidden as no scene selection needs to be performed (see those with a number in a circle on the previous screenshot). + If you have not selected the option :guilabel:`Select scenes` in the :guilabel:`SCN` tab, the :icon:`fa-solid fa-wand-sparkles` button will be disabled and the scene areas will be hidden as no scene selection needs to be performed (see those with a number in a circle on the previous screenshot). If you can't see the image scene area, you probably have selected a small AOI. Zoom out on the map and you will see the number of available images in the circles. @@ -310,9 +322,9 @@ To create a mosaic, select the scenes that will be used to compute each pixel va Auto-select scene """"""""""""""""" -Selecting the :icon:`fa-solid fa-wand-magic` tab will open the **Auto-selection** pane. +Selecting the :icon:`fa-solid fa-wand-sparkles` tab will open the **Auto-selection** pane. -Move the sliders to select the minimum and the maximum number of scenes SEPAL should select in a tile. Then, select the :guilabel:`Validate` button to apply the auto-select method. +Move the sliders to set the :code:`Minimum number of scenes` and the :code:`Maximum number of scenes` SEPAL should select in a tile. Then, select the :guilabel:`Select scenes` button to apply the auto-select method. SEPAL will use the priority defined in the :guilabel:`SCN` tab to order the scene and collect the optimal number for your request. @@ -349,7 +361,7 @@ To open the **Scene selection** menu, hover over a tile circled-number and selec Each thumbnail represents a scene of the tile stack. You have the option to include them in the mosaic. The scenes located on the left side are the **Available scenes**; the **Selected scenes** are on the right side. In both cases, the following information can be found on the thumbnail: -- A small preview of the scene in the *red, blue, green* band combination. +- A small preview of the scene in the *red, green, blue* (true-colour) band combination. - The exact date in YYYY-MM-DD of the scene. - The satellite name :icon:`fa-solid fa-satellite-dish`. - The cloud coverage of the scene in percent and its position in the stack values :icon:`fa-solid fa-cloud`. @@ -365,7 +377,7 @@ Each thumbnail represents a scene of the tile stack. You have the option to incl :title: The thumbnail of a scene when it's in the selected scene area :group: optical-mosaic-recipe -You can decide to move the scene to the **Selected scene** area by selecting :icon:`fa-solid fa-plus`:guilabel:`Add` or moving it back to **Available scene** pane by selecting :icon:`fa-solid fa-minus` :guilabel:`Remove`. +You can decide to move the scene to the **Selected scene** area by selecting :icon:`fa-solid fa-plus` :guilabel:`Add` or moving it back to the **Available scene** pane by selecting :icon:`fa-solid fa-minus` :guilabel:`Remove`. .. thumbnail:: ../_images/cookbook/optical_mosaic/thumbnail_available_hover.png :width: 24% @@ -388,7 +400,7 @@ Retrieve .. important:: - You cannot export a recipe as an asset or a :code:`.tiff` file without a small computation quota. If you are a new user, see :doc:`../setup/resource`. + You cannot export a recipe as an asset or a :code:`.tif` file without a small computation quota. If you are a new user, see :doc:`../setup/resource`. Selecting the :icon:`fa-solid fa-cloud-arrow-down` tab will open the **Retrieve** pane where you can select the exportation parameters. @@ -408,24 +420,32 @@ You need to select the band(s) to export with the mosaic. There is no maximum nu Dates ##### -- :guilabel:`dayofyear`: the Julian calendar date (day of the year) -- :guilabel:`dayfromtarget`: the distance to the target date within the season in days +- :guilabel:`dayOfYear`: the Julian calendar date (day of the year) +- :guilabel:`daysFromTarget`: the distance to the target date within the season in days + +.. note:: + + These metadata bands are only available when the :guilabel:`Medoid` composing method is used (the :guilabel:`Median` method produces artificial pixels that carry no metadata). Scale """"" -You can set a custom scale for exportation by changing the value of the slider in metres (m) (note that requesting a smaller resolution than images' native resolution will not improve the quality of the output – just its size – keep in mind that the native resolution of Sentinel data is 10 m, while Landsat is 30 m.) +You can set a custom scale for exportation by selecting a value in metres (m) (note that requesting a smaller resolution than the images' native resolution will not improve the quality of the output – just its size – keep in mind that the native resolution of Sentinel data is 10 m, while Landsat is 30 m). Destination """"""""""" -You can export the image to the :guilabel:`SEPAL workspace` or to the ;guilabel:`Google Earth Engine Asset` folder. The same image will be exported to both; however, for the former, you will find it in :code:`.tif` format in the :code:`Downloads` folder; for the latter, the image will be exported to your GEE account asset list. +Choose a single destination for the export: + +- :guilabel:`SEPAL workspace`: the image is written to your SEPAL files in :code:`.tif` format (by default in the :code:`Downloads` folder). +- :guilabel:`Google Earth Engine asset`: the image is exported to your GEE account as an asset. You can export it either as a single :guilabel:`Image` or as an :guilabel:`Image collection` (tiled, which is better suited to large exports), and set its sharing to :guilabel:`Private` or :guilabel:`Public`. +- :guilabel:`Google Drive`: the image is exported to the Google Drive of the connected Google account. .. Note:: - If :guilabel:`Google Earth Engine Asset` is not displayed, it means that your GEE account is not connected to SEPAL. Please refer to `Connect SEPAL to GEE <../setup/gee.html>`__. + The :guilabel:`Google Earth Engine asset` and :guilabel:`Google Drive` destinations are only displayed when a Google account is connected to SEPAL. If they are missing, please refer to `Connect SEPAL to GEE <../setup/gee.html>`__. -Select :guilabel:`Apply` to start the download process. +Select :guilabel:`Retrieve` to start the export process. Exportation status """""""""""""""""" @@ -478,4 +498,4 @@ The data are stored in a folder using the name of the optical mosaic as it was c .. important:: - Now that you have downloaded the optical mosaic to your SEPAL and/or GEE account, it can be downloaded to your computer using `FileZilla <../setup.filezilla.html>`__ or used in other SEPAL workflows. + Now that you have exported the optical mosaic to your SEPAL workspace, it can be downloaded to your computer using `file exchange options <../setup/filezilla.html>`__ or used in other SEPAL workflows.