Merge pull request #384 from dphogan/docs_preprocessing

Solaris Multimodal Preprocessing Library tutorial
CosmiQ · Jul 16, 2020 · 4df1cbc · 4df1cbc
2 parents 2d7260a + 68fc3dd
commit 4df1cbc
Show file tree

Hide file tree

Showing 21 changed files with 1,102 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ When a new version of `solaris` is released, all of the changes in the Unrelease
 
 ### Added
 - 20200701, dphogan: Added multimodal preprocessing subpackage (#360)
+- 20200716, dphogan: Added three-part tutorial for preprocessing subpackage
 ### Removed
 ### Changed
 ### Fixed

diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -71,6 +71,9 @@ the tutorials below.
 * `Converting pixel masks to vector labels <notebooks/api_mask_to_vector.ipynb>`_
 * `Scoring your model's performance with the solaris Python API <notebooks/api_evaluation_tutorial.ipynb>`_
 * `Creating COCO-formatted datasets <notebooks/api_coco_tutorial.ipynb>`_
+* `Preprocessing Part 1: Pipelines <notebooks/preprocessing_pipelines.ipynb>`_
+* `Preprocessing Part 2: Branching <notebooks/preprocessing_branching.ipynb>`_
+* `Preprocessing Part 3: SAR <notebooks/preprocessing_sar.ipynb>`_
 
 Reference
 =========

diff --git a/docs/tutorials/notebooks/preprocessing_branching.ipynb b/docs/tutorials/notebooks/preprocessing_branching.ipynb
diff --git a/docs/tutorials/notebooks/preprocessing_pipelines.ipynb b/docs/tutorials/notebooks/preprocessing_pipelines.ipynb
diff --git a/docs/tutorials/notebooks/preprocessing_sar.ipynb b/docs/tutorials/notebooks/preprocessing_sar.ipynb
diff --git a/solaris/data/preproc_tutorial/example1flowchart.png b/solaris/data/preproc_tutorial/example1flowchart.png
diff --git a/solaris/data/preproc_tutorial/example2flowchart.png b/solaris/data/preproc_tutorial/example2flowchart.png
diff --git a/solaris/data/preproc_tutorial/example3flowchart.png b/solaris/data/preproc_tutorial/example3flowchart.png
diff --git a/solaris/data/preproc_tutorial/ms1.tif b/solaris/data/preproc_tutorial/ms1.tif
diff --git a/solaris/data/preproc_tutorial/ms2.tif b/solaris/data/preproc_tutorial/ms2.tif
diff --git a/solaris/data/preproc_tutorial/ms3.tif b/solaris/data/preproc_tutorial/ms3.tif
diff --git a/solaris/data/preproc_tutorial/pan1.tif b/solaris/data/preproc_tutorial/pan1.tif
diff --git a/solaris/data/preproc_tutorial/pan2.tif b/solaris/data/preproc_tutorial/pan2.tif
diff --git a/solaris/data/preproc_tutorial/pan3.tif b/solaris/data/preproc_tutorial/pan3.tif
diff --git a/solaris/data/preproc_tutorial/rgb_unmasked.tif b/solaris/data/preproc_tutorial/rgb_unmasked.tif
diff --git a/solaris/data/preproc_tutorial/sar_hh.tif b/solaris/data/preproc_tutorial/sar_hh.tif
diff --git a/solaris/data/preproc_tutorial/sar_hv.tif b/solaris/data/preproc_tutorial/sar_hv.tif
diff --git a/solaris/data/preproc_tutorial/sar_masked.tif b/solaris/data/preproc_tutorial/sar_masked.tif
diff --git a/solaris/data/preproc_tutorial/sar_vh.tif b/solaris/data/preproc_tutorial/sar_vh.tif
diff --git a/solaris/data/preproc_tutorial/sar_vv.tif b/solaris/data/preproc_tutorial/sar_vv.tif
diff --git a/solaris/preproc/label.py b/solaris/preproc/label.py
@@ -127,19 +127,19 @@ def transform(self, pin):
  return result
 
 
-class DataFrameToMask(PipeSegment):
- """
- Given a GeoPandas GeoDataFrame and an Image-class image,
- convert the DataFrame to the corresponding Boolean mask
- """
- pass
-
-
-class MaskToDataFrame(PipeSegment):
- """
- Given a boolean mask, convert it to a GeoPandas GeoDataFrame of polygons.
- """
- pass
+#class DataFrameToMask(PipeSegment):
+# """
+# Given a GeoPandas GeoDataFrame and an Image-class image,
+# convert the DataFrame to the corresponding Boolean mask
+# """
+# pass
+#
+#
+#class MaskToDataFrame(PipeSegment):
+# """
+# Given a boolean mask, convert it to a GeoPandas GeoDataFrame of polygons.
+# """
+# pass
 
 
 class DataFramePixelCoords(PipeSegment):