Deploy dev from e519b0c

compgeolab · Aug 28, 2024 · 4290e55 · 4290e55
1 parent 92d352e
commit 4290e55
Show file tree

Hide file tree

Showing 166 changed files with 8,546 additions and 4,390 deletions.
diff --git a/dev/.buildinfo b/dev/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: bdeb98ae41c1bdc55d9dc852bbf31a2e
+config: 1c1f686fccaef180858a7b310fb49105
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/_images/composites_2_1.png b/dev/_images/composites_2_1.png
diff --git a/dev/_images/composites_3_0.png b/dev/_images/composites_3_0.png
diff --git a/dev/_images/composites_4_0.png b/dev/_images/composites_4_0.png
diff --git a/dev/_images/composites_5_0.png b/dev/_images/composites_5_0.png
diff --git a/dev/_images/composites_6_2.png b/dev/_images/composites_6_2.png
diff --git a/dev/_images/composites_6_0.png → dev/_images/composites_7_0.png b/dev/_images/composites_6_0.png → dev/_images/composites_7_0.png
diff --git a/dev/_images/equalize-histogram_2_0.png b/dev/_images/equalize-histogram_2_0.png
diff --git a/dev/_images/equalize-histogram_3_0.png b/dev/_images/equalize-histogram_3_0.png
diff --git a/dev/_images/equalize-histogram_4_0.png b/dev/_images/equalize-histogram_4_0.png
diff --git a/dev/_images/index_0_0.png b/dev/_images/index_0_0.png
diff --git a/dev/_images/indices_10_0.png b/dev/_images/indices_10_0.png
diff --git a/dev/_images/indices_14_0.png b/dev/_images/indices_14_0.png
diff --git a/dev/_images/indices_15_0.png b/dev/_images/indices_15_0.png
diff --git a/dev/_images/indices_16_0.png b/dev/_images/indices_16_0.png
diff --git a/dev/_images/indices_17_0.png b/dev/_images/indices_17_0.png
diff --git a/dev/_images/indices_18_0.png b/dev/_images/indices_18_0.png
diff --git a/dev/_images/indices_1_1.png → dev/_images/indices_2_1.png b/dev/_images/indices_1_1.png → dev/_images/indices_2_1.png
diff --git a/dev/_images/indices_5_0.png b/dev/_images/indices_5_0.png
diff --git a/dev/_images/indices_7_0.png b/dev/_images/indices_7_0.png
diff --git a/dev/_images/indices_8_0.png b/dev/_images/indices_8_0.png
diff --git a/dev/_images/missing-values_1_1.png b/dev/_images/missing-values_1_1.png
diff --git a/dev/_images/missing-values_2_0.png b/dev/_images/missing-values_2_0.png
diff --git a/dev/_images/overview_4_0.png b/dev/_images/overview_4_0.png
diff --git a/dev/_images/pansharpen_3_0.png b/dev/_images/pansharpen_3_0.png
diff --git a/dev/_images/pansharpen_5_0.png b/dev/_images/pansharpen_5_0.png
diff --git a/dev/_images/plot-overlay_2_0.png b/dev/_images/plot-overlay_2_0.png
diff --git a/dev/_images/plot-overlay_3_0.png b/dev/_images/plot-overlay_3_0.png
diff --git a/dev/_images/plot-overlay_4_0.png b/dev/_images/plot-overlay_4_0.png
diff --git a/dev/_modules/index.html b/dev/_modules/index.html
diff --git a/dev/_modules/xlandsat/_composite.html b/dev/_modules/xlandsat/_composite.html
diff --git a/dev/_modules/xlandsat/_enhancement.html b/dev/_modules/xlandsat/_enhancement.html
diff --git a/dev/_modules/xlandsat/_indices.html b/dev/_modules/xlandsat/_indices.html
diff --git a/dev/_modules/xlandsat/_interpolation.html b/dev/_modules/xlandsat/_interpolation.html
diff --git a/dev/_modules/xlandsat/_io.html b/dev/_modules/xlandsat/_io.html
diff --git a/dev/_modules/xlandsat/_pansharpen.html b/dev/_modules/xlandsat/_pansharpen.html
diff --git a/dev/_modules/xlandsat/datasets.html b/dev/_modules/xlandsat/datasets.html
diff --git a/dev/_sources/api/generated/xlandsat.datasets.fetch_corumba_after.rst b/dev/_sources/api/generated/xlandsat.datasets.fetch_corumba_after.rst
@@ -0,0 +1,10 @@
+xlandsat.datasets.fetch\_corumba\_after
+=======================================
+
+.. currentmodule:: xlandsat.datasets
+
+.. autofunction:: fetch_corumba_after
+
+.. raw:: html
+
+     <div style='clear:both'></div>
diff --git a/dev/_sources/api/generated/xlandsat.datasets.fetch_corumba_before.rst b/dev/_sources/api/generated/xlandsat.datasets.fetch_corumba_before.rst
@@ -0,0 +1,10 @@
+xlandsat.datasets.fetch\_corumba\_before
+========================================
+
+.. currentmodule:: xlandsat.datasets
+
+.. autofunction:: fetch_corumba_before
+
+.. raw:: html
+
+     <div style='clear:both'></div>
diff --git a/dev/_sources/api/generated/xlandsat.nbr.rst b/dev/_sources/api/generated/xlandsat.nbr.rst
@@ -0,0 +1,10 @@
+xlandsat.nbr
+============
+
+.. currentmodule:: xlandsat
+
+.. autofunction:: nbr
+
+.. raw:: html
+
+     <div style='clear:both'></div>
diff --git a/dev/_sources/api/generated/xlandsat.ndvi.rst b/dev/_sources/api/generated/xlandsat.ndvi.rst
@@ -0,0 +1,10 @@
+xlandsat.ndvi
+=============
+
+.. currentmodule:: xlandsat
+
+.. autofunction:: ndvi
+
+.. raw:: html
+
+     <div style='clear:both'></div>
diff --git a/dev/_sources/api/index.rst b/dev/_sources/api/index.rst
@@ -11,22 +11,38 @@ Input and output
 ----------------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
 
     load_scene
     save_scene
     load_panchromatic
 
