#update code

Author: debpal

GeoAnalyze/core.py

@@ -123,11 +123,19 @@ def raster_resampling_method(
     ) -> dict[str, rasterio.enums.Resampling]:
 
         '''
-        Returns the dictionary of raster resampling method. Supported options are:
-            - `nearest`: Nearest-neighbor interpolation.
-            - `bilinear`: Bilinear interpolation.
-            - `cubic`: Cubic convolution interpolation.
+        Returns the dictionary of raster resampling methods.
+
+        Supported options:
+
+        =================  ===========================================
+        Method             Description
+        =================  ===========================================
+        nearest            Nearest-neighbor interpolation.
+        bilinear           Bilinear interpolation.
+        cubic              Cubic interpolation.
+        =================  ===========================================
         '''
+        
         resampling_dictionary = {
             'nearest': rasterio.enums.Resampling.nearest,
             'bilinear': rasterio.enums.Resampling.bilinear,

GeoAnalyze/data/polygon.cpg

@@ -0,0 +1 @@
+UTF-8

GeoAnalyze/data/polygon.dbf

@@ -0,0 +1 @@
+PROJCS["EUREF_FIN_TM35FIN",GEOGCS["GCS_ETRS_1989",DATUM["D_ETRS_1989",SPHEROID["GRS_1980",6378137.0,298.257222101]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Transverse_Mercator"],PARAMETER["False_Easting",500000.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",27.0],PARAMETER["Scale_Factor",0.9996],PARAMETER["Latitude_Of_Origin",0.0],UNIT["Meter",1.0]]

GeoAnalyze/data/polygon.prj

@@ -1,5 +1,6 @@
 import os
 import rasterio
+import geopandas
 from .core import Core
 
 
@@ -9,7 +10,6 @@ class PackageData:
     Provides access to datasets included in the :mod:`GeoAnalyze` package.
     '''
 
-    # pytest complete
     def get_dem(
         self,
         dem_file: str
@@ -49,3 +49,22 @@ def get_dem(
                 dem_raster.write(raster_array, 1)
 
         return raster_profile
+
+    @property
+    def get_polygon_gdf(
+        self,
+    ) -> geopandas.GeoDataFrame:
+
+        '''
+        Retrieves the polygon GeoDataFrame from the test data.
+        '''
+
+        # data file path
+        data_file = os.path.join(
+            os.path.dirname(__file__), 'data', 'polygon.shp'
+        )
+
+        # polygon GeoDataFrame
+        gdf = geopandas.read_file(data_file)
+
+        return gdf

GeoAnalyze/data/polygon.shp

@@ -253,14 +253,13 @@ def resolution_rescaling(
 
         return output_profile
 
-    # pytest pending
     def resolution_rescaling_with_mask(
         self,
         input_file: str,
         mask_file: str,
         resampling_method: str,
         output_file: str
-    ) -> list[list[float]]:
+    ) -> rasterio.profiles.Profile:
 
         '''
         Rescales the raster array from its existing resolution
@@ -275,10 +274,8 @@ def resolution_rescaling_with_mask(
             Path to the mask raster file, defining the spatial extent and resolution.
 
         resampling_method : str
-            Method used for raster resampling. Supported options are:
-            - 'nearest': Nearest-neighbor interpolation.
-            - 'bilinear': Bilinear interpolation.
-            - 'cubic': Cubic convolution interpolation.
+            Raster resampling method with supported options from
+            :attr:`GeoAnalyze.core.Core.raster_resampling_method`.
 
         output_file : str
             Path to the output raster file.
@@ -290,18 +287,19 @@ def resolution_rescaling_with_mask(
             of the reprojected raster array. Each sublist represents a row of the matrix.
         '''
 
-        # mapping of resampling methods
-        resampling_function = {
-            'nearest': rasterio.enums.Resampling.nearest,
-            'bilinear': rasterio.enums.Resampling.bilinear,
-            'cubic': rasterio.enums.Resampling.cubic
-        }
+        # check validity of output file path
+        check_file = Core().is_valid_raster_driver(output_file)
+        if check_file is True:
+            pass
+        else:
+            raise Exception('Could not retrieve driver from the file path.')
 
         # check resampling method
-        if resampling_method in resampling_function.keys():
+        resampling_dict = Core().raster_resampling_method
+        if resampling_method in resampling_dict.keys():
             pass
         else:
-            raise Exception('Input resampling method is not supported.')
+            raise Exception(f'Input resampling method must be one of {list(resampling_dict.keys())}.')
 
         # rescaling resolution
         with rasterio.open(mask_file) as mask_raster:
@@ -333,20 +331,18 @@ def resolution_rescaling_with_mask(
                 )
                 # saving output raster
                 with rasterio.open(output_file, 'w', **mask_profile) as output_raster:
-                    rescaled_raster = rasterio.warp.reproject(
+                    rasterio.warp.reproject(
                         source=rasterio.band(input_raster, 1),
                         destination=rasterio.band(output_raster, 1),
                         src_transform=mask_raster.transform,
                         src_crs=mask_raster.crs,
                         dst_transform=output_transform,
                         dst_crs=mask_raster.crs,
-                        resampling=resampling_function[resampling_method]
+                        resampling=resampling_dict[resampling_method]
                     )
-                    affine_matrix = [
-                        list(rescaled_raster[1])[i:i + 3] for i in [0, 3, 6]
-                    ]
+                    output_profile = output_raster.profile
 
-        return affine_matrix
+        return output_profile
 
     def crs_reprojection(
         self,
@@ -432,13 +428,12 @@ def crs_reprojection(
 
         return output_profile
 
-    # pytest pending
     def nodata_conversion_from_value(
         self,
         input_file: str,
         target_value: list[float],
-        nodata: float,
-        output_file: str
+        output_file: str,
+        nodata: typing.Optional[float] = None
     ) -> rasterio.profiles.Profile:
 
         '''
@@ -464,8 +459,17 @@ def nodata_conversion_from_value(
             A profile containing metadata about the output raster.
         '''
 
+        # check validity of output file path
+        check_file = Core().is_valid_raster_driver(output_file)
+        if check_file is True:
+            pass
+        else:
+            raise Exception('Could not retrieve driver from the file path.')
+
+        # saving raster after converting raster value to NoData
         with rasterio.open(input_file) as input_raster:
             raster_profile = input_raster.profile
+            nodata = raster_profile['nodata'] if nodata is None else nodata
             input_array = input_raster.read(1)
             output_array = numpy.where(
                 numpy.isin(input_array, target_value),
@@ -479,7 +483,7 @@ def nodata_conversion_from_value(
             )
             with rasterio.open(output_file, 'w', **raster_profile) as output_raster:
                 output_raster.write(output_array, 1)
-                output_profile = dict(output_raster.profile)
+                output_profile = output_raster.profile
 
         return output_profile
 
@@ -521,6 +525,7 @@ def nodata_value_change(
         else:
             raise Exception('Could not retrieve driver from the file path.')
 
+        # saving raster after changing NoData value
         with rasterio.open(input_file) as input_raster:
             raster_profile = input_raster.profile
             output_array = numpy.where(
@@ -563,6 +568,14 @@ def clipping_by_shapes(
             A profile containing metadata about the output raster.
         '''
 
+        # check validity of output file path
+        check_file = Core().is_valid_raster_driver(output_file)
+        if check_file is True:
+            pass
+        else:
+            raise Exception('Could not retrieve driver from the file path.')
+
+        # saving clipped raster
         with rasterio.open(input_file) as input_raster:
             raster_profile = input_raster.profile.copy()
             gdf = geopandas.read_file(shape_file)
@@ -586,7 +599,6 @@ def clipping_by_shapes(
 
         return output_profile
 
-    # pytest pending
     def array_from_geometries(
         self,
         shape_file: str,
@@ -627,6 +639,13 @@ def array_from_geometries(
             A profile containing metadata about the output raster.
         '''
 
+        # check validity of output file path
+        check_file = Core().is_valid_raster_driver(output_file)
+        if check_file is True:
+            pass
+        else:
+            raise Exception('Could not retrieve driver from the file path.')
+
         # input shapes
         gdf = geopandas.read_file(shape_file)
 

GeoAnalyze/data/polygon.shx

@@ -6,3 +6,4 @@ API Reference
    :maxdepth: 2
 
    GeoAnalyze
+   submodules

GeoAnalyze/packagedata.py

@@ -0,0 +1,9 @@
+Submodules
+------------
+
+.. automodule:: GeoAnalyze.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+

GeoAnalyze/raster.py

@@ -1,5 +1,6 @@
 import os
 import tempfile
+import geopandas
 import GeoAnalyze
 import pytest
 
@@ -39,6 +40,10 @@ def test_count_cells(
             dem_file=dem_file
         )
         assert raster_profile['count'] == 1
+        # accessing polygon GeoDataFrame
+        polygon_gdf = packagedata.get_polygon_gdf
+        assert isinstance(polygon_gdf, geopandas.GeoDataFrame)
+        polygon_gdf.to_file(os.path.join(tmp_dir, 'polygon.shp'))
         # pass test for counting raster data cells
         data_cells = raster.count_data_cells(
             raster_file=dem_file
@@ -69,6 +74,14 @@ def test_count_cells(
             output_file=os.path.join(tmp_dir, 'dem_32m.tif')
         )
         assert output_profile['width'] == 1856
+        # pass test for raster resolution rescaling with mask
+        output_profile = raster.resolution_rescaling_with_mask(
+            input_file=os.path.join(tmp_dir, 'dem_32m.tif'),
+            mask_file=os.path.join(tmp_dir, 'dem.tif'),
+            resampling_method='bilinear',
+            output_file=os.path.join(tmp_dir, 'dem_16m.tif')
+        )
+        assert output_profile['height'] == 3790
         # pass test for raster Coordinate Reference System reprojectoion
         output_profile = raster.crs_reprojection(
             input_file=os.path.join(tmp_dir, 'dem_32m.tif'),
@@ -85,6 +98,13 @@ def test_count_cells(
             dtype='float32'
         )
         assert output_profile['nodata'] == 0
+        # pass test for raster clipping by shapes
+        output_profile = raster.clipping_by_shapes(
+            input_file=os.path.join(tmp_dir, 'dem_32m.tif'),
+            shape_file=os.path.join(tmp_dir, 'polygon.shp'),
+            output_file=os.path.join(tmp_dir, 'dem_32m_clipped.tif')
+        )
+        assert output_profile['width'] == 979
 
 
 def test_error_raster_file_driver(
@@ -99,6 +119,13 @@ def test_error_raster_file_driver(
             dem_file='dem.tifff',
         )
     assert exc_info.value.args[0] == message['error_driver']
+    # error test of invalid file path for raster boundary polygon GeoDataFrame
+    with pytest.raises(Exception) as exc_info:
+        raster.boundary_polygon(
+            raster_file='dem.tif',
+            shape_file='dem_boundary.sh'
+        )
+    assert exc_info.value.args[0] == message['error_driver']
     # error test of invalid file path for raster resolution rescaling
     with pytest.raises(Exception) as exc_info:
         raster.resolution_rescaling(
@@ -108,11 +135,13 @@ def test_error_raster_file_driver(
             output_file='dem_32m.tifff'
         )
     assert exc_info.value.args[0] == message['error_driver']
-    # error test of invalid file path for raster boundary polygon GeoDataFrame
+    # error test of invalid file path for raster resolution rescaling with mask
     with pytest.raises(Exception) as exc_info:
-        raster.boundary_polygon(
-            raster_file='dem.tif',
-            shape_file='dem_boundary.sh'
+        raster.resolution_rescaling_with_mask(
+            input_file='dem_32m.tif',
+            mask_file='dem.tif',
+            resampling_method='bilinear',
+            output_file='dem_16m.tifff'
         )
     assert exc_info.value.args[0] == message['error_driver']
     # error test of invalid file path for raster Coordinate Reference System reprojectoion
@@ -132,6 +161,33 @@ def test_error_raster_file_driver(
             output_file='dem_NoData_0.tifff'
         )
     assert exc_info.value.args[0] == message['error_driver']
+    # error test of invalid file path for raster array from geometries
+    with pytest.raises(Exception) as exc_info:
+        raster.array_from_geometries(
+            shape_file='stream.shp',
+            value_column='flw_id',
+            mask_file='dem.tif',
+            nodata=-9999,
+            dtype='int32',
+            output_file='stream.tifff'
+        )
+    assert exc_info.value.args[0] == message['error_driver']
+    # error test of invalid file path for raster NoData conversion from value
+    with pytest.raises(Exception) as exc_info:
+        raster.nodata_conversion_from_value(
+            input_file='stream.tif',
+            target_value=[1, 9],
+            output_file='stream_NoData.tifff',
+        )
+    assert exc_info.value.args[0] == message['error_driver']
+    # error test of invalid file path for raster clipping by shapes
+    with pytest.raises(Exception) as exc_info:
+        raster.clipping_by_shapes(
+            input_file='dem.tif',
+            shape_file='polygon.shp',
+            output_file='dem_clipped.tifff'
+        )
+    assert exc_info.value.args[0] == message['error_driver']
 
 
 def test_error_resampling_method(
@@ -148,6 +204,15 @@ def test_error_resampling_method(
             output_file='dem_32m.tif'
         )
     assert exc_info.value.args[0] == message['error_resampling']
+    # error test of resampling method for raster resolution rescaling with mask
+    with pytest.raises(Exception) as exc_info:
+        raster.resolution_rescaling_with_mask(
+            input_file='dem_32m.tif',
+            mask_file='dem.tif',
+            resampling_method='bilinearr',
+            output_file='dem_16m.tif'
+        )
+    assert exc_info.value.args[0] == message['error_resampling']
     # error test of resampling method for raster Coordinate Reference System reprojectoion
     with pytest.raises(Exception) as exc_info:
         raster.crs_reprojection(