Add info on file formats for RasterioSource

azavea · Mar 25, 2019 · 7cac688 · 7cac688
1 parent d0ccb1a
commit 7cac688
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/rastervision/data/raster_source/rasterio_source.py b/rastervision/data/raster_source/rasterio_source.py
@@ -75,6 +75,10 @@ def __init__(self,
                  y_shift_meters=0.0):
         """Constructor.
 
+        This RasterSource can read any file that can be opened by Rasterio/GDAL
+        including georeferenced formats such as GeoTIFF and non-georeferenced formats
+        such as JPG. See https://www.gdal.org/formats_list.html for more details.
+
         If channel_order is None, then use non-alpha channels. This also sets any
         masked or NODATA pixel values to be zeros.
 

diff --git a/rastervision/data/raster_source/rasterio_source_config.py b/rastervision/data/raster_source/rasterio_source_config.py
@@ -75,6 +75,12 @@ def report_io(self, command_type, io_def):
 
 
 class RasterioSourceConfigBuilder(RasterSourceConfigBuilder):
+    """This RasterSource can read any file that can be opened by Rasterio/GDAL.
+
+    This includes georeferenced formats such as GeoTIFF and non-georeferenced formats
+    such as JPG. See https://www.gdal.org/formats_list.html for more details.
+    """
+
     def __init__(self, prev=None):
         config = {}
         if prev: