yirgacheffe 1.3.4__py3-none-any.whl → 1.4.1__py3-none-any.whl

yirgacheffe/__init__.py

@@ -12,6 +12,3 @@ WGS_84_PROJECTION = 'GEOGCS["WGS 84",DATUM["WGS_1984",SPHEROID["WGS 84",6378137,
     'AUTHORITY["EPSG","7030"]],AUTHORITY["EPSG","6326"]],PRIMEM["Greenwich",0],'\
     'UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]],AXIS["Latitude",NORTH],'\
     'AXIS["Longitude",EAST],AUTHORITY["EPSG","4326"]]'
-
-# For legacy reasons [facepalm]
-WSG_84_PROJECTION = WGS_84_PROJECTION

yirgacheffe/{backends → _backends}/__init__.py

@@ -8,6 +8,6 @@ match BACKEND:
         backend = mlx
     case "NUMPY":
         from . import numpy
-        backend = numpy
+        backend = numpy # type: ignore[misc]
     case _:
         raise NotImplementedError("Only NUMPY and MLX backends supported")

yirgacheffe/{backends → _backends}/mlx.py

@@ -1,6 +1,7 @@
+from typing import Callable, Dict
 
 import numpy as np
-import mlx.core as mx # pylint: disable=E0001,E0611,E0401
+import mlx.core as mx # type: ignore
 import mlx.nn
 
 from .enumeration import operators as op
@@ -182,7 +183,7 @@ def backend_to_dtype(val):
 def astype_op(data, datatype):
     return data.astype(dtype_to_backed(datatype))
 
