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

docs: bands documentation #575

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/cookbook/optical_mosaic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ Selecting the :icon:`fa-solid fa-cloud-arrow-down` tab will open the **Retrieve*
Bands
"""""

You need to select the band(s) to export with the mosaic. There is no maximum number of bands, but exporting useless bands will only increase the size and time of the output. To discover the full list of available bands with SEPAL, see :doc:`../feature/bands`.
You need to select the band(s) to export with the mosaic. There is no maximum number of bands, but exporting useless bands will only increase the size and time of the output. To discover the full list of available bands with SEPAL, see :doc:`../feature/optical_bands`.

.. tip::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cookbook/time_series.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Available bands

The wavelength of each band is dependent on the satellite used.

The time series will use a single observation for each pixel. This observation can be one of the available bands in SEPAL. To discover the full list of available bands, see :doc:`../feature/bands`.
The time series will use a single observation for each pixel. This observation can be one of the available bands in SEPAL. To discover the full list of available bands, see :doc:`../feature/optical_bands` and `../feature/radar_bands`.

Analysis
--------
Expand Down
4 changes: 0 additions & 4 deletions docs/source/feature/bands.rst

This file was deleted.

7 changes: 5 additions & 2 deletions docs/source/feature/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ SEPAL features include:

.. toctree::
:maxdepth: 1
:glob:

*
Organize recipes<project>
AOI selection<aoi_selector>
Optical bands<optical_bands>
Radar bands<radar_bands>
Visualization<visualization>
271 changes: 271 additions & 0 deletions docs/source/feature/optical_bands.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/feature/project.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Recipe projects
===============
Organize Recipes by projects
============================

When interacting with SEPAL processes, a user creates **Recipes**, which can work together and be interconnected inside a single project (e.g. :code:`Mosaics` used in a :code:`Classification`).

Expand Down
33 changes: 33 additions & 0 deletions docs/source/feature/radar_bands.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Sentinel-1 Radar Bands
======================

When exporting a radar mosaic from the SEPAL platform, the following radar band metrics are available for analysis:

.. thumbnail:: ../_images/feature/bands/radar_export.png
:title: SEPAL Optical Bands to export
:align: center
:width: 50%


Basic Radar Metrics (VV and VH Polarizations)
---------------------------------------------

- **Metrics Included**:
- *VV_min, VV_max, VV_mean, VV_std, VV_med*: Statistics of the VV polarization signal, covering minimum, maximum, mean, standard deviation, and median.
- *VH_min, VH_max, VH_mean, VH_std, VH_med*: Similar statistics for the VH polarization.
- *ratio_VV_med_VH_med*: The ratio of the median values of VV to VH polarizations, indicating surface roughness and moisture.
- *VV_cv, VH_cv*: Coefficient of variation for VV and VH, showing the variability relative to the mean.
- *NDCV (Normalized Difference Coefficient of Variation)*: A normalized measure that highlights differences in texture or moisture content between VV and VH returns.
- *orbit*: The orbit direction (ascending or descending), which can affect the radar's observation angle and thus the backscatter properties.

- **Description**: These metrics are essential for analyzing surface features, moisture content, vegetation, and other land cover characteristics using radar backscatter properties.
- **Usage**: Widely used in agricultural monitoring, flood mapping, forest monitoring, and urban expansion studies.

Harmonic Analysis Metrics (Conditional on Data Availability)
------------------------------------------------------------

- **Metrics Included** (Only if harmonic dependents are available):
- *VV_phase, VV_amp, VV_res*: Phase, amplitude, and residuals of the VV signal following harmonic analysis.
- *VH_phase, VH_amp, VH_res*: Similar metrics for the VH signal.
- **Description**: Harmonic analysis metrics help in understanding seasonal variations and temporal patterns in the radar signal, useful for long-term monitoring.
- **Usage**: Ideal for studying seasonal changes in vegetation, detecting changes in water bodies over time, and monitoring environmental changes.
34 changes: 34 additions & 0 deletions docs/source/feature/visualization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Visualization in SEPAL
======================

**Natural color: red, green, blue**
- **Description**: Represents the true color of the terrain as human eyes would see it, using the red, green, and blue bands.
- **Usage**: Used for general mapping and visual inspections where true color representation is necessary.

**False color: nir, red, green**
- **Description**: Uses near-infrared, red, and green bands. Vegetation appears red due to the high reflection of NIR by healthy vegetation, helpful for distinguishing vegetative areas.
- **Usage**: Commonly used in vegetation studies to easily distinguish live green vegetation, which reflects NIR strongly.

**False color: nir, swir1, red**
- **Description**: Combines near-infrared, short-wave infrared, and red bands. This combination is effective in highlighting vegetation and differentiating moisture levels and geological features.
- **Usage**: Useful in geological mapping, vegetation health assessment, and moisture content analysis.

**False color: swir2, nir, red**
- **Description**: Utilizes short-wave infrared, near-infrared, and red bands. It enhances the differentiation between mineral types and can indicate burn severity in post-fire assessments.
- **Usage**: Often used in mineralogical mapping, soil and rock differentiation, and detecting burned areas.

**False color: swir2, swir1, red**
- **Description**: Involves short-wave infrared bands and red band. This setup enhances geological features and is sensitive to water content and urban areas.
- **Usage**: Ideal for enhanced geological mapping, urban sprawl studies, and discriminating between different water bodies.

**False color: swir2, nir, green**
- **Description**: Features short-wave infrared, near-infrared, and green bands. This visualization aids in the analysis of vegetation health and soil/water interactions.
- **Usage**: Useful for detailed vegetation health monitoring and differentiating water stress in plants.

**Tasseled cap: brightness, greenness, wetness**
- **Description**: Applies the Tasseled Cap transformation to highlight physical properties of the land surface such as brightness (reflectivity), greenness (vegetation), and wetness (moisture content).
- **Usage**: Extensively used in environmental monitoring, land cover classification, and assessing vegetation and water content dynamics.

**Tasseled cap: fifth, sixth, fourth**
- **Description**: Another Tasseled Cap visualization focusing on the additional components that might reflect other surface properties not captured by the primary three bands.
- **Usage**: Useful for specialized studies in vegetation dynamics, soil properties, and other environmental monitoring where standard Tasseled Cap indices might need supplementation.
4 changes: 0 additions & 4 deletions docs/source/feature/vizualisation.rst

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ ignore-path = ["docs/source/modules/*"]

[tool.codespell]
skip = 'docs/source/_data/modules/*.json,*.po,docs/source/modules/dwn/*,docs/build/*,docs/source/_bib/workflows/drivers.bib,docs/source/_data/*'
ignore-words-list='alos,cywgin,toi,aoi'
ignore-words-list='alos,cywgin,toi,aoi,bui,BUI'
Loading