RadGEEToolbox 1.7.0__tar.gz → 1.7.1__tar.gz

{radgeetoolbox-1.7.0 → radgeetoolbox-1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RadGEEToolbox
-Version: 1.7.0
+Version: 1.7.1
 Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 Home-page: https://github.com/radwinskis/RadGEEToolbox
 Author: Mark Radwin
@@ -43,7 +43,7 @@ Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox m
 
 Although similar packages exist (eemont, geetools, etc.), `RadGEEToolbox` extends functionality and provides cohesive, chainable methods for research oriented projects working with Landsat TM & OLI, Sentinel-1 SAR, and/or Sentinel-2 MSI datasets (Table 1). The ultimate goal of `RadGEEToolbox` is to make satellite image processing easier and faster for real world applications relying on the most commonly utilized remote sensing platforms.
 
-As of version `1.7.0`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
+As of version `1.7.1`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
 
 ***Table 1.*** *Comparison of functionality between RadGEEToolbox, eemont, and geetools.*
 
@@ -181,15 +181,15 @@ _____________
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.7.0 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.1 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.7.0
+pip install RadGEEToolbox==1.7.1
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.7.0 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.1 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -220,7 +220,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.7.0` printed as the version number.
+You should see `1.7.1` printed as the version number.
 
 ### Want to Visualize Data? Install These Too
 
@@ -322,6 +322,8 @@ Then, directly plot `water_area_time_series` using Matplotlib as shown below
 
 For details about Sentinel-1 SAR and Sentinel-2 MSI modules, and all other available Landsat or cross-module functions, please refer to the [RadGEEToolbox documentation](https://radgeetoolbox.readthedocs.io/en/latest/). You can also explore [`/Example Notebooks`](https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks) for more usage examples.
 
+> NOTE for those newer to Python: when you see ***`property`*** next to the function name in the [RadGEEToolbox documentation](https://radgeetoolbox.readthedocs.io/en/latest/), you do not need to add parentheses at the end of the function when calling the function. For example: ```my_image_collection.add_date_property``` calls the `add_date_property` property function upon the `my_image_collection` image collection - no parentheses needed. All other non-property functions require one or more arguments to be specified by the user, and will require the use of parentheses to define the function arguments.
+
 ________
 
 

{radgeetoolbox-1.7.0 → radgeetoolbox-1.7.1}/README.md

@@ -14,7 +14,7 @@ Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox m
 
 Although similar packages exist (eemont, geetools, etc.), `RadGEEToolbox` extends functionality and provides cohesive, chainable methods for research oriented projects working with Landsat TM & OLI, Sentinel-1 SAR, and/or Sentinel-2 MSI datasets (Table 1). The ultimate goal of `RadGEEToolbox` is to make satellite image processing easier and faster for real world applications relying on the most commonly utilized remote sensing platforms.
 
-As of version `1.7.0`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
+As of version `1.7.1`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
 
 ***Table 1.*** *Comparison of functionality between RadGEEToolbox, eemont, and geetools.*
 
@@ -152,15 +152,15 @@ _____________
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.7.0 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.1 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.7.0
+pip install RadGEEToolbox==1.7.1
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.7.0 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.1 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -191,7 +191,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.7.0` printed as the version number.
+You should see `1.7.1` printed as the version number.
 
 ### Want to Visualize Data? Install These Too
 
@@ -293,6 +293,8 @@ Then, directly plot `water_area_time_series` using Matplotlib as shown below
 
 For details about Sentinel-1 SAR and Sentinel-2 MSI modules, and all other available Landsat or cross-module functions, please refer to the [RadGEEToolbox documentation](https://radgeetoolbox.readthedocs.io/en/latest/). You can also explore [`/Example Notebooks`](https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks) for more usage examples.
 
+> NOTE for those newer to Python: when you see ***`property`*** next to the function name in the [RadGEEToolbox documentation](https://radgeetoolbox.readthedocs.io/en/latest/), you do not need to add parentheses at the end of the function when calling the function. For example: ```my_image_collection.add_date_property``` calls the `add_date_property` property function upon the `my_image_collection` image collection - no parentheses needed. All other non-property functions require one or more arguments to be specified by the user, and will require the use of parentheses to define the function arguments.
+
 ________
 
 

{radgeetoolbox-1.7.0 → radgeetoolbox-1.7.1}/RadGEEToolbox/GenericCollection.py

@@ -104,7 +104,7 @@ class GenericCollection:
 
     
     @staticmethod
-    def anomaly_fn(image, geometry, band_name=None, anomaly_band_name=None, replace=True):
+    def anomaly_fn(image, geometry, band_name=None, anomaly_band_name=None, replace=True, scale=None):
         """
         Calculates the anomaly of a singleband image compared to the mean of the singleband image.
 
@@ -132,16 +132,25 @@ class GenericCollection:
 
         image_to_process = image.select([band_name])
 
-        # Calculate the mean image of the provided collection.
+        image_scale = image_to_process.projection().nominalScale()
+
+        # If the user supplies a numeric scale (int/float), keep it; otherwise default to image projection scale.
+        scale_value = scale if scale is not None else image_scale  # Can be Python number or ee.Number
+
+        # Compute mean over geometry at chosen scale (scale_value may be ee.Number).
         mean_image = image_to_process.reduceRegion(
             reducer=ee.Reducer.mean(),
             geometry=geometry,
-            scale=30,
+            scale=scale_value,
             maxPixels=1e13
         ).toImage()
 
         # Compute the anomaly by subtracting the mean image from the input image.
-        anomaly_image = image_to_process.subtract(mean_image)
+        if scale is None:
+            anomaly_image = image_to_process.subtract(mean_image)
+        else:
+            anomaly_image = image_to_process.reproject(crs=image_to_process.projection(), scale=scale_value).subtract(mean_image)
+
         if anomaly_band_name is None:
             if band_name:
                 anomaly_image = anomaly_image.rename(band_name) 
@@ -152,9 +161,9 @@ class GenericCollection:
             anomaly_image = anomaly_image.rename(anomaly_band_name) 
         # return anomaly_image
         if replace:
-            return anomaly_image.copyProperties(image)
+            return anomaly_image.copyProperties(image).set('system:time_start', image.get('system:time_start'))
         else:
-            return image.addBands(anomaly_image, overwrite=True)
+            return image.addBands(anomaly_image, overwrite=True).copyProperties(image)
 
     @staticmethod
     def mask_via_band_fn(image, band_to_mask, band_for_mask, threshold, mask_above=False, add_band_to_original_image=False):
@@ -315,7 +324,7 @@ class GenericCollection:
 
         # Call to iterate the calculate_and_set_area function over the list of bands, starting with the original image
         final_image = ee.Image(bands.iterate(calculate_and_set_area, image))
-        return final_image
+        return final_image #.set('system:time_start', image.get('system:time_start'))
 
     def PixelAreaSumCollection(
         self, band_name, geometry, threshold=-1, scale=30, maxPixels=1e12, output_type='ImageCollection', area_data_export_path=None
@@ -329,11 +338,11 @@ class GenericCollection:
 
         Args:
             band_name (string or list of strings): name of band(s) (string) for calculating area. If providing multiple band names, pass as a list of strings.
-            geometry (ee.Geometry): ee.Geometry object denoting area to clip to for area calculation
+            geometry (ee.Geometry): ee.Geometry object denoting area to clip to for area calculation.
             threshold (float): integer threshold to specify masking of pixels below threshold (defaults to -1). If providing multiple band names, the same threshold will be applied to all bands. Best practice in this case is to mask the bands prior to passing to this function and leave threshold at default of -1.
-            scale (int): integer scale of image resolution (meters) (defaults to 30)
-            maxPixels (int): integer denoting maximum number of pixels for calculations
-            output_type (str): 'ImageCollection' to return an ee.ImageCollection, 'GenericCollection' to return a GenericCollection object (defaults to 'ImageCollection')
+            scale (int): integer scale of image resolution (meters) (defaults to 30).
+            maxPixels (int): integer denoting maximum number of pixels for calculations.
+            output_type (str): 'ImageCollection' or 'ee.ImageCollection' to return an ee.ImageCollection, 'GenericCollection' to return a GenericCollection object, or 'DataFrame', 'Pandas', 'pd', 'dataframe', 'df' to return a pandas DataFrame (defaults to 'ImageCollection').
             area_data_export_path (str, optional): If provided, the function will save the resulting area data to a CSV file at the specified path.
 
         Returns:
@@ -358,15 +367,41 @@ class GenericCollection:
 
         # If an export path is provided, the area data will be exported to a CSV file
         if area_data_export_path:
-            GenericCollection(collection=self._PixelAreaSumCollection).ExportProperties(property_names=band_name, file_path=area_data_export_path+'.csv')
+            GenericCollection(collection=self._PixelAreaSumCollection).ExportProperties(property_names=[band_name], file_path=area_data_export_path+'.csv')
 
         # Returning the result in the desired format based on output_type argument or raising an error for invalid input
-        if output_type == 'ImageCollection':
+        if output_type == 'ImageCollection' or output_type == 'ee.ImageCollection':
             return self._PixelAreaSumCollection
         elif output_type == 'GenericCollection':
             return GenericCollection(collection=self._PixelAreaSumCollection)
+        elif output_type == 'DataFrame' or output_type == 'Pandas' or output_type == 'pd' or output_type == 'dataframe' or output_type == 'df':
+            return GenericCollection(collection=self._PixelAreaSumCollection).ExportProperties(property_names=[band_name])
         else:
-            raise ValueError("output_type must be 'ImageCollection' or 'GenericCollection'")
+            raise ValueError("Incorrect `output_type`. The `output_type` argument must be one of the following: 'ImageCollection', 'ee.ImageCollection', 'GenericCollection', 'DataFrame', 'Pandas', 'pd', 'dataframe', or 'df'.")
+
+    @staticmethod
+    def add_month_property_fn(image):
+        """
+        Adds a numeric 'month' property to the image based on its date.
+
+        Args:
+            image (ee.Image): Input image.
+
+        Returns:
+            ee.Image: Image with the 'month' property added.
+        """
+        return image.set('month', image.date().get('month'))
+
+    @property
+    def add_month_property(self):
+        """
+        Adds a numeric 'month' property to each image in the collection.
+
+        Returns:
+            GenericCollection: A GenericCollection image collection with the 'month' property added to each image.
+        """
+        col = self.collection.map(GenericCollection.add_month_property_fn)
+        return GenericCollection(collection=col)
 
     def combine(self, other):
         """
@@ -480,6 +515,28 @@ class GenericCollection:
             dates = self._dates_list.getInfo()
             self._dates = dates
         return self._dates
+    
+    def remove_duplicate_dates(self, sort_by='system:time_start', ascending=True):
+        """
+        Removes duplicate images that share the same date, keeping only the first one encountered.
+        Useful for handling duplicate acquisitions or overlapping path/rows.
+        
+        Args:
+            sort_by (str): Property to sort by before filtering distinct dates. Defaults to 'system:time_start' which is a global property. 
+                    Take care to provide a property that exists in all images if using a custom property.
+            ascending (bool): Sort order. Defaults to True.
+
+        Returns:
+            GenericCollection: A new GenericCollection object with distinct dates.
+        """
+
+        # Sort the collection to ensure the "best" image comes first (e.g. least cloudy)
+        sorted_col = self.collection.sort(sort_by, ascending)
+        
+        # distinct() retains the first image for each unique value of the specified property
+        distinct_col = sorted_col.distinct('Date_Filter')
+        
+        return GenericCollection(collection=distinct_col)
 
     def ExportProperties(self, property_names, file_path=None):
         """
@@ -1565,24 +1622,24 @@ class GenericCollection:
         if classify_above_threshold:
             if mask_zeros:
                 col = self.collection.map(
-                    lambda image: image.select(band_name).gte(threshold).rename(band_name).updateMask(image.select(band_name).gt(0)).copyProperties(image)
+                    lambda image: image.select(band_name).gte(threshold).rename(band_name).updateMask(image.select(band_name).gt(0)).copyProperties(image).set('system:time_start', image.get('system:time_start'))
                 )
             else:
                 col = self.collection.map(
-                    lambda image: image.select(band_name).gte(threshold).rename(band_name).copyProperties(image)
+                    lambda image: image.select(band_name).gte(threshold).rename(band_name).copyProperties(image).set('system:time_start', image.get('system:time_start'))
                 )
         else:
             if mask_zeros:
                 col = self.collection.map(
-                    lambda image: image.select(band_name).lte(threshold).rename(band_name).updateMask(image.select(band_name).gt(0)).copyProperties(image)
+                    lambda image: image.select(band_name).lte(threshold).rename(band_name).updateMask(image.select(band_name).gt(0)).copyProperties(image).set('system:time_start', image.get('system:time_start'))
                 )
             else:
                 col = self.collection.map(
-                    lambda image: image.select(band_name).lte(threshold).rename(band_name).copyProperties(image)
+                    lambda image: image.select(band_name).lte(threshold).rename(band_name).copyProperties(image).set('system:time_start', image.get('system:time_start'))
                 )
         return GenericCollection(collection=col)
     
-    def anomaly(self, geometry, band_name=None, anomaly_band_name=None, replace=True):
+    def anomaly(self, geometry, band_name=None, anomaly_band_name=None, replace=True, scale=None):
         """
         Calculates the anomaly of each image in a collection compared to the mean of each image.
 
@@ -1596,6 +1653,7 @@ class GenericCollection:
             band_name (str, optional): A string representing the band name to be used for the output anomaly image. If not provided, the band name of the first band of the input image will be used.
             anomaly_band_name (str, optional): A string representing the band name to be used for the output anomaly image. If not provided, the band name of the first band of the input image will be used.
             replace (bool, optional): A boolean indicating whether to replace the original band with the anomaly band. If True, the output image will only contain the anomaly band. If False, the output image will retain all original bands and add the anomaly band. Default is True.
+            scale (int, optional): The scale (in meters) to use for the image reduction. If not provided, the nominal scale of the image will be used.
 
         Returns:
             GenericCollection: A GenericCollection where each image represents the anomaly (deviation from
@@ -1614,7 +1672,7 @@ class GenericCollection:
             else:
                 band_name = band_names.get(0).getInfo()
 
-        col = self.collection.map(lambda image: GenericCollection.anomaly_fn(image, geometry=geometry, band_name=band_name, anomaly_band_name=anomaly_band_name, replace=replace))
+        col = self.collection.map(lambda image: GenericCollection.anomaly_fn(image, geometry=geometry, band_name=band_name, anomaly_band_name=anomaly_band_name, replace=replace, scale=scale))
         return GenericCollection(collection=col)
     
     def mask_via_band(self, band_to_mask, band_for_mask, threshold=-1, mask_above=True, add_band_to_original_image=False):
@@ -2434,24 +2492,30 @@ class GenericCollection:
             ValueError: If input parameters are invalid.
             TypeError: If geometries input type is unsupported.
         """
+        # Create a local reference to the collection object to allow for modifications (like band selection) without altering the original instance
         img_collection_obj = self
+
+        # If a specific band is requested, select only that band
         if band:
             img_collection_obj = GenericCollection(collection=img_collection_obj.collection.select(band))
         else: 
+            # If no band is specified, default to using the first band of the first image in the collection
             first_image = img_collection_obj.image_grab(0)
             first_band = first_image.bandNames().get(0)
             img_collection_obj = GenericCollection(collection=img_collection_obj.collection.select([first_band]))
-        # Filter collection by dates if provided
+        
+        # If a list of dates is provided, filter the collection to include only images matching those dates
         if dates:
             img_collection_obj = GenericCollection(
                 collection=self.collection.filter(ee.Filter.inList('Date_Filter', dates))
             )
 
-        # Initialize variables
+        # Initialize variables to hold the standardized feature collection and coordinates
         features = None
         validated_coordinates = [] 
         
-        # Function to standardize feature names if no names are provided
+        # Define a helper function to ensure every feature has a standardized 'geo_name' property
+        # This handles features that might have different existing name properties or none at all
         def set_standard_name(feature):
             has_geo_name = feature.get('geo_name')
             has_name = feature.get('name')
@@ -2462,33 +2526,38 @@ class GenericCollection:
                 ee.Algorithms.If(has_index, has_index, 'unnamed_geometry')))
             return feature.set({'geo_name': new_name})
 
+        # Handle input: FeatureCollection or single Feature
         if isinstance(geometries, (ee.FeatureCollection, ee.Feature)):
             features = ee.FeatureCollection(geometries)
             if geometry_names:
                  print("Warning: 'geometry_names' are ignored when the input is an ee.Feature or ee.FeatureCollection.")
 
+        # Handle input: Single ee.Geometry
         elif isinstance(geometries, ee.Geometry):
              name = geometry_names[0] if (geometry_names and geometry_names[0]) else 'unnamed_geometry'
              features = ee.FeatureCollection([ee.Feature(geometries).set('geo_name', name)])
 
+        # Handle input: List (could be coordinates or ee.Geometry objects)
         elif isinstance(geometries, list):
             if not geometries: # Handle empty list case
                 raise ValueError("'geometries' list cannot be empty.")
             
-            # Case: List of coordinates
+            # Case: List of tuples (coordinates)
             if all(isinstance(i, tuple) for i in geometries):
                 validated_coordinates = geometries
+                # Generate default names if none provided
                 if geometry_names is None:
                     geometry_names = [f"Location_{i+1}" for i in range(len(validated_coordinates))]
                 elif len(geometry_names) != len(validated_coordinates):
                      raise ValueError("geometry_names must have the same length as the coordinates list.")
+                # Create features with buffers around the coordinates
                 points = [
                     ee.Feature(ee.Geometry.Point(coord).buffer(buffer_size), {'geo_name': str(name)})
                     for coord, name in zip(validated_coordinates, geometry_names)
                 ]
                 features = ee.FeatureCollection(points)
             
-            # Case: List of Geometries
+            # Case: List of ee.Geometry objects
             elif all(isinstance(i, ee.Geometry) for i in geometries):
                 if geometry_names is None:
                     geometry_names = [f"Geometry_{i+1}" for i in range(len(geometries))]
@@ -2503,6 +2572,7 @@ class GenericCollection:
             else:
                 raise TypeError("Input list must be a list of (lon, lat) tuples OR a list of ee.Geometry objects.")
 
+        # Handle input: Single tuple (coordinate)
         elif isinstance(geometries, tuple) and len(geometries) == 2:
             name = geometry_names[0] if geometry_names else 'Location_1'
             features = ee.FeatureCollection([
@@ -2511,39 +2581,48 @@ class GenericCollection:
         else:
             raise TypeError("Unsupported type for 'geometries'.")
         
+        # Apply the naming standardization to the created FeatureCollection
         features = features.map(set_standard_name)
 
+        # Dynamically retrieve the Earth Engine reducer based on the string name provided
         try:
             reducer = getattr(ee.Reducer, reducer_type)()
         except AttributeError:
             raise ValueError(f"Unknown reducer_type: '{reducer_type}'.")
 
+        # Define the function to map over the image collection
         def calculate_stats_for_image(image):
             image_date = image.get('Date_Filter')
+            # Calculate statistics for all geometries in 'features' for this specific image
             stats_fc = image.reduceRegions(
                 collection=features, reducer=reducer, scale=scale, tileScale=tileScale
             )
 
+            # Helper to ensure the result has the reducer property, even if masked
+            # If the property is missing (e.g., all pixels masked), set it to a sentinel value (-9999)
             def guarantee_reducer_property(f):
                 has_property = f.propertyNames().contains(reducer_type)
                 return ee.Algorithms.If(has_property, f, f.set(reducer_type, -9999))
+            
+            # Apply the guarantee check
             fixed_stats_fc = stats_fc.map(guarantee_reducer_property)
 
+            # Attach the image date to every feature in the result so we know which image it came from
             return fixed_stats_fc.map(lambda f: f.set('image_date', image_date))
 
+        # Map the calculation over the image collection and flatten the resulting FeatureCollections into one
         results_fc = ee.FeatureCollection(img_collection_obj.collection.map(calculate_stats_for_image)).flatten()
+        
+        # Convert the Earth Engine FeatureCollection to a pandas DataFrame (client-side operation)
         df = GenericCollection.ee_to_df(results_fc, remove_geom=True)
 
-        # Checking for issues
+        # Check for empty results or missing columns
         if df.empty: 
-            # print("No results found for the given parameters. Check if the geometries intersect with the images, if the dates filter is too restrictive, or if the provided bands are empty.")
-            # return df
             raise ValueError("No results found for the given parameters. Check if the geometries intersect with the images, if the dates filter is too restrictive, or if the provided bands are empty.")
         if reducer_type not in df.columns:
             print(f"Warning: Reducer '{reducer_type}' not found in results.")
-            # return df
 
-        # Get the number of rows before dropping nulls for a helpful message
+        # Filter out the sentinel values (-9999) which indicate failed reductions/masked pixels
         initial_rows = len(df)
         df.dropna(subset=[reducer_type], inplace=True)
         df = df[df[reducer_type] != -9999]
@@ -2551,9 +2630,18 @@ class GenericCollection:
         if dropped_rows > 0:
             print(f"Warning: Discarded {dropped_rows} results due to failed reductions (e.g., no valid pixels in geometry).")
 
-        # Reshape DataFrame to have dates as index and geometry names as columns
+        # Pivot the DataFrame so that each row represents a date and each column represents a geometry location
         pivot_df = df.pivot(index='image_date', columns='geo_name', values=reducer_type)
+        # Rename the column headers (geometry names) to include the reducer type 
+        pivot_df.columns = [f"{col}_{reducer_type}" for col in pivot_df.columns]
+        # Rename the index axis to 'Date' so it is correctly labeled when moved to a column later
         pivot_df.index.name = 'Date'
+        # Remove the name of the columns axis (which defaults to 'geo_name') so it doesn't appear as a confusing label in the final output
+        pivot_df.columns.name = None
+        # Reset the index to move the 'Date' index into a regular column and create a standard numerical index (0, 1, 2...)
+        pivot_df = pivot_df.reset_index(drop=False)
+
+        # If a file path is provided, save the resulting DataFrame to CSV
         if file_path:
             # Check if file_path ends with .csv and remove it if so for consistency
             if file_path.endswith('.csv'):

radgeetoolbox-1.7.1/RadGEEToolbox/GetPalette.py

@@ -0,0 +1,169 @@
+def get_palette(name):
+    """
+    Returns the color palette associated with the given name.
+
+    Args:
+        name (str): Options include:
+            - Scientific: 'viridis', 'plasma', 'inferno', 'magma', 'cividis', 'turbo', 'coolwarm', 'spectral'
+            - Sequential: 'blues', 'greens', 'reds', 'greys', 'oranges', 'purples'
+            - Diverging: 'rdylgn' (Red-Yellow-Green), 'rdylbu' (Red-Yellow-Blue), 'rdbu' (Red-White-Blue), 'brbg' (Brown-Blue-Green), 'piyg' (Pink-Yellow-Green)
+            - Domain Specific: 'dem' (Elevation), 'terrain' (Topography), 'ndvi' (Vegetation), 'ndwi' (Water), 'precipitation' (Rain/Snow), 'thermal' (Temperature), 'evapotranspiration' (ET)
+            - Custom/Legacy: 'algae', 'dense', 'haline', 'jet', 'matter', 'pubu', 'soft_blue_green_red', 'turbid', 'ylord', 'ocean'
+
+    Returns:
+        list: list of colors to be used for image visualization in GEE vis params
+
+    """
+    palettes = {
+        # --- Scientific / Perceptually Uniform ---
+        "viridis": [
+            "#440154", "#482475", "#414487", "#355f8d", "#2a788e", 
+            "#21918c", "#22a884", "#44bf70", "#7ad151", "#bddf26", "#fde725"
+        ],
+        "plasma": [
+            "#0d0887", "#46039f", "#7201a8", "#9c179e", "#bd3786", 
+            "#d8576b", "#ed7953", "#fb9f3a", "#fdc924", "#f0f921"
+        ],
+        "inferno": [
+            "#000004", "#160b39", "#420a68", "#6a176e", "#932667", 
+            "#bc3754", "#dd513a", "#f37819", "#fca50a", "#f6d746", "#fcffa4"
+        ],
+        "magma": [
+            "#000004", "#140e36", "#3b0f70", "#641a80", "#8c2981", 
+            "#b73779", "#de4968", "#f7705c", "#fe9f6d", "#fecf92", "#fcfdbf"
+        ],
+        "cividis": [
+            "#00204d", "#002c69", "#003989", "#184a8c", "#3f5b8a", 
+            "#5d6d85", "#78807f", "#969576", "#b4ab6a", "#d4c359", "#fdea45"
+        ],
+        "turbo": [
+            "#30123b", "#466be3", "#28bbec", "#32f298", "#a2fc3c", 
+            "#f2ea33", "#fe9b2d", "#e4460a", "#7a0403"
+        ],
+        "coolwarm": [
+            "#3d4c8a", "#6282ea", "#99baff", "#cdd9ec", "#eaf0e4", 
+            "#f4dcb8", "#e8ac80", "#d4654d", "#b2182b"
+        ],
+
+        # --- Sequential (ColorBrewer & Standard) ---
+        "blues": [
+            "#f7fbff", "#deebf7", "#c6dbef", "#9ecae1", "#6baed6", 
+            "#4292c6", "#2171b5", "#08519c", "#08306b"
+        ],
+        "greens": [
+            "#f7fcf5", "#e5f5e0", "#c7e9c0", "#a1d99b", "#74c476", 
+            "#41ab5d", "#238b45", "#006d2c", "#00441b"
+        ],
+        "reds": [
+            "#fff5f0", "#fee0d2", "#fcbba1", "#fc9272", "#fb6a4a", 
+            "#ef3b2c", "#cb181d", "#a50f15", "#67000d"
+        ],
+        "greys": [
+            "#ffffff", "#f0f0f0", "#d9d9d9", "#bdbdbd", "#969696", 
+            "#737373", "#525252", "#252525", "#000000"
+        ],
+        "oranges": [
+            "#fff5eb", "#fee6ce", "#fdd0a2", "#fdae6b", "#fd8d3c", 
+            "#f16913", "#d94801", "#a63603", "#7f2704"
+        ],
+        "purples": [
+            "#fcfbfd", "#efedf5", "#dadaeb", "#bcbddc", "#9e9ac8", 
+            "#807dba", "#6a51a3", "#54278f", "#3f007d"
+        ],
+
+        # --- Diverging ---
+        "spectral": [
+            "#9e0142", "#d53e4f", "#f46d43", "#fdae61", "#fee08b", 
+            "#ffffbf", "#e6f598", "#abdda4", "#66c2a5", "#3288bd", "#5e4fa2"
+        ],
+        "rdylgn": [
+            "#a50026", "#d73027", "#f46d43", "#fdae61", "#fee08b", 
+            "#ffffbf", "#d9ef8b", "#a6d96a", "#66bd63", "#1a9850", "#006837"
+        ],
+        "rdylbu": [
+            "#a50026", "#d73027", "#f46d43", "#fdae61", "#fee08b", 
+            "#ffffbf", "#e0f3f8", "#abd9e9", "#74add1", "#4575b4", "#313695"
+        ],
+        "rdbu": [
+            "#67001f", "#b2182b", "#d6604d", "#f4a582", "#fddbc7", 
+            "#f7f7f7", "#d1e5f0", "#92c5de", "#4393c3", "#2166ac", "#053061"
+        ],
+        "brbg": [
+            "#543005", "#8c510a", "#bf812d", "#dfc27d", "#f6e8c3", 
+            "#f5f5f5", "#c7eae5", "#80cdc1", "#35978f", "#01665e", "#003c30"
+        ],
+        "piyg": [
+            "#8e0152", "#c51b7d", "#de77ae", "#f1b6da", "#fde0ef", 
+            "#f7f7f7", "#e6f5d0", "#b8e186", "#7fbc41", "#4d9221", "#276419"
+        ],
+
+        # --- Domain Specific ---
+        "dem": [
+            "#006600", "#002200", "#fff700", "#ab7634", "#c4d0ff", "#ffffff"
+        ],  # Classic Green-Brown-White Elevation
+        "terrain": [
+            "#00A600", "#63C600", "#E6E600", "#E9BD3A", "#ECB176", 
+            "#EFC2B3", "#F2F2F2"
+        ],  # Alternative Terrain
+        "ndvi": [
+            "#FFFFFF", "#CE7E45", "#DF923D", "#F1B555", "#FCD163", "#99B718",
+            "#74A901", "#66A000", "#529400", "#3E8601", "#207401", "#056201",
+            "#004C00", "#023B01", "#012E01", "#011D01", "#011301"
+        ],  # Standard MODIS/Landsat NDVI ramp
+        "ndwi": [
+            "#ece7f2", "#d0d1e6", "#a6bddb", "#74a9cf", "#3690c0", 
+            "#0570b0", "#045a8d", "#023858"
+        ],  # Blue ramp for water
+        "precipitation": [
+            "#ffffff", "#00ffff", "#0000ff", "#00ff00", "#ffff00", 
+            "#ff0000", "#ff00ff"
+        ],  # Classic Precip: White-Blue-Green-Yellow-Red-Purple
+        "evapotranspiration": [
+            "#ffffff", "#fcd163", "#99b718", "#74a901", "#66a000", 
+            "#529400", "#3e8601", "#207401", "#056201", "#004c00"
+        ],  # Modeled on NDVI/Vegetation water use
+        "thermal": [
+            "#042333", "#2c3395", "#744992", "#b15f82", "#eb7958", 
+            "#fbb43d", "#e8fa5b"
+        ],
+
+        # --- Custom / Legacy from Original ---
+        "jet": [
+            "#00007F", "#002AFF", "#00D4FF", "#7FFF7F", "#FFD400", 
+            "#FF2A00", "#7F0000"
+        ],
+        "soft_blue_green_red": ["#deeaee", "#b1cbbb", "#eea29a", "#c94c4c"],
+        "algae": [
+            "#d7f9d0", "#a2d595", "#64b463", "#129450", "#126e45", 
+            "#1a482f", "#122414"
+        ],
+        "turbid": [
+            "#e9f6ab", "#d3c671", "#bf9747", "#a1703b", "#795338", 
+            "#4d392d", "#221f1b"
+        ],
+        "dense": [
+            "#e6f1f1", "#a2cee2", "#76a4e5", "#7871d5", "#7642a5", 
+            "#621d62", "#360e24"
+        ],
+        "matter": [
+            "#feedb0", "#f7b37c", "#eb7858", "#ce4356", "#9f2462", 
+            "#66185c", "#2f0f3e"
+        ],
+        "haline": [
+            "#2a186c", "14439c", "#206e8b", "#3c9387", "#5ab978", 
+            "#aad85c", "#fdef9a"
+        ],
+        "ylord": [
+            "#ffffcc", "#ffeda0", "#fed976", "#feb24c", "#fd8d3c", 
+            "#fc4e2a", "#e31a1c", "#bd0026", "#800026"
+        ],
+        "pubu": [
+            "#fff7fb", "#ece7f2", "#d0d1e6", "#a6bddb", "#74a9cf", 
+            "#3690c0", "#0570b0", "#045a8d", "#023858"
+        ][::-1],
+        "ocean": [
+            "#ffffd9", "#edf8b1", "#c7e9b4", "#7fcdbb", "#41b6c4",
+            "#1d91c0", "#225ea8", "#253494", "#081d58"
+        ],
+    }
+    return palettes.get(name, None)