-operator_map = {
+operator_map : Dict[op,Callable] = {
     op.ADD: mx.array.__add__,
     op.SUB: mx.array.__sub__,
     op.MUL: mul_op,

yirgacheffe/{backends → _backends}/numpy.py

@@ -1,3 +1,4 @@
+from typing import Callable, Dict
 
 import numpy as np
 import torch
@@ -120,7 +121,7 @@ def backend_to_dtype(val):
 def astype_op(data, datatype):
     return data.astype(dtype_to_backed(datatype))
 
-operator_map = {
+operator_map : Dict[op,Callable] = {
     op.ADD: np.ndarray.__add__,
     op.SUB: np.ndarray.__sub__,
     op.MUL: np.ndarray.__mul__,

yirgacheffe/layers/__init__.py

@@ -12,32 +12,3 @@ try:
     from .h3layer import H3CellLayer
 except ModuleNotFoundError:
     pass
-
-class Layer(RasterLayer):
-    """A place holder for now, at some point I want to replace Layer with RasterLayer."""
-
-
-class VectorRangeLayer(RasteredVectorLayer):
-    """Deprecated older name for VectorLayer"""
-
-    def __init__(self, range_vectors: str, where_filter: str, scale: PixelScale, projection: str):
-        vectors = ogr.Open(range_vectors)
-        if vectors is None:
-            raise FileNotFoundError(range_vectors)
-        layer = vectors.GetLayer()
-        if where_filter is not None:
-            layer.SetAttributeFilter(where_filter)
-        super().__init__(layer, scale, projection)
-
-
-class DynamicVectorRangeLayer(VectorLayer):
-    """Deprecated older name DynamicVectorLayer"""
-
-    def __init__(self, range_vectors: str, where_filter: str, scale: PixelScale, projection: str):
-        vectors = ogr.Open(range_vectors)
-        if vectors is None:
-            raise FileNotFoundError(range_vectors)
-        layer = vectors.GetLayer()
-        if where_filter is not None:
-            layer.SetAttributeFilter(where_filter)
-        super().__init__(layer, scale, projection)

yirgacheffe/layers/base.py

@@ -25,7 +25,7 @@ class YirgacheffeLayer(LayerMathMixin):
 
         self.reset_window()
 
-    def close(self):
+    def close(self) -> None:
         pass
 
     def __enter__(self):
@@ -34,6 +34,16 @@ class YirgacheffeLayer(LayerMathMixin):
     def __exit__(self, exc_type, exc_val, exc_tb):
         self.close()
 
+    def _park(self) -> None:
+        pass
+
+    def _unpark(self) -> None:
+        pass
+
+    @property
+    def _raster_dimensions(self) -> Tuple[int,int]:
+        raise AttributeError("Does not have raster")
+
     @property
     def datatype(self) -> DataType:
         raise NotImplementedError("Must be overridden by subclass")
@@ -131,9 +141,10 @@ class YirgacheffeLayer(LayerMathMixin):
             raise ValueError('Window has negative offset')
         # If there is an underlying raster for this layer, do a sanity check
         try:
-            if ((new_window.xoff + new_window.xsize) > self._raster_xsize) or \
-                ((new_window.yoff + new_window.ysize) > self._raster_ysize):
-                raise ValueError(f'Window is bigger than dataset: raster is {self._raster_xsize}x{self._raster_ysize}'\
+            raster_xsize, raster_ysize = self._raster_dimensions
+            if ((new_window.xoff + new_window.xsize) > raster_xsize) or \
+                ((new_window.yoff + new_window.ysize) > raster_ysize):
+                raise ValueError(f'Window is bigger than dataset: raster is {raster_xsize}x{raster_ysize}'\
                     f', new window is {new_window.xsize - new_window.xoff}x{new_window.ysize - new_window.yoff}')
         except AttributeError:
             pass
@@ -162,9 +173,10 @@ class YirgacheffeLayer(LayerMathMixin):
             raise ValueError('Window has positive offset')
         # If there is an underlying raster for this layer, do a sanity check
         try:
-            if ((new_window.xsize - new_window.xoff) < self._raster_xsize) or \
-                ((new_window.ysize - new_window.yoff) < self._raster_ysize):
-                raise ValueError(f'Window is smaller than dataset: raster is {self._raster_xsize}x{self._raster_ysize}'\
+            raster_xsize, raster_ysize = self._raster_dimensions
+            if ((new_window.xsize - new_window.xoff) < raster_xsize) or \
+                ((new_window.ysize - new_window.yoff) <raster_ysize):
+                raise ValueError(f'Window is smaller than dataset: raster is {raster_xsize}x{raster_ysize}'\
                     f', new window is {new_window.xsize - new_window.xoff}x{new_window.ysize - new_window.yoff}')
         except AttributeError:
             pass
@@ -219,6 +231,7 @@ class YirgacheffeLayer(LayerMathMixin):
         raise NotImplementedError("Must be overridden by subclass")
 
     def read_array_for_area(self, target_area: Area, x: int, y: int, width: int, height: int) -> Any:
+        assert self._pixel_scale is not None
 
         target_window = Window(
             xoff=round_down_pixels((target_area.left - self._underlying_area.left) / self._pixel_scale.xstep,

yirgacheffe/layers/constant.py

@@ -3,7 +3,7 @@ from typing import Any, Union
 from ..operators import DataType
 from ..window import Area, PixelScale, Window
 from .base import YirgacheffeLayer
-from ..backends import backend
+from .._backends import backend
 from .. import WGS_84_PROJECTION
 
 

yirgacheffe/layers/group.py

@@ -1,7 +1,8 @@
+from __future__ import annotations
 import copy
 import glob
 import os
-from typing import Any, List, Optional, TypeVar
+from typing import Any, List, Optional
 
 import numpy as np
 from yirgacheffe.operators import DataType
@@ -10,9 +11,8 @@ from ..rounding import are_pixel_scales_equal_enough, round_down_pixels
 from ..window import Area, Window
 from .base import YirgacheffeLayer
 from .rasters import RasterLayer
-from ..backends import backend
+from .._backends import backend
 
-GroupLayerT = TypeVar("GroupLayerT", bound="GroupLayer")
 
 class GroupLayerEmpty(ValueError):
     def __init__(self, msg):
@@ -26,7 +26,7 @@ class GroupLayer(YirgacheffeLayer):
         directory_path: str,
         name: Optional[str] = None,
         matching: str = "*.tif"
-    ) -> GroupLayerT:
+    ) -> GroupLayer:
         if directory_path is None:
             raise ValueError("Directory path is None")
         files = [os.path.join(directory_path, x) for x in glob.glob(matching, root_dir=directory_path)]
@@ -35,12 +35,12 @@ class GroupLayer(YirgacheffeLayer):
         return cls.layer_from_files(files, name)
 
     @classmethod
-    def layer_from_files(cls, filenames: List[str], name: Optional[str] = None) -> GroupLayerT:
+    def layer_from_files(cls, filenames: List[str], name: Optional[str] = None) -> GroupLayer:
         if filenames is None:
             raise ValueError("filenames argument is None")
         if len(filenames) < 1:
             raise GroupLayerEmpty("No files found")
-        rasters = [RasterLayer.layer_from_file(x) for x in filenames]
+        rasters: List[YirgacheffeLayer] = [RasterLayer.layer_from_file(x) for x in filenames]
         return cls(rasters, name)
 
     def __init__(self, layers: List[YirgacheffeLayer], name: Optional[str] = None) -> None:
@@ -65,7 +65,7 @@ class GroupLayer(YirgacheffeLayer):
         self._underlying_layers.reverse()
         self.layers = self._underlying_layers
 
-    def _park(self):
+    def _park(self) -> None:
         for layer in self.layers:
             try:
                 layer._park()
@@ -157,7 +157,7 @@ class GroupLayer(YirgacheffeLayer):
 class TileData:
     """This class exists just to let me sort the tiles into the correct order for processing."""
 
-    def __init__(self, data, x, y):
+    def __init__(self, data: Any, x: int, y: int):
         self.data = data
         self.x = x
         self.y = y
@@ -219,7 +219,7 @@ class TiledGroupLayer(GroupLayer):
             ysize
         )
 
-        partials = []
+        partials: List[TileData] = []
         for layer in self.layers:
             # Normally this is hidden with set_window_for_...
             adjusted_layer_window = Window(
@@ -251,7 +251,7 @@ class TiledGroupLayer(GroupLayer):
         # the "obvious" tile. In which case, we should reject the smaller section. If we have
         # two tiles at the same offset and one is not a perfect subset of the other then the
         # tile set we were given is not regularly shaped, and so we should give up.
-        combed_partials = []
+        combed_partials: List[TileData] = []
         previous_tile = None
         for tile in sorted_partials:
             if previous_tile is None:
@@ -276,7 +276,7 @@ class TiledGroupLayer(GroupLayer):
         expected_next_x = 0
         expected_next_y = 0
         data = None
-        row_chunk = None
+        row_chunk: Optional[np.ndarray] = None
 
         # Allow for reading off top
         if combed_partials:
@@ -337,6 +337,7 @@ class TiledGroupLayer(GroupLayer):
                             data = np.vstack((data, row_chunk))
                             expected_next_y += last_y_height
                         else:
+                            assert last_y_offset is not None
                             diff = expected_next_y - last_y_offset
                             assert diff > 0, f"{expected_next_y} - {last_y_offset} <= 0 (aka {diff})"
                             subdata = np.delete(row_chunk, np.s_[0:diff], 0)
@@ -351,8 +352,10 @@ class TiledGroupLayer(GroupLayer):
                     last_y_height = tile.data.shape[0]
                     expected_next_x = tile.data.shape[1] + tile.x
 
+        assert last_y_offset is not None
         if (last_y_offset + last_y_height) < ysize:
             data = np.vstack((data, np.zeros((ysize - (last_y_offset + last_y_height), xsize))))
 
+        assert data is not None
         assert data.shape == (ysize, xsize)
         return backend.promote(data)

yirgacheffe/layers/h3layer.py

@@ -1,5 +1,5 @@
 from math import ceil, floor
-from typing import Any
+from typing import Any, Tuple
 
 import h3
 import numpy as np
@@ -8,7 +8,7 @@ from yirgacheffe.operators import DataType
 from ..rounding import round_up_pixels
 from ..window import Area, PixelScale, Window
 from .base import YirgacheffeLayer
-from ..backends import backend
+from .._backends import backend
 
 class H3CellLayer(YirgacheffeLayer):
 
@@ -74,12 +74,17 @@ class H3CellLayer(YirgacheffeLayer):
             (sorted_lats[1] / abs_ystep) * abs_ystep,
         )
 
+    @property
+    def _raster_dimensions(self) -> Tuple[int,int]:
+        return (self._raster_xsize, self._raster_ysize)
 
     @property
     def datatype(self) -> DataType:
         return DataType.Float64
 
     def read_array_with_window(self, xoffset: int, yoffset: int, xsize: int, ysize: int, window: Window) -> Any:
+        assert self._pixel_scale is not None
+
         if (xsize <= 0) or (ysize <= 0):
             raise ValueError("Request dimensions must be positive and non-zero")
 

yirgacheffe/layers/rasters.py

@@ -1,6 +1,7 @@
+from __future__ import annotations
 import math
 import os
-from typing import Any, Optional, TypeVar, Union
+from typing import Any, Optional, Tuple, Union
 
 import numpy as np
 from osgeo import gdal
@@ -10,10 +11,7 @@ from ..window import Area, PixelScale, Window
 from ..rounding import round_up_pixels
 from .base import YirgacheffeLayer
 from ..operators import DataType
-from ..backends import backend
-
-# Still to early to require Python 3.11 :/
-RasterLayerT = TypeVar("RasterLayerT", bound="RasterLayer")
+from .._backends import backend
 
 class InvalidRasterBand(Exception):
     def __init__ (self, band):
@@ -37,7 +35,7 @@ class RasterLayer(YirgacheffeLayer):
         nbits: Optional[int]=None,
         threads: Optional[int]=None,
         bands: int=1
-    ) -> RasterLayerT:
+    ) -> RasterLayer:
         abs_xstep, abs_ystep = abs(scale.xstep), abs(scale.ystep)
 
         # We treat the provided area as aspirational, and we need to align it to pixel boundaries
@@ -50,7 +48,9 @@ class RasterLayer(YirgacheffeLayer):
 
         # This used to the the GDAL type, so we support that for legacy reasons
         if isinstance(datatype, int):
-            datatype = DataType.of_gdal(datatype)
+            datatype_arg = DataType.of_gdal(datatype)
+        else:
+            datatype_arg = datatype
 
         options = []
         if threads is not None:
@@ -74,7 +74,7 @@ class RasterLayer(YirgacheffeLayer):
             round_up_pixels((pixel_friendly_area.right - pixel_friendly_area.left) / abs_xstep, abs_xstep),
             round_up_pixels((pixel_friendly_area.top - pixel_friendly_area.bottom) / abs_ystep, abs_ystep),
             bands,
-            datatype.to_gdal(),
+            datatype_arg.to_gdal(),
             options
         )
         dataset.SetGeoTransform([
@@ -96,7 +96,7 @@ class RasterLayer(YirgacheffeLayer):
         nbits: Optional[int]=None,
         threads: Optional[int]=None,
         bands: int=1
-    ) -> RasterLayerT:
+    ) -> RasterLayer:
         width = layer.window.xsize
         height = layer.window.ysize
         if area is None:
@@ -117,6 +117,13 @@ class RasterLayer(YirgacheffeLayer):
             area.left, scale.xstep, 0.0, area.top, 0.0, scale.ystep
         )
 
+        if datatype is None:
+            datatype_arg = layer.datatype
+        elif isinstance(datatype, int):
+            datatype_arg = DataType.of_gdal(datatype)
+        else:
+            datatype_arg = datatype
+
         options = []
         if threads is not None:
             options.append(f"NUM_THREADS={threads}")
@@ -139,7 +146,7 @@ class RasterLayer(YirgacheffeLayer):
             width,
             height,
             bands,
-            (datatype if datatype is not None else layer.datatype).to_gdal(),
+            (datatype_arg).to_gdal(),
             options,
         )
         dataset.SetGeoTransform(geo_transform)
