docs(docs): Add new Docs

ibaris · Nov 30, 2018 · 93216bd · 93216bd
1 parent f4b4304
commit 93216bd
Show file tree

Hide file tree

Showing 23 changed files with 144 additions and 2 deletions.
diff --git a/docs/_static/i_finder_0.png b/docs/_static/i_finder_0.png
diff --git a/docs/_static/i_finder_1.png b/docs/_static/i_finder_1.png
diff --git a/docs/_static/i_finder_2.png b/docs/_static/i_finder_2.png
diff --git a/docs/_static/i_finder_3.png b/docs/_static/i_finder_3.png
diff --git a/docs/_static/i_finder_4.png b/docs/_static/i_finder_4.png
diff --git a/docs/_static/i_finder_5.png b/docs/_static/i_finder_5.png
diff --git a/docs/_static/pr_geocode_0.png b/docs/_static/pr_geocode_0.png
diff --git a/docs/_static/pr_geocode_00.png b/docs/_static/pr_geocode_00.png
diff --git a/docs/_static/pr_geocode_1.png b/docs/_static/pr_geocode_1.png
diff --git a/docs/_static/pr_geocode_2.png b/docs/_static/pr_geocode_2.png
diff --git a/docs/_static/t_c_register_5.png b/docs/_static/t_c_register_5.png
diff --git a/docs/_static/t_c_register_6.png b/docs/_static/t_c_register_6.png
diff --git a/docs/_static/t_rast_mapcalc_1.png b/docs/_static/t_rast_mapcalc_1.png
diff --git a/docs/_static/t_rast_mapcalc_2.png b/docs/_static/t_rast_mapcalc_2.png
diff --git a/docs/_static/t_rast_mapcalc_3.png b/docs/_static/t_rast_mapcalc_3.png
diff --git a/docs/_static/t_rast_mapcalc_4.png b/docs/_static/t_rast_mapcalc_4.png
diff --git a/docs/_static/t_rast_mapcalc_5.png b/docs/_static/t_rast_mapcalc_5.png
diff --git a/docs/example.rst b/docs/example.rst
@@ -28,6 +28,10 @@ Contents
    data
    g_c_mapset_example
    ds1_download_example
+   geocode_example
+   sentinel_finder_example
+   t_c_register_sentinel_example
+   t_raster_mapcalc_example
    i_dr_input_example
    t_c_register_example
 
diff --git a/docs/geocode_example.rst b/docs/geocode_example.rst
@@ -0,0 +1,30 @@
+Geocoding Example
+-----------------
+After we downloaded the Sentinel 1 Files with ``ds1.download`` we want to geocode all the files automatically. Thus,
+we start with command ``pr.geocode`` the geocode GUI. Now we can specify our directory where the sentinel data are:
+
+.. image:: _static/pr_geocode_00.png
+   :scale: 50 %
+   :alt: input
+   :align: center
+
+After these we specify our output directory:
+
+.. image:: _static/pr_geocode_0.png
+   :scale: 50 %
+   :alt: output
+   :align: center
+
+if we click on ``Run`` now the geocode processing will run with ESA´s SNAP software:
+
+.. image:: _static/pr_geocode_2.png
+   :scale: 50 %
+   :alt: run
+   :align: center
+
+If there is any scene that is already processed the ``pr.geocode`` module will skip these files:
+
+.. image:: _static/pr_geocode_1.png
+   :scale: 50 %
+   :alt: exist
+   :align: center
diff --git a/docs/sentinel_finder_example.rst b/docs/sentinel_finder_example.rst
@@ -0,0 +1,36 @@
+Find Processed Scenes
+---------------------
+After we downloaded the Sentinel 1 Files with ``pr.geocode`` all the processed files are find in the output directory:
+
+.. image:: _static/i_finder_1.png
+   :scale: 50 %
+   :alt: dir
+   :align: center
+
+In this directory their are S1A scenes as well as S1B scenes. Consider a case where we want to find and import all the
+sentinel 1B scenes. Thus, we can run the command::
+
+    $ i.fr.import -p input_dir=/media/ibaris/Shared/Documents/DATA/FuentedePiedra_VV/VV sensor=S1B
+
+to print all the detected scenes:
+
+.. image:: _static/i_finder_2.png
+   :scale: 50 %
+   :alt: p
+   :align: center
+
+We can import all the detected scenes if we delete the flag ``-p``::
+
+    $ i.fr.import input_dir=/media/ibaris/Shared/Documents/DATA/FuentedePiedra_VV/VV sensor=S1B
+
+.. image:: _static/i_finder_3.png
+   :scale: 50 %
+   :alt: import
+   :align: center
+
+To be sure we can run the command ``g.list type=raster``:
+
+.. image:: _static/i_finder_4.png
+   :scale: 50 %
+   :alt: import
+   :align: center
diff --git a/docs/t_c_register_example.rst b/docs/t_c_register_example.rst
@@ -1,5 +1,5 @@
-Spatio-temporal data handling
------------------------------
+Spatio-temporal data handling in General
+----------------------------------------
 To better handle the long time series of maps, we create temporal datasets which serve as containers for the time
 series and we will further manipulate them instead of individual maps. Usually, we create empty datasets of type
 strds (space-time raster dataset) and after that we register the raster files into the strds.

