Merge branch 'main' into match-histogram

Author: 12rambau

docs/conf.py

@@ -20,7 +20,7 @@
 project = "geetools"
 author = "Rodrigo E. Principe"
 copyright = f"2017-{datetime.now().year}, {author}"
-release = "1.15.0"
+release = "1.16.0"
 
 # -- General configuration -----------------------------------------------------
 extensions = [

geetools/__init__.py

@@ -42,7 +42,7 @@
 __title__ = "geetools"
 __summary__ = "A set of useful tools to use with Google Earth Engine Python" "API"
 __uri__ = "http://geetools.readthedocs.io"
-__version__ = "1.15.0"
+__version__ = "1.16.0"
 
 __author__ = "Rodrigo E. Principe"
 __email__ = "fitoprincipe82@gmail.com"

geetools/_deprecated_algorithms.py

@@ -19,11 +19,7 @@ def distanceToMask(
     normalize=False,
 ):
     """Compute the distance to the mask in meters."""
-    return (
-        ee.Image(image)
-        .geetools.distanceToMask(mask, radius=radius, band_name=band_name)
-        .select(band_name)
-    )
+    return ee.Image(image).geetools.distanceToMask(mask, radius=radius, band_name=band_name).select(band_name)
 
 
 @deprecated(version="1.5.0", reason="Use ee.Image.geetools.maskCover instead.")

geetools/_deprecated_composite.py

@@ -44,9 +44,7 @@ def compositeRegularIntervals(
 
 
 @deprecated(version="1.5.0", reason="Use ee.ImageCollection.geetools.reduceInterval instead")
-def compositeByMonth(
-    collection, composite_function=None, composite_args=None, composite_kwargs=None
-):
+def compositeByMonth(collection, composite_function=None, composite_args=None, composite_kwargs=None):
     """Make a composite at regular intervals parsing a composite."""
     return ee.ImageCollection(collection).geetools.reduceInterval(unit="month")
 

geetools/ee_asset.py

@@ -77,10 +77,6 @@ def __hash__(self):
         """make the Asset object hashable."""
         return hash(self.as_posix())
 
-    def __getattr__(self, name):
-        """Return the attribute of the path object."""
-        return getattr(self, name)
-
     @classmethod
     def home(cls) -> Asset:
         """Return the root asset folder of the used cloud project.
@@ -467,9 +463,7 @@ def iterdir(self, recursive: bool = False) -> list:
         """
         # sanity check on variables
         if not (self.is_project() or self.is_folder() or self.is_image_collection()):
-            raise ValueError(
-                f"Asset {self.as_posix()} is not a container and cannot contain other assets."
-            )
+            raise ValueError(f"Asset {self.as_posix()} is not a container and cannot contain other assets.")
 
         # no need for recursion if recursive is false we directly return the result of th API call
         if recursive is False:

geetools/ee_dictionary.py

@@ -87,9 +87,7 @@ def getMany(self, list: list | ee.List) -> ee.List:
         """
         return ee.List(list).map(lambda key: self._obj.get(key))
 
-    def toTable(
-        self, valueType: Literal["dict", "list", "value"] = "value"
-    ) -> ee.FeatureCollection:
+    def toTable(self, valueType: Literal["dict", "list", "value"] = "value") -> ee.FeatureCollection:
         """Convert a :py:class:`ee.Dictionary` to a :py:class:`ee.FeatureCollection` with no geometries (table).
 
         There are 3 different type of values handled by this method:

geetools/ee_feature_collection.py

@@ -127,19 +127,15 @@ def toDictionary(
                 print(json.dumps(countries.getInfo(), indent=2))
         """
         uniqueIds = self._obj.aggregate_array(keyColumn)
-        selectors = (
-            ee.List(selectors) if selectors is not None else self._obj.first().propertyNames()
-        )
+        selectors = ee.List(selectors) if selectors is not None else self._obj.first().propertyNames()
         keyColumn = ee.String(keyColumn)
 
         features = self._obj.toList(self._obj.size())
         values = features.map(lambda feat: ee.Feature(feat).toDictionary(selectors))
         keys = uniqueIds.map(lambda uid: ee.String(ee.Algorithms.String(uid)))
         return ee.Dictionary.fromLists(keys, values)
 
-    def addId(
-        self, name: str | ee.String = "id", start: int | ee.Number = 1
-    ) -> ee.FeatureCollection:
+    def addId(self, name: str | ee.String = "id", start: int | ee.Number = 1) -> ee.FeatureCollection:
         """Add a unique numeric identifier, starting from parameter ``start``.
 
         Args:
@@ -226,6 +222,35 @@ def mergeGeometries(self, maxError: float | int | ee.Number | None = None) -> ee
         union = self._obj.iterate(lambda f, g: f.geometry().union(g, maxError=maxError), first)
         return ee.Geometry(union).dissolve(maxError=maxError)
 
+    def columnNames(self) -> ee.List:
+        """Get the name of the columns (Feature's properties).
+
+        get a flatten list of all the columns names in the FeatureCollection including the ones that
+        are not in all features.
+
+        Returns:
+            A list of all the column names in the FeatureCollection.
+
+        Example:
+            .. jupyter-execute::
+
+                import ee, geetools
+                from geetools.utils import initialize_documentation
+
+                initialize_documentation()
+
+                fc = ee.FeatureCollection([
+                    ee.Feature(ee.Geometry.Point([0, 0]), {"name": "A", "value": 1}),
+                    ee.Feature(ee.Geometry.Point([1, 1]), {"name": "B", "value": 2, "extra": "extra_value"})
+                ])
+
+                column_names = fc.geetools.columnNames()
+                column_names.getInfo()
+        """
+        temp_property_name = "__geetools_properties__"
+        fc = self._obj.map(lambda feat: feat.set(temp_property_name, feat.propertyNames()))
+        return fc.aggregate_array(temp_property_name).flatten().distinct()
+
     def toPolygons(self) -> ee.FeatureCollection:
         """Drop any geometry that is not a Polygon or a multipolygon.
 
@@ -318,23 +343,19 @@ def byProperties(
         """
         # get all the id values, they must be string so we are forced to cast them manually
         # the default casting is broken from Python side: https://issuetracker.google.com/issues/329106322
-        features = self._obj.aggregate_array(featureId)
+        feats = self._obj.aggregate_array(featureId)
         isString = lambda i: ee.Algorithms.ObjectType(i).compareTo("String").eq(0)  # noqa: E731
-        features = features.map(lambda i: ee.Algorithms.If(isString(i), i, ee.Number(i).format()))
+        feats = feats.map(lambda i: ee.Algorithms.If(isString(i), i, ee.Number(i).format()))
 
         # retrieve properties for each feature
-        properties = (
-            ee.List(properties) if properties is not None else self._obj.first().propertyNames()
-        )
-        properties = properties.remove(featureId)
-        values = properties.map(
-            lambda p: ee.Dictionary.fromLists(features, self._obj.aggregate_array(p))
-        )
+        eeProps = self._obj.first().propertyNames() if properties is None else ee.List(properties)
+        eeProps = eeProps.remove(featureId)
+        values = eeProps.map(lambda p: ee.Dictionary.fromLists(feats, self._obj.aggregate_array(p)))
 
         # get the label to use in the dictionary if requested
-        labels = ee.List(labels) if labels is not None else properties
+        eeLabels = eeProps if labels is None else ee.List(labels)
 
-        return ee.Dictionary.fromLists(labels, values)
+        return ee.Dictionary.fromLists(eeLabels, values)
 
     def byFeatures(
         self,
@@ -459,11 +480,7 @@ def plot_by_features(
                     label.set_rotation(45)
         """
         # Get the features and properties
-        props = (
-            ee.List(properties)
-            if properties is not None
-            else self._obj.first().propertyNames().getInfo()
-        )
+        props = ee.List(properties) if properties is not None else self._obj.first().propertyNames().getInfo()
         props = props.remove(featureId)
 
         # get the data from server

geetools/ee_image.py

@@ -71,9 +71,7 @@ def addDate(self, format: str | ee.String = "") -> ee.Image:
 
         return self._obj.addBands(dateBand)
 
-    def addSuffix(
-        self, suffix: str | ee.String, bands: list[str] | ee.List | None = None
-    ) -> ee.Image:
+    def addSuffix(self, suffix: str | ee.String, bands: list[str] | ee.List | None = None) -> ee.Image:
         """Add a suffix to the image selected band.
 
         Add a suffix to the selected band. If no band is specified, the suffix is added to all bands.
@@ -97,16 +95,12 @@ def addSuffix(
                 print(image.bandNames().getInfo())
         """
         suffix = ee.String(suffix)
-        bands = ee.List(bands) if bands is not None else self._obj.bandNames()
-        bandNames = bands.iterate(
-            lambda b, n: ee.List(n).replace(b, ee.String(b).cat(suffix)),
-            self._obj.bandNames(),
-        )
+        srcBands = self._obj.bandNames()
+        eeBands = srcBands if bands is None else ee.List(bands)
+        bandNames = eeBands.iterate(lambda b, n: ee.List(n).replace(b, ee.String(b).cat(suffix)), srcBands)
         return self._obj.rename(bandNames)
 
-    def addPrefix(
-        self, prefix: str | ee.String, bands: list[str] | ee.List | None = None
-    ) -> ee.Image:
+    def addPrefix(self, prefix: str | ee.String, bands: list[str] | ee.List | None = None) -> ee.Image:
         """Add a prefix to the image selected band.
 
         Add a prefix to the selected band. If no band is specified, the prefix is added to all bands.
@@ -130,11 +124,9 @@ def addPrefix(
                 print(image.bandNames().getInfo())
         """
         prefix = ee.String(prefix)
-        bands = ee.List(bands) if bands is not None else self._obj.bandNames()
-        bandNames = bands.iterate(
-            lambda b, n: ee.List(n).replace(b, prefix.cat(ee.String(b))),
-            self._obj.bandNames(),
-        )
+        srcBands = self._obj.bandNames()
+        eeBands = srcBands if bands is None else ee.List(bands)
+        bandNames = eeBands.iterate(lambda b, n: ee.List(n).replace(b, prefix.cat(ee.String(b))), srcBands)
         return self._obj.rename(bandNames)
 
     def rename(self, names: dict | ee.Dictionary) -> ee.Image:
@@ -162,9 +154,7 @@ def rename(self, names: dict | ee.Dictionary) -> ee.Image:
                 print(image.bandNames().getInfo())
         """
         names = ee.Dictionary(names)
-        bands = names.keys().iterate(
-            lambda b, n: ee.List(n).replace(b, names.get(b)), self._obj.bandNames()
-        )
+        bands = names.keys().iterate(lambda b, n: ee.List(n).replace(b, names.get(b)), self._obj.bandNames())
         return self._obj.rename(bands)
 
     def remove(self, bands: list[str] | ee.List) -> ee.Image:
@@ -228,9 +218,7 @@ def doyToDate(
 
         doyList = ee.List.sequence(0, 365)
         remapList = doyList.map(
-            lambda d: ee.Number.parse(
-                ee.Date.fromYMD(year, 1, 1).advance(d, "day").format(dateFormat)
-            )
+            lambda d: ee.Number.parse(ee.Date.fromYMD(year, 1, 1).advance(d, "day").format(dateFormat))
         )
         return self._obj.remap(doyList, remapList, bandName=band).rename(band)
 
@@ -361,9 +349,7 @@ def toGrid(
         index = ee.List.sequence(0, lat.size().subtract(2))
         squares = index.map(
             lambda i: (
-                ee.Geometry.Point([lon.get(i), lat.get(i)])
-                .buffer(size.divide(2))
-                .bounds(0.01, projection)
+                ee.Geometry.Point([lon.get(i), lat.get(i)]).buffer(size.divide(2)).bounds(0.01, projection)
             )
         )
 
@@ -402,9 +388,7 @@ def clipOnCollection(
 
         def fcClip(feat):
             image = self._obj.clip(feat.geometry())
-            return ee.Algorithms.If(
-                ee.Number(keepProperties).toInt(), image.copyProperties(feat), image
-            )
+            return ee.Algorithms.If(ee.Number(keepProperties).toInt(), image.copyProperties(feat), image)
 
         return ee.ImageCollection(fc.map(fcClip))
 
@@ -469,18 +453,18 @@ def full(
                 image = ee.Image.geetools.full([1, 2, 3], ['a', 'b', 'c'])
                 print(image.bandNames().getInfo())
         """
-        values = ee.List(values) if values is not None else ee.List([0])
-        names = ee.List(names) if names is not None else ee.List(["constant"])
+        eeValues = ee.List([0]) if values is None else ee.List(values)
+        eeNames = ee.List(["constant"]) if names is None else ee.List(names)
 
         # resize value to the same length as names
-        values = ee.List(
+        eeValues = ee.List(
             ee.Algorithms.If(
-                values.size().eq(1),
-                ee.List.repeat(ee.Number(values.get(0)), names.size()),
-                values,
+                eeValues.size().eq(1),
+                ee.List.repeat(ee.Number(eeValues.get(0)), eeNames.size()),
+                eeValues,
             )
         )
-        return ee.Image.constant(values).rename(names)
+        return ee.Image.constant(eeValues).rename(eeNames)
 
     def fullLike(
         self,
@@ -574,12 +558,12 @@ def reduceBands(
         if not isinstance(reducer, str):
             raise TypeError("reducer must be a Python string")
 
-        bands = ee.List(bands) if bands is not None else ee.List([])
+        eeBands = ee.List(bands) if bands is not None else ee.List([])
         name = ee.String(name)
-        bands = ee.Algorithms.If(bands.size().eq(0), self._obj.bandNames(), bands)
+        eeBands = ee.Algorithms.If(eeBands.size().eq(0), self._obj.bandNames(), eeBands)
         name = ee.Algorithms.If(name.equals(ee.String("")), reducer, name)
         red = getattr(ee.Reducer, reducer)() if isinstance(reducer, str) else reducer
-        reduceImage = self._obj.select(ee.List(bands)).reduce(red).rename([name])
+        reduceImage = self._obj.select(ee.List(eeBands)).reduce(red).rename([name])
         return self._obj.addBands(reduceImage)
 
     def negativeClip(self, geometry: ee.Geometry | ee.Feature | ee.FeatureCollection) -> ee.Image:
@@ -827,9 +811,7 @@ def isletMask(self, offset: float | int | ee.Number) -> ee.Image:
         scale = self._obj.projection().nominalScale()
         pixelsLimit = offset.multiply(2).sqrt().divide(scale).max(ee.Number(2)).toInt()
         area = ee.Image.pixelArea().rename("area")
-        isletArea = (
-            self._obj.select(0).mask().toInt().connectedPixelCount(pixelsLimit).multiply(area)
-        )
+        isletArea = self._obj.select(0).mask().toInt().connectedPixelCount(pixelsLimit).multiply(area)
         return isletArea.lt(offset).rename("mask").selfMask()
 
     # -- ee-extra wrapper ------------------------------------------------------
@@ -1119,7 +1101,7 @@ def getDOI(self) -> str:
         """
         stac = self.getSTAC()
         error_msg = "DOI not found in the STAC"
-        return stac["sci:doi"] if "sci:doi" in stac else error_msg
+        return stac.get("sci:doi", error_msg)
 
     def getCitation(self) -> str:
         """Gets the citation of the image, if available.
@@ -1142,7 +1124,7 @@ def getCitation(self) -> str:
         """
         stac = self.getSTAC()
         error_msg = "Citation not found in the STAC"
-        return stac["sci:citation"] if "sci:citation" in stac else error_msg
+        return stac.get("sci:citation", error_msg)
 
     def panSharpen(self, method: str = "SFIM", qa: str = "", **kwargs) -> ee.Image:
         """Apply panchromatic sharpening to the Image.