Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc review #431

Merged
merged 34 commits into from
Nov 16, 2023
Merged
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
534ab18
Update index.rst
alexryangregor Nov 9, 2023
6bec889
Update register.rst
alexryangregor Nov 9, 2023
73972de
Update presentation.rst
alexryangregor Nov 10, 2023
d8c046f
Update gee.rst
alexryangregor Nov 10, 2023
3682a68
Update nicfi.rst
alexryangregor Nov 13, 2023
c3e610b
Update resource.rst
alexryangregor Nov 13, 2023
ac602eb
Update password.rst
alexryangregor Nov 13, 2023
602a422
Update index.rst
alexryangregor Nov 14, 2023
20d9090
Update optical_mosaic.rst
alexryangregor Nov 14, 2023
a5168de
Update radar_mosaic.rst
alexryangregor Nov 14, 2023
aa1d740
Update planet_mosaic.rst
alexryangregor Nov 14, 2023
fdd36ab
Update classification.rst
alexryangregor Nov 14, 2023
7358128
Update time_series.rst
alexryangregor Nov 14, 2023
421d337
Update class_change.rst
alexryangregor Nov 14, 2023
e0b7c52
Update ccdc.rst
alexryangregor Nov 14, 2023
dbe4d63
Update ccdc_slice.rst
alexryangregor Nov 14, 2023
be076ee
Merge remote-tracking branch 'alex-for/patch-2' into doc_review
dfguerrerom Nov 16, 2023
12ecdd4
Merge remote-tracking branch 'alex-for/patch-3' into doc_review
dfguerrerom Nov 16, 2023
74b7695
Merge remote-tracking branch 'alex-for/patch-4' into doc_review
dfguerrerom Nov 16, 2023
72d7cea
Merge remote-tracking branch 'alex-for/patch-5' into doc_review
dfguerrerom Nov 16, 2023
b5f56cd
Merge remote-tracking branch 'alex-for/patch-6' into doc_review
dfguerrerom Nov 16, 2023
135df3a
Merge remote-tracking branch 'alex-for/patch-8' into doc_review
dfguerrerom Nov 16, 2023
c5604be
Merge remote-tracking branch 'alex-for/patch-9' into doc_review
dfguerrerom Nov 16, 2023
f66bc58
Merge remote-tracking branch 'alex-for/patch-10' into doc_review
dfguerrerom Nov 16, 2023
1d074af
Merge remote-tracking branch 'alex-for/patch-11' into doc_review
dfguerrerom Nov 16, 2023
ebf851d
Merge remote-tracking branch 'alex-for/patch-12' into doc_review
dfguerrerom Nov 16, 2023
40d8647
Merge remote-tracking branch 'alex-for/patch-13' into doc_review
dfguerrerom Nov 16, 2023
e3bf925
Merge remote-tracking branch 'alex-for/patch-14' into doc_review
dfguerrerom Nov 16, 2023
64c45b5
Merge remote-tracking branch 'alex-for/patch-15' into doc_review
dfguerrerom Nov 16, 2023
90ea50e
Merge remote-tracking branch 'alex-for/patch-16' into doc_review
dfguerrerom Nov 16, 2023
e75440c
Merge remote-tracking branch 'alex-for/patch-17' into doc_review
dfguerrerom Nov 16, 2023
cac7c5a
Merge remote-tracking branch 'alex-for/patch-18' into doc_review
dfguerrerom Nov 16, 2023
adf3d3c
style: remove trailing spaces
dfguerrerom Nov 16, 2023
0c7448e
style: lint
dfguerrerom Nov 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update planet_mosaic.rst
Proofreading complete.
alexryangregor authored Nov 14, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit aa1d740df930feff7e2eeca56d99d78d4b88bc44
31 changes: 16 additions & 15 deletions docs/source/cookbook/planet_mosaic.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Planet mosaic
=============
*Create a composite dataset from Planet images taken at different times*

Overview
--------

A mosaic is a process of combining spatially overlapping images into an individual image. In the SEPAL platform, you can create a composite dataset from Planet images taken at different times by using different techniques. For example, you can choose to keep only the pixel value from the first or last image, or combine the values of the overlapping pixels using a weighting algorithm, the average, or the maximum or minimum value. In addition, certain preprocessing tasks can be applied to mask clouds, shadows, snow, etc. These operations are complex and repetitive. SEPAL offers an interactive and intuitive way to create Planet mosaics within any area of interest (AOI).
A mosaic is a process of combining spatially overlapping images into an individual image.

In the SEPAL platform, you can create a composite dataset from Planet images taken at different times by using different techniques. For example, you can choose to keep only the pixel value from the first or last image, or combine the values of the overlapping pixels using a weighting algorithm, the average, or the maximum or minimum value. In addition, certain preprocessing tasks can be applied to mask clouds, shadows, snow, etc. These operations are complex and repetitive. SEPAL offers an interactive and intuitive way to create Planet mosaics within any area of interest (AOI).

.. thumbnail:: ../_images/cookbook/planet_mosaic/time-series.png
:group: planet-mosaic-recipe
@@ -19,13 +22,13 @@ A mosaic is a process of combining spatially overlapping images into an individu
Start
-----

Once the :code:`Planet mosaic` recipe is selected, SEPAL will show the recipe process in a new tab (1) and the AOI selection window will appear in the lower right (2).
Once the :code:`Planet mosaic` recipe is selected, SEPAL will show the recipe process in a new tab (see **1** in the image below) and the AOI selection window will appear in the lower right (**2**).

