Add tags to properties and API

GlacioHack · Nov 20, 2024 · 5c4471b · 5c4471b
1 parent 4c35303
commit 5c4471b
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 10 deletions.
diff --git a/doc/source/api.md b/doc/source/api.md
@@ -37,7 +37,7 @@ documentation.
 
 (api-raster-attrs)=
 
-### Unique attributes
+### Main attributes
 
 ```{eval-rst}
 .. autosummary::
@@ -60,16 +60,25 @@ documentation.
     Raster.height
     Raster.width
     Raster.count
-    Raster.count_on_disk
     Raster.bands
-    Raster.bands_on_disk
     Raster.res
     Raster.bounds
     Raster.dtype
+```
+
+### Other attributes
+
+```{eval-rst}
+.. autosummary::
+    :toctree: gen_modules/
+
+    Raster.count_on_disk
+    Raster.bands_on_disk
     Raster.is_loaded
     Raster.is_modified
     Raster.name
     Raster.driver
+    Raster.tags
 ```
 
 (api-geo-handle)=
@@ -259,7 +268,7 @@ And reverse operations.
     Vector.info
 ```
 
-### Unique attributes
+### Main attributes
 
 ```{eval-rst}
 .. autosummary::

diff --git a/examples/io/open_save/read_satimg.py b/examples/io/open_save/read_satimg.py
@@ -1,6 +1,6 @@
 """
 Parsing sensor metadata
-======================
+=======================
 
 This example demonstrates the instantiation of a raster while parsing image sensor metadata.
 """

diff --git a/geoutils/raster/raster.py b/geoutils/raster/raster.py
@@ -371,7 +371,7 @@ def __init__(
         self._driver: str | None = None
         self._name: str | None = None
         self.filename: str | None = None
-        self.tags: dict[str, Any] = {}
+        self._tags: dict[str, Any] = {}
 
         self._data: MArrayNum | None = None
         self._transform: affine.Affine | None = None
@@ -394,6 +394,7 @@ def __init__(
         # This is for Raster.from_array to work.
         if isinstance(filename_or_dataset, dict):
 
+            self.tags = filename_or_dataset["tags"]
             # To have "area_or_point" user input go through checks of the set() function without shifting the transform
             self.set_area_or_point(filename_or_dataset["area_or_point"], shift_area_or_point=False)
 
@@ -411,7 +412,7 @@ def __init__(
             self.crs: rio.crs.CRS = filename_or_dataset["crs"]
 
             for key in filename_or_dataset:
-                if key in ["data", "transform", "crs", "nodata", "area_or_point"]:
+                if key in ["data", "transform", "crs", "nodata", "area_or_point", "tags"]:
                     continue
                 setattr(self, key, filename_or_dataset[key])
             return
@@ -447,11 +448,11 @@ def __init__(
                 self._nodata = ds.nodata
                 self._name = ds.name
                 self._driver = ds.driver
-                self.tags.update(ds.tags())
+                self._tags.update(ds.tags())
 
                 # For tags saved from sensor metadata, convert from string to practical type (datetime, etc)
                 converted_tags = decode_sensor_metadata(self.tags)
-                self.tags.update(converted_tags)
+                self._tags.update(converted_tags)
 
                 self._area_or_point = self.tags.get("AREA_OR_POINT", None)
 
@@ -517,7 +518,7 @@ def __init__(
         # Parse metadata and add to tags
         if parse_sensor_metadata and self.filename is not None:
             sensor_meta = parse_and_convert_metadata_from_filename(self.filename, silent=silent)
-            self.tags.update(sensor_meta)
+            self._tags.update(sensor_meta)
 
     @property
     def count_on_disk(self) -> None | int:
@@ -1813,6 +1814,25 @@ def crs(self, new_crs: CRS | int | str | None) -> None:
         new_crs = CRS.from_user_input(value=new_crs)
         self._crs = new_crs
 
+    @property
+    def tags(self) -> dict[str, Any]:
+        """
+        Metadata tags of the raster.
+
+        :returns: Dictionary of raster metadata, potentially including sensor information.
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, new_tags: dict[str, Any] | None) -> None:
+        """
+        Set the metadata tags of the raster.
+        """
+
+        if new_tags is None:
+            new_tags = {}
+        self._tags = new_tags
+
     def set_mask(self, mask: NDArrayBool | Mask) -> None:
         """
         Set a mask on the raster array.
@@ -3853,6 +3873,7 @@ def proximity(
                 "crs": self.crs,
                 "nodata": self.nodata,
                 "area_or_point": self.area_or_point,
+                "tags": self.tags,
             }
         )
         return raster.proximity(