@@ -152,13 +159,15 @@ class RasterLayer(YirgacheffeLayer):
     @classmethod
     def scaled_raster_from_raster(
         cls,
-        source: RasterLayerT,
+        source: RasterLayer,
         new_pixel_scale: PixelScale,
         filename: Optional[str]=None,
         compress: bool=True,
         algorithm: int=gdal.GRA_NearestNeighbour,
-    ) -> RasterLayerT:
+    ) -> RasterLayer:
         source_dataset = source._dataset
+        assert source_dataset is not None
+
         old_pixel_scale = source.pixel_scale
         assert old_pixel_scale
 
@@ -205,7 +214,7 @@ class RasterLayer(YirgacheffeLayer):
         return RasterLayer(dataset)
 
     @classmethod
-    def layer_from_file(cls, filename: str, band: int = 1) -> RasterLayerT:
+    def layer_from_file(cls, filename: str, band: int = 1) -> RasterLayer:
         try:
             dataset = gdal.Open(filename, gdal.GA_ReadOnly)
         except RuntimeError as exc:
@@ -248,6 +257,10 @@ class RasterLayer(YirgacheffeLayer):
         self._raster_xsize = dataset.RasterXSize
         self._raster_ysize = dataset.RasterYSize
 
+    @property
+    def _raster_dimensions(self) -> Tuple[int,int]:
+        return (self._raster_xsize, self._raster_ysize)
+
     def close(self):
         try:
             if self._dataset:
@@ -274,10 +287,8 @@ class RasterLayer(YirgacheffeLayer):
         self._unpark()
 
     def _park(self):
-        try:
+        if self._dataset is not None:
             self._dataset.Close()
-        except AttributeError:
-            pass
         self._dataset = None
 
     def _unpark(self):

yirgacheffe/layers/rescaled.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from math import floor, ceil
 from typing import Any, Optional
 
@@ -6,7 +7,7 @@ from yirgacheffe.operators import DataType
 
 from ..window import PixelScale, Window
 from .rasters import RasterLayer, YirgacheffeLayer
-from ..backends import backend
+from .._backends import backend
 
 
 class RescaledRasterLayer(YirgacheffeLayer):
@@ -20,7 +21,7 @@ class RescaledRasterLayer(YirgacheffeLayer):
         pixel_scale: PixelScale,
         band: int = 1,
         nearest_neighbour: bool = True,
-    ):
+    ) -> RescaledRasterLayer:
         src = RasterLayer.layer_from_file(filename, band=band)
         return RescaledRasterLayer(src, pixel_scale, nearest_neighbour, src.name)
 

yirgacheffe/layers/vectors.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import os
 from math import ceil, floor
 from typing import Any, Optional, Tuple, Union
@@ -9,9 +10,9 @@ from ..operators import DataType
 from ..window import Area, PixelScale
 from .base import YirgacheffeLayer
 from .rasters import RasterLayer
-from ..backends import backend
+from .._backends import backend
 
-def _validate_burn_value(burn_value: Any, layer: ogr.Layer) -> int: # pylint: disable=R0911
+def _validate_burn_value(burn_value: Any, layer: ogr.Layer) -> DataType: # pylint: disable=R0911
     if isinstance(burn_value, str):
         # burn value is field name, so validate it
         index = layer.FindFieldIndex(burn_value, True)
@@ -23,32 +24,32 @@ def _validate_burn_value(burn_value: Any, layer: ogr.Layer) -> int: # pylint: di
         field = definition.GetFieldDefn(index)
         typename = field.GetTypeName()
         if typename == "Integer":
-            return gdal.GDT_Int64
+            return DataType.Int64
         elif typename == "Real":
-            return gdal.GDT_Float64
+            return DataType.Float64
         else:
             raise ValueError(f"Can't set datatype {typename} for burn value {burn_value}")
     elif isinstance(burn_value, int):
         if 0 <= burn_value <= 255:
-            return gdal.GDT_Byte
+            return DataType.Byte
         else:
             unsigned = burn_value > 0
             if unsigned:
                 if burn_value < (pow(2, 16)):
-                    return gdal.GDT_UInt16
+                    return DataType.UInt16
                 elif burn_value < (pow(2, 32)):
-                    return gdal.GDT_UInt32
+                    return DataType.UInt32
                 else:
-                    return gdal.GDT_UInt64
+                    return DataType.UInt64
             else:
                 if abs(burn_value) < (pow(2, 15)):
-                    return gdal.GDT_Int16
+                    return DataType.Int16
                 elif abs(burn_value) < (pow(2, 31)):
-                    return gdal.GDT_Int32
+                    return DataType.Int32
                 else:
-                    return gdal.GDT_Int64
+                    return DataType.Int64
     elif isinstance(burn_value, float):
-        return gdal.GDT_Float64
+        return DataType.Float64
     else:
         raise ValueError(f"data type of burn value {burn_value} not supported")
 
@@ -59,7 +60,7 @@ class RasteredVectorLayer(RasterLayer):
     VectorLayer."""
 
     @classmethod
-    def layer_from_file(
+    def layer_from_file( # type: ignore[override] # pylint: disable=W0221
         cls,
         filename: str,
         where_filter: Optional[str],
@@ -67,7 +68,7 @@ class RasteredVectorLayer(RasterLayer):
         projection: str,
         datatype: Optional[Union[int, DataType]] = None,
         burn_value: Union[int,float,str] = 1,
-    ): # pylint: disable=W0221
+    ) -> RasteredVectorLayer:
         vectors = ogr.Open(filename)
         if vectors is None:
             raise FileNotFoundError(filename)
@@ -77,16 +78,17 @@ class RasteredVectorLayer(RasterLayer):
 
         estimated_datatype = _validate_burn_value(burn_value, layer)
         if datatype is None:
-            datatype = estimated_datatype
-
-        if isinstance(datatype, int):
-            datatype = DataType.of_gdal(datatype)
+            datatype_arg: DataType = estimated_datatype
+        elif isinstance(datatype, int):
+            datatype_arg = DataType.of_gdal(datatype)
+        else:
+            datatype_arg = datatype
 
         vector_layer = RasteredVectorLayer(
             layer,
             scale,
             projection,
-            datatype=datatype,
+            datatype=datatype_arg,
             burn_value=burn_value
         )
 
@@ -108,10 +110,12 @@ class RasteredVectorLayer(RasterLayer):
             raise ValueError('No layer provided')
         self.layer = layer
 
-        self._original = None
+        self._original: Optional[Any] = None
 
         if isinstance(datatype, int):
-            datatype = DataType.of_gdal(datatype)
+            datatype_arg = DataType.of_gdal(datatype)
+        else:
+            datatype_arg = datatype
 
         # work out region for mask
         envelopes = []
@@ -142,7 +146,7 @@ class RasteredVectorLayer(RasterLayer):
             round((area.right - area.left) / abs_xstep),
             round((area.top - area.bottom) / abs_ystep),
             1,
-            datatype.to_gdal(),
+            datatype_arg.to_gdal(),
             []
         )
         if not dataset:
@@ -173,7 +177,7 @@ class VectorLayer(YirgacheffeLayer):
         where_filter: Optional[str]=None,
         datatype: Optional[Union[int, DataType]] = None,
         burn_value: Union[int,float,str] = 1,
-    ):
+    ) -> VectorLayer:
         if other_layer is None:
             raise ValueError("like layer can not be None")
         if other_layer.pixel_scale is None:
@@ -208,7 +212,6 @@ class VectorLayer(YirgacheffeLayer):
         vector_layer._filter = where_filter
         return vector_layer
 
-
     @classmethod
     def layer_from_file(
         cls,
@@ -219,7 +222,7 @@ class VectorLayer(YirgacheffeLayer):
         datatype: Optional[Union[int, DataType]] = None,
         burn_value: Union[int,float,str] = 1,
         anchor: Tuple[float,float] = (0.0, 0.0)
-    ):
+    ) -> VectorLayer:
         vectors = ogr.Open(filename)
         if vectors is None:
             raise FileNotFoundError(filename)
@@ -232,14 +235,16 @@ class VectorLayer(YirgacheffeLayer):
             datatype = estimated_datatype
 
         if isinstance(datatype, int):
-            datatype = DataType.of_gdal(datatype)
+            datatype_arg = DataType.of_gdal(datatype)
+        else:
+            datatype_arg = datatype
 
         vector_layer = VectorLayer(
             layer,
             scale,
             projection,
             name=filename,
-            datatype=datatype,
+            datatype=datatype_arg,
             burn_value=burn_value,
             anchor=anchor
         )
@@ -277,8 +282,8 @@ class VectorLayer(YirgacheffeLayer):
         self.burn_value = burn_value
 
         self._original = None
-        self._dataset_path = None
-        self._filter = None
+        self._dataset_path: Optional[str] = None
+        self._filter: Optional[str] = None
 
         # work out region for mask
         envelopes = []
@@ -318,7 +323,7 @@ class VectorLayer(YirgacheffeLayer):
 
     def __getstate__(self) -> object:
         # Only support pickling on file backed layers (ideally read only ones...)
-        if not os.path.isfile(self._dataset_path):
+        if self._dataset_path is None or not os.path.isfile(self._dataset_path):
             raise ValueError("Can not pickle layer that is not file backed.")
         odict = self.__dict__.copy()
         del odict['_original']
@@ -353,6 +358,8 @@ class VectorLayer(YirgacheffeLayer):
         return self._datatype
 
     def read_array_for_area(self, target_area: Area, x: int, y: int, width: int, height: int) -> Any:
+        assert self._pixel_scale is not None
+
         if self._original is None:
             self._unpark()
         if (width <= 0) or (height <= 0):

yirgacheffe/operators.py

@@ -7,18 +7,18 @@ import types
 from enum import Enum
 from multiprocessing import Semaphore, Process
 from multiprocessing.managers import SharedMemoryManager
-from typing import Optional
+from typing import Callable, Optional
 
 import numpy as np
 from osgeo import gdal
-from dill import dumps, loads
+from dill import dumps, loads # type: ignore
 
 from . import constants
 from .rounding import are_pixel_scales_equal_enough, round_up_pixels, round_down_pixels
 from .window import Area, PixelScale, Window
-from .backends import backend
-from .backends.enumeration import operators as op
-from .backends.enumeration import dtype as DataType
+from ._backends import backend
+from ._backends.enumeration import operators as op
+from ._backends.enumeration import dtype as DataType
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.WARNING)
@@ -320,7 +320,7 @@ class LayerOperation(LayerMathMixin):
         else:
             self.other = None
 
-    def __str__(self):
+    def __str__(self) -> str:
         try:
             return f"({self.lhs} {self.operator} {self.rhs})"
         except AttributeError:
@@ -329,7 +329,7 @@ class LayerOperation(LayerMathMixin):
             except AttributeError:
                 return str(self.lhs)
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(self.lhs)
 
     def __getstate__(self) -> object:
@@ -339,22 +339,22 @@ class LayerOperation(LayerMathMixin):
             del odict['operator']
         return odict
 
-    def __setstate__(self, state):
+    def __setstate__(self, state) -> None:
         if 'operator_dill' in state:
             state['operator'] = loads(state['operator_dill'])
             del state['operator_dill']
         self.__dict__.update(state)
 
     @property
-    def area(self) -> Area:
+    def area(self) -> Optional[Area]:
         # The type().__name__ here is to avoid a circular import dependancy
         lhs_area = self.lhs.area if not type(self.lhs).__name__ == "ConstantLayer" else None
         try:
-            rhs_area = self.rhs.area if not type(self.rhs).__name__ == "ConstantLayer" else None
+            rhs_area = self.rhs.area if not type(self.rhs).__name__ == "ConstantLayer" else None # type: ignore[return-value] # pylint: disable=C0301
         except AttributeError:
             rhs_area = None
         try:
-            other_area = self.other.area if not type(self.other).__name__ == "ConstantLayer" else None
+            other_area = self.other.area if not type(self.other).__name__ == "ConstantLayer" else None # type: ignore[return-value] # pylint: disable=C0301
         except AttributeError:
             other_area = None
 
@@ -391,6 +391,8 @@ class LayerOperation(LayerMathMixin):
                     right=max(x.right for x in all_areas),
                     bottom=min(x.bottom for x in all_areas)
                 )
+            case _:
+                assert False, "Should not be reached"
 
     @property
     def pixel_scale(self) -> PixelScale:
@@ -409,6 +411,7 @@ class LayerOperation(LayerMathMixin):
     def window(self) -> Window:
         pixel_scale = self.pixel_scale
         area = self.area
+        assert area is not None
 
         return Window(
             xoff=round_down_pixels(area.left / pixel_scale.xstep, pixel_scale.xstep),
@@ -450,7 +453,7 @@ class LayerOperation(LayerMathMixin):
             return lhs_data
 
         try:
-            operator = backend.operator_map[self.operator]
+            operator: Callable = backend.operator_map[self.operator]
         except KeyError:
             # Handles things like `numpy_apply` where a custom operator is provided
             operator = self.operator

yirgacheffe/window.py

@@ -2,12 +2,36 @@ import math
 import sys
 from collections import namedtuple
 from dataclasses import dataclass
-from typing import List, Optional
+from typing import List, Optional, Tuple
 
 PixelScale = namedtuple('PixelScale', ['xstep', 'ystep'])
 
 @dataclass
 class Area:
+    """Class to hold a geospatial area of data in the given projection.
+
+    Parameters
+    ----------
+    left : float
+        Left most point in the projection space
+    top : float
+        Top most point in the projection space
+    right : float
+        Right most point in the projection space
+    bottom : float
+        Bottom most point in the projection space
+
+    Attributes
+    ----------
+    left : float
+        Left most point in the projection space
+    top : float
+        Top most point in the projection space
+    right : float
+        Right most point in the projection space
+    bottom : float
+        Bottom most point in the projection space
+    """
     left: float
     top: float
     right: float
@@ -23,6 +47,21 @@ class Area:
             math.isclose(self.bottom, other.bottom, abs_tol=1e-09)
 
     def grow(self, offset: float):
+        """Expand the area in all directions by the given amount.
+
+        Generates a new area that is an expanded version of the current area.
+
+        Parameters
+        ----------
+        offset : float
+            The amount by which to grow the area
+
+        Returns
+        -------
+        Area
+            A new area of the expanded size.
+
+        """
         return Area(
             left=self.left - offset,
             top=self.top + offset,
@@ -31,6 +70,18 @@ class Area:
         )
 
     def overlaps(self, other) -> bool:
+        """Check if this area overlaps with another area.
+
+        Parameters
+        ----------
+        other : Area
+            The other area to compare this area with
+
+        Returns
+        -------
+        bool
+            True if the two areas intersect, otherwise false.
+        """
         return (
             (self.left <= other.left <= self.right) or
             (self.left <= other.right <= self.right) or
@@ -45,13 +96,38 @@ class Area:
 
 @dataclass
 class Window:
+    """Class to hold the pixel dimensions of data in the given projection.
+
+    Parameters
+    ----------
+    xoff : int
+        X axis offset
+    yoff : int
+        Y axis offset
+    xsize : int
+        Width of data in pixels
+    bottom : float
+        Height of data in pixels
+
+    Attributes
+    ----------
+    xoff : int
+        X axis offset
+    yoff : int
+        Y axis offset
+    xsize : int
+        Width of data in pixels
+    bottom : float
+        Height of data in pixels
+    """
     xoff: int
     yoff: int
     xsize: int
     ysize: int
 
     @property
-    def as_array_args(self):
+    def as_array_args(self) -> Tuple[int,...]:
+        """A tuple containing xoff, yoff, xsize, and ysize."""
         return (self.xoff, self.yoff, self.xsize, self.ysize)
 
     def __lt__(self, other) -> bool:
@@ -87,6 +163,21 @@ class Window:
             ((self.yoff + self.ysize) >= (other.yoff + other.ysize))
 
     def grow(self, pixels: int):
+        """Expand the area in all directions by the given amount.
+
+        Generates a new window that is an expanded version of the current window.
+
+        Parameters
+        ----------
+        pixels : int
+            The amount by which to grow the window in pixels
+
+        Returns
+        -------
+        Window
+            A new window of the expanded size.
+
+        """
         return Window(
             xoff=self.xoff - pixels,
             yoff=self.xoff - pixels,

{yirgacheffe-1.3.4.dist-info → yirgacheffe-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yirgacheffe
-Version: 1.3.4
+Version: 1.4.1
 Summary: Abstraction of gdal datasets for doing basic math operations
 Author-email: Michael Dales <mwd24@cam.ac.uk>
 License-Expression: ISC
@@ -13,6 +13,7 @@ Requires-Dist: numpy
 Requires-Dist: gdal[numpy]
 Requires-Dist: scikit-image
 Requires-Dist: torch
+Requires-Dist: dill
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pylint; extra == "dev"

yirgacheffe-1.4.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+yirgacheffe/__init__.py,sha256=nrVZPE_4DgReqmqEOfUaXJiRtxjOt-OJSIVi51Z5k98,587
+yirgacheffe/constants.py,sha256=WccPcISG1FqL_Kw1tI72BJGjHy6RvEcGEx_I9RK776U,42
+yirgacheffe/operators.py,sha256=j5Ts9dxqcxq_bL7Mw-n6vTg0SP5rKpqseVcJTD8PaAY,29363
+yirgacheffe/rounding.py,sha256=ggBG4lMyLMtHLW3dBxr3gBCcF2qhRrY5etZiFGlIoqA,2258
+yirgacheffe/window.py,sha256=PVh9EIg1PMcUENjC2yahmrolGWaJP4OeM44uKqQ6I0U,7504
+yirgacheffe/_backends/__init__.py,sha256=jN-2iRrHStnPI6cNL7XhwhsROtI0EaGfIrbF5c-ECV0,334
+yirgacheffe/_backends/enumeration.py,sha256=pADawllxpW_hW-IVVvZpHWIKzvEMs9aaqfkZRD1zjnY,1003
+yirgacheffe/_backends/mlx.py,sha256=2vOTMqHbQbeqt81Eq_8hxWDXZHaPsDpbXkALRVGEnnw,6130
+yirgacheffe/_backends/numpy.py,sha256=cYO628s4-5K_-Bp3CrnHegzYSZfkt2QC8iE9oOOMtvA,4069
+yirgacheffe/layers/__init__.py,sha256=mYKjw5YTcMNv_hMy7a6K4yRzIuNUbR8WuBTw4WIAmSk,435
+yirgacheffe/layers/area.py,sha256=yIRXzeeLi3MMyuh4LG_VgZrKNWe5xwZgDGdgaoYRpP0,3805
+yirgacheffe/layers/base.py,sha256=l2spGsDsv2DaUqkK-nuJCC97fw0kVWaLntvvLqZgJS4,11959
+yirgacheffe/layers/constant.py,sha256=LWQuGGuUkJirLoQomZHs44oksmMKcvNGM8pOuRk9vHo,1427
+yirgacheffe/layers/group.py,sha256=Fys5BvYmWRQMc95YE8Gy6bxxZRqvHUU7gILFE_X-CpY,15330
+yirgacheffe/layers/h3layer.py,sha256=kWDqs6fIkHLR7gDL2E6F5y9-XxT6ws4M3Tj_7qF090U,9863
+yirgacheffe/layers/rasters.py,sha256=I9bRuqb0W8EEvdSq3rAeKNmezIRK-yajFaHtDFR81sw,12630
+yirgacheffe/layers/rescaled.py,sha256=v3ZXo3aNNDP4b8O6QnQHgrhBu0GslTgiZQmy6O8vb8k,3004
+yirgacheffe/layers/vectors.py,sha256=3QWjg0E9deZyLIBp-BewgDGY90Ufqd6OcUA7jzJXJPo,15515
+yirgacheffe-1.4.1.dist-info/licenses/LICENSE,sha256=dNSHwUCJr6axStTKDEdnJtfmDdFqlE3h1NPCveqPfnY,757
+yirgacheffe-1.4.1.dist-info/METADATA,sha256=TZlmFtOF9UJXDm3jkJSWwb-pRjbKx2fF8Bh9kXK40Ns,20516
+yirgacheffe-1.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+yirgacheffe-1.4.1.dist-info/entry_points.txt,sha256=j4KgHXbVGbGyfTySc1ypBdERpfihO4WNjppvCdE9HjE,52
+yirgacheffe-1.4.1.dist-info/top_level.txt,sha256=9DBFlKO2Ld3hG6TuE3qOTd3Tt8ugTiXil4AN4Wr9_y0,12
+yirgacheffe-1.4.1.dist-info/RECORD,,

yirgacheffe/h3layer.py

@@ -1,2 +0,0 @@
-# for legacy compatibility
-from .layers.h3layer import H3CellLayer # pylint: disable=W0611

yirgacheffe-1.3.4.dist-info/RECORD

@@ -1,25 +0,0 @@
-yirgacheffe/__init__.py,sha256=U5AoPk_iWreSCexG2ID-tmSXiJz4_9Lvzbf42DMvT7k,658
-yirgacheffe/constants.py,sha256=WccPcISG1FqL_Kw1tI72BJGjHy6RvEcGEx_I9RK776U,42
-yirgacheffe/h3layer.py,sha256=MT2hm6n64hzHSeRPvjn-CwErru937ntKXbEU7CIlPSU,91
-yirgacheffe/operators.py,sha256=KIMYmRl0uJG9LYnmX_uwHhGNfCNOEZlfaXZU7kD1aL4,29081
-yirgacheffe/rounding.py,sha256=ggBG4lMyLMtHLW3dBxr3gBCcF2qhRrY5etZiFGlIoqA,2258
-yirgacheffe/window.py,sha256=0XZdwD4mz0bRU9eBhFY1Xk1hQt6FqCKp3BnUgxZup3c,5224
-yirgacheffe/backends/__init__.py,sha256=149-fg1PVXC36cgyuSZsU8SYOm65fzUmYN_MHZtEyrY,313
-yirgacheffe/backends/enumeration.py,sha256=pADawllxpW_hW-IVVvZpHWIKzvEMs9aaqfkZRD1zjnY,1003
-yirgacheffe/backends/mlx.py,sha256=3HSKU7ZU846trdxeVhPj2OPkFWrCxfbjB65-NpnmANQ,6097
-yirgacheffe/backends/numpy.py,sha256=qQYvff1oHIuGUimV04rcFyPxnwEf0acvVd3ijeom4T4,4015
-yirgacheffe/layers/__init__.py,sha256=GR_TJlhPKDK1212CG2T99X2FdBlNo_G8q2zQ6nJbiO4,1534
-yirgacheffe/layers/area.py,sha256=yIRXzeeLi3MMyuh4LG_VgZrKNWe5xwZgDGdgaoYRpP0,3805
-yirgacheffe/layers/base.py,sha256=vVxumZgFLTYXFtVxJEiBVV1QqtQWa5kwL10ckUF-ykE,11617
-yirgacheffe/layers/constant.py,sha256=5YWSdr48Cw3DhryLBx45PNnPi4NzcVuQVin_YmOSWTg,1426
-yirgacheffe/layers/group.py,sha256=2hRta24Mn5JwfDOB4-gJfroa_lVJSUFgSZ8FMeWy_FM,15127
-yirgacheffe/layers/h3layer.py,sha256=Cyrw_6nXc1a_Twsb0FfexKhHAbegKXStL3J5LLk2AX8,9687
-yirgacheffe/layers/rasters.py,sha256=8mAbH49RtKIoA3h9mxWNbPzo8NJWDSfoRPT7fpkTJ4I,12328
-yirgacheffe/layers/rescaled.py,sha256=kWJlu7DuUB3nRDt3VtbJKiqBDQb2Ba8xzIIXTvOGdK8,2945
-yirgacheffe/layers/vectors.py,sha256=JOqM7Ym53ZdxWKpBJac-opPp2N_ynMfet1Xtsi85dpM,15087
-yirgacheffe-1.3.4.dist-info/licenses/LICENSE,sha256=dNSHwUCJr6axStTKDEdnJtfmDdFqlE3h1NPCveqPfnY,757
-yirgacheffe-1.3.4.dist-info/METADATA,sha256=tKSbYq3ZonA4FTn9AeYFgAB9AcZOnMBdky7oZ_Vcz60,20496
-yirgacheffe-1.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-yirgacheffe-1.3.4.dist-info/entry_points.txt,sha256=j4KgHXbVGbGyfTySc1ypBdERpfihO4WNjppvCdE9HjE,52
-yirgacheffe-1.3.4.dist-info/top_level.txt,sha256=9DBFlKO2Ld3hG6TuE3qOTd3Tt8ugTiXil4AN4Wr9_y0,12
-yirgacheffe-1.3.4.dist-info/RECORD,,