.. thumbnail:: ../_images/cookbook/planet_mosaic/landing.png
:group: planet-mosaic-recipe
:title: The landing page of the Planet mosaic recipe

The first step is to change the name of the recipe, which will be used to name your files and recipes in the SEPAL folders.
The first step is to change the name of the recipe, which will be used to name your files and recipes in SEPAL folders.

Double-click the tab and enter a new name (it will default to :code:`Planet_mosaic_<start_date>_<end_date>`).

@@ -105,7 +108,7 @@ Select :btn:`<fa-solid fa-check> Done` to finish the process.
NICFI basemaps
""""""""""""""

The NICFI basemap uses Level 1 NICFI data provided by SEPAL.
The NICFI basemap uses Level 1 NICFI data provided by SEPAL (NICFI refers to Norway’s International Climate and Forests Initiative).

.. note::

@@ -180,7 +183,7 @@ Once all of the parameters have been set, the mosaic will be rendered on the fly
:width: 49%

.. thumbnail:: ../_images/cookbook/planet_mosaic/mosaic_nrg.png
:title: Displayed on-the-fly rendered mosaic using nir, red, and green bands
:title: Displayed on-the-fly rendered mosaic using near-infrared (NIR), red, and green bands
:group: planet-mosaic-recipe
:width: 49%

@@ -190,7 +193,7 @@ Once all of the parameters have been set, the mosaic will be rendered on the fly
:width: 49%

.. thumbnail:: ../_images/cookbook/planet_mosaic/mosaic_savi.png
:title: Displayed on-the-fly rendered mosaic using SAVI in false colors
:title: Displayed on-the-fly rendered mosaic using soil-adjusted vegetation index (SAVI) in false colors
:group: planet-mosaic-recipe
:width: 49%

@@ -201,10 +204,10 @@ Retrieve

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`).

Select the :btn:`<fa-solid fa-cloud-arrow-down>` tab, which will display the **Retrieve** panel, where you can select which bands or indexes to download, as well as specify the output scale and destination.
Select the :btn:`<fa-solid fa-cloud-arrow-down>` tab, which will display the **Retrieve** pane, where you can select which bands or indexes to download, as well as specify the output scale and destination.

.. thumbnail:: ../_images/cookbook/planet_mosaic/retrieve.png
:title: The last panel of the Planet mosaic: exportation
:title: The last pane of the Planet mosaic: exportation
:group: planet-mosaic-recipe

Bands
@@ -214,15 +217,15 @@ Select the band(s) to export in the mosaic. There is no maximum number; however,

.. tip::

There is no fixed rule to band selection. Every index will be more useful to the type of analysis you are performing. The knowledge of the study area, evolution expected, and careful selection of an adapted band combination will improve the quality of downstream analysis.
There is no fixed rule to band selection. Every index will be more useful to the type of analysis you are performing. The knowledge of the study area, evolution expected and careful selection of an adapted band combination will improve the quality of downstream analysis.

Raw bands
"""""""""

- :guilabel:`blue`: blue
- :guilabel:`green`: green
- :guilabel:`red`: red
- :guilabel:`nir`: near infrared
- :guilabel:`nir`: near-infrared


Indexes
@@ -238,7 +241,7 @@ Indexes
Scale
^^^^^

You can set a custom scale for exportation by changing the value in the :code:`Scale` field. Requesting a smaller resolution than the image's native resolution will not improve the quality of the output, only its size (note: PlanetLab data's native resolution is 3.0 m – 4.1 m [altitude-dependent ground sample distance; `see more info <https://assets.planet.com/docs/Planet_Combined_Imagery_Product_Specs_letter_screen.pdf>`__]).
You can set a custom scale for exportation by changing the value in the :code:`Scale` field. Requesting a smaller resolution than the image's native resolution will not improve the quality of the output, only its size (note that PlanetLab data's native resolution is 3.04.1 m [altitude-dependent ground sample distance; `see more info <https://assets.planet.com/docs/Planet_Combined_Imagery_Product_Specs_letter_screen.pdf>`__]).

Destination
^^^^^^^^^^^
@@ -256,9 +259,7 @@ Select :btn:`<fa-solid fa-check> Apply` to start the download process.
Access
^^^^^^

Once the download process is complete, access the data in your SEPAL folders.

The data will be stored in the :code:`Downloads` folder using the following format:
Once the download process is complete, access the data in your SEPAL folders, stored in :code:`Downloads` in the following format:

.. code-block::
@@ -275,7 +276,7 @@ The data will be stored in the :code:`Downloads` folder using the following form

Understanding how images are stored in a Planet mosaic is only required if you want to use them manually. SEPAL applications are bound to this tiling system and can digest this information for you.

The data are stored in a folder using the previously chosen name of the Planet mosaic (as described in the "Start" section of this page of the documentation). Since the data is spatially too big to be exported at once, the data is divided into smaller pieces and reassembled in a :code:`<PM name>_<gee tile id>.vrt` file.
The data are stored in a folder using the previously chosen name of the Planet mosaic (as described in the **Start** section of this article). Since the data is spatially too big to be exported at once, it is divided into smaller pieces and reassembled in a :code:`<PM name>_<gee tile id>.vrt` file.

.. tip::