-Processing
-----------
+Visualization
+-------------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
 
     composite
-    pansharpen
     equalize_histogram
     adjust_l1_colors
+
+Indices
+-------
+
+.. autosummary::
+    :toctree: generated/
+
+    nbr
+    ndvi
+
+Processing
+----------
+
+.. autosummary::
+    :toctree: generated/
+
+    pansharpen
     interpolate_missing
 
 Sample datasets
@@ -46,3 +62,5 @@ Sample datasets
     datasets.fetch_manaus
     datasets.fetch_momotombo
     datasets.fetch_roraima
+    datasets.fetch_corumba_after
+    datasets.fetch_corumba_before
diff --git a/dev/_sources/compatibility.rst b/dev/_sources/compatibility.rst
@@ -56,4 +56,6 @@ releases to ensure compatibility:
     * - **Python version**
       - **Last compatible release**
     * - 3.7
-      - Not yet released
+      - v0.5.0
+    * - 3.8
+      - v0.5.0
diff --git a/dev/_sources/composites.rst b/dev/_sources/composites.rst
@@ -155,6 +155,39 @@ this band combination to :func:`xlandsat.composite` to see what happens:
 In this composite, the contrast between the forest and water bodies on the
 right are much clearer!
 
+Composites highlighting fires
+-----------------------------
+
+When a fire is currently burning and producing smoke, it can be difficult to
+visualize the fire front in a regular RGB composite. For this, the SWIR and NIR
+bands can be very useful. A composite of SWIR, NIR, and blue can be useful to
+highlight the burned areas, ongoing fire, and vegetation.
+Let's see what this looks like in our Corumbá, Brazil, sample data:
+
+.. jupyter-execute::
+
+    corumba = xls.load_scene(xls.datasets.fetch_corumba_after())
+    corumba_rgb = xls.adjust_l1_colors(
+        xls.composite(corumba, rescale_to=(0, 0.2)),
+        percentile=0,
+    )
+    corumba_fire = xls.composite(
+        corumba, rescale_to=(0, 0.4), bands=["swir1", "nir", "blue"],
+    )
+
+    fig, axes = plt.subplots(1, 2, figsize=(10, 8), layout="constrained")
+    for ax, composite in zip(axes, [corumba_rgb, corumba_fire]):
+        composite.plot.imshow(ax=ax)
+        ax.set_title(rgb.attrs["long_name"])
+        ax.set_aspect("equal")
+    plt.show()
+
+The burn scar can be seen in the RGB but there is smoke in the South and it's
+not clear whether there are any active fires still burning.
+The SWIR/NIR/green composite highlights the active fires in bright red and can
+even show then through the smoke (which doesn't reflect in the SWIR bands).
+This composite also highlights the difference between burned areas and
+preserved vegetation.
 
 Other composites
 ----------------

diff --git a/dev/_sources/index.rst b/dev/_sources/index.rst
@@ -163,10 +163,10 @@ Here's a quick example:
 
     io.rst
     composites.rst
+    equalize-histogram.rst
     indices.rst
-    pansharpen.rst
     missing-values.rst
-    equalize-histogram.rst
+    pansharpen.rst
     plot-overlay.rst
 
 .. toctree::