Source code for GeoAnalyze.core

import string
import pyogrio
import rasterio
import geopandas
import shapely
import matplotlib.pyplot
import os




class Core:

    '''
    Provides common functionality used throughout
    the :mod:`GeoAnalyze` package.
    '''



    def is_valid_ogr_driver(
        self,
        shape_file: str
    ) -> bool:

        '''
        Checks whether the given shapefile path is valid and supported.

        Parameters
        ----------
        shape_file : str
            Path to the shapefile to be validated.

        Returns
        -------
        bool
            True if the shapefile path is valid and supported, False otherwise.
        '''

        try:
            pyogrio.detect_write_driver(shape_file)
            output = True
        except Exception:
            output = False

        return output




    def is_valid_raster_driver(
        self,
        raster_file: str
    ) -> bool:

        '''
        Checks whether the given raster file path is valid and supported.

        Parameters
        ----------
        raster_file : str
            Path to the raster file to be validated.

        Returns
        -------
        bool
            True if the raster file path is valid and supported, False otherwise.
        '''

        try:
            rasterio.drivers.driver_from_extension(raster_file)
            output = True
        except Exception:
            output = False

        return output




    def is_valid_figure_extension(
        self,
        file_path: str
    ) -> bool:

        '''
        Returns whether the given path is a valid figure file.

        Parameters
        ----------
        file_path : str
            Path of the figure file.

        Returns
        -------
        bool
            True if the file path is valid, False otherwise.
        '''

        figure = matplotlib.pyplot.figure(
            figsize=(1, 1)
        )
        file_ext = os.path.splitext(file_path)[-1][1:]
        supported_ext = list(figure.canvas.get_supported_filetypes().keys())
        output = file_ext in supported_ext

        matplotlib.pyplot.close(figure)

        return output




    def shapefile_geometry_type(
        self,
        shape_file: str
    ) -> str:

        '''
        Return the geometry type of the shapefile.

        Parameters
        ----------
        shape_file : str
            Path of the shapefile.

        Returns
        -------
        str
            Geometry type of the shapefile.
        '''

        output = str(pyogrio.read_info(shape_file)['geometry_type'])

        return output


    def _tmp_df_column_name(
        self,
        df_columns: list[str]
    ) -> str:

        '''
        Parameters
        ----------
        df_columns : list
            Input list of DataFrame columns.

        Returns
        -------
        str
            Temporary column name that does not belong to the
            list of existing column names of the DataFrame.
        '''

        max_length = max(
            [len(col) for col in df_columns]
        )

        output = string.ascii_lowercase[:(max_length + 1)]

        return output

    @property
    def _geodataframe_point(
        self,
    ) -> geopandas.GeoDataFrame:

        '''
        Returns a point GeoDataFrame.
        '''

        gdf = geopandas.GeoDataFrame(
            data={'C1': [1]},
            geometry=[shapely.Point(0, 0)],
            crs='EPSG:4326'
        )

        return gdf

    @property
    def raster_resampling_method(
        self
    ) -> dict[str, rasterio.enums.Resampling]:

        '''
        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,
            'cubic': rasterio.enums.Resampling.cubic
        }

        return resampling_dictionary