diff --git a/docs/t_c_register_sentinel_example.rst b/docs/t_c_register_sentinel_example.rst
@@ -0,0 +1,26 @@
+Spatio-temporal data handling with Sentinel Data
+------------------------------------------------
+After the process of geocoding and import of the scenes we create a huge amount of data as shown in section
+*Find Processed Scenes*. To better handle the long time series of maps, we create temporal datasets which serve as
+containers for the time series and we will further manipulate them instead of individual maps. Usually, we create empty
+datasets of type strds (space-time raster dataset) and after that we register the raster files into the strds.
+With ``t.c.register`` we can combine these two steps and with the `flag -m`  we will visualize the temporal extents of
+the dataset (Note, that we use absolute and weekly time.)::
+
+    $ t.c.register -m -t output=Intensity temporaltype=absolute title="Average Intensity"
+      description="Weekly Intensity average in [dB]" start=2016-12-04
+      increment="1 weeks"
+
+
+Look at the temporal extents:
+
+.. image:: _static/t_c_register_5.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center
+
+.. image:: _static/t_c_register_6.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center
+
diff --git a/docs/t_raster_mapcalc_example.rst b/docs/t_raster_mapcalc_example.rst
@@ -0,0 +1,46 @@
+Spatio-temporal Calculation with Sentinel Data
+----------------------------------------------
+In the previous step we create a spatio-temporal dataset in unit dB. Now, we will convert the dB units to linear unit
+with ``t.raster.mapcalc``. To do this we launch the mapcalc GUI with::
+
+    $ t.rast.mapcalc
+
+We choose the space time raster dataset that we created in the previous step `Intensity`. To convert the unit [dB] in
+[linear] we use the formula::
+
+    pow(10, (dB/10))
+
+
+.. image:: _static/t_rast_mapcalc_1.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center
+
+Now, we will click ``Run``:
+
+.. image:: _static/t_rast_mapcalc_2.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center
+
+If we now list all spatio-temporal dataset we see two entries: The one for ``Intensity`` and the another one
+``Intensity_lin`` that we created in with ``t.raster.mapcalc``:
+
+.. image:: _static/t_rast_mapcalc_3.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center
+
+We can also import the dataset into the display. Here is the dataset in unit [dB]:
+
+.. image:: _static/t_rast_mapcalc_4.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center
+
+And here is the dataset in unit [linear]:
+
+.. image:: _static/t_rast_mapcalc_5.png
+   :scale: 50 %
+   :alt: Create a Mapset
+   :align: center