RadGEEToolbox 1.6.3__tar.gz → 1.6.5__tar.gz

{radgeetoolbox-1.6.3 → radgeetoolbox-1.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RadGEEToolbox
-Version: 1.6.3
+Version: 1.6.5
 Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 Home-page: https://github.com/radwinskis/RadGEEToolbox
 Author: Mark Radwin
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: GIS
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: earthengine-api
@@ -41,6 +41,23 @@ Dynamic: requires-python
 
 Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox minimizes repetitive scripting, accelerates common remote sensing workflows, and aims to maximize efficiency within the constraints of the Google Earth Engine API. Whether you’re building a time series of vegetation indices or extracting surface properties along transects, this package helps get results faster.
 
+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.
+
+***Table 1.*** *Comparison of functionality between RadGEEToolbox, eemont, and geetools.*
+
+| Capability | **RadGEEToolbox** | **eemont** | **geetools** |
+|---|:---:|:---:|:---:|
+| **Dataset & Workflow Specific API's** | **YES** | NO | NO |
+| **Synthetic Aperture Radar (S1) Support** | **YES** | NO | NO |
+| **Zonal Time-series Extraction** | **YES** | **YES** | **YES** |
+| **Area Time-series Extraction** | **YES** | NO | NO |
+| **Transect Time-series Extraction** | **YES** | NO | NO |
+| **Comprehensive Preprocessing Operations** | **YES** | **YES** | **YES** |
+| **Reflectance Scaling (DN to ρ)** | **YES** | **YES** | **YES** |
+| **Land Surface Temperature Calculation (Landsat)** | **YES** | NO | NO |
+| **Image Selection by Date or Index** | **YES** | **YES** | NO |
+| **Visualization Presets/Tools** | **YES** | NO | NO |
+
 _________
 ## Getting Started with Google Earth Engine
 
@@ -116,6 +133,8 @@ _________
 - Easy conversion between RadGEEToolbox and standard Earth Engine objects
 - Server-side–friendly workflows and caching for faster, scalable processing
 
+Features of `RadGEEToolbox` will be expanded in the future - if there is something you would like to see implemented in `RadGEEToolbox`, please open an issue or discussion on GitHub.
+
 🔍 For a full breakdown of available tools, see the [RadGEEToolbox documentation »](https://radgeetoolbox.readthedocs.io/en/latest/)
 
 _____________
@@ -124,21 +143,21 @@ _____________
 
 ### Prerequisites
 
-- **Python**: Ensure you have version 3.6 or higher installed.
+- **Python**: Ensure you have version 3.8 or higher installed.
 - **pip**: This is Python's package installer. 
 - **conda-forge**: Community led Conda package installer channel
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.6.3 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.5 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.6.3
+pip install RadGEEToolbox==1.6.5
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.6.3 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.5 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -169,7 +188,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.6.3` printed as the version number.
+You should see `1.6.5` printed as the version number.
 
 ### Want to Visualize Data? Install These Too
 

{radgeetoolbox-1.6.3 → radgeetoolbox-1.6.5}/README.md

@@ -12,6 +12,23 @@
 
 Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox minimizes repetitive scripting, accelerates common remote sensing workflows, and aims to maximize efficiency within the constraints of the Google Earth Engine API. Whether you’re building a time series of vegetation indices or extracting surface properties along transects, this package helps get results faster.
 
+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.
+
+***Table 1.*** *Comparison of functionality between RadGEEToolbox, eemont, and geetools.*
+
+| Capability | **RadGEEToolbox** | **eemont** | **geetools** |
+|---|:---:|:---:|:---:|
+| **Dataset & Workflow Specific API's** | **YES** | NO | NO |
+| **Synthetic Aperture Radar (S1) Support** | **YES** | NO | NO |
+| **Zonal Time-series Extraction** | **YES** | **YES** | **YES** |
+| **Area Time-series Extraction** | **YES** | NO | NO |
+| **Transect Time-series Extraction** | **YES** | NO | NO |
+| **Comprehensive Preprocessing Operations** | **YES** | **YES** | **YES** |
+| **Reflectance Scaling (DN to ρ)** | **YES** | **YES** | **YES** |
+| **Land Surface Temperature Calculation (Landsat)** | **YES** | NO | NO |
+| **Image Selection by Date or Index** | **YES** | **YES** | NO |
+| **Visualization Presets/Tools** | **YES** | NO | NO |
+
 _________
 ## Getting Started with Google Earth Engine
 
@@ -87,6 +104,8 @@ _________
 - Easy conversion between RadGEEToolbox and standard Earth Engine objects
 - Server-side–friendly workflows and caching for faster, scalable processing
 
+Features of `RadGEEToolbox` will be expanded in the future - if there is something you would like to see implemented in `RadGEEToolbox`, please open an issue or discussion on GitHub.
+
 🔍 For a full breakdown of available tools, see the [RadGEEToolbox documentation »](https://radgeetoolbox.readthedocs.io/en/latest/)
 
 _____________
@@ -95,21 +114,21 @@ _____________
 
 ### Prerequisites
 
-- **Python**: Ensure you have version 3.6 or higher installed.
+- **Python**: Ensure you have version 3.8 or higher installed.
 - **pip**: This is Python's package installer. 
 - **conda-forge**: Community led Conda package installer channel
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.6.3 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.5 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.6.3
+pip install RadGEEToolbox==1.6.5
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.6.3 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.5 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -140,7 +159,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.6.3` printed as the version number.
+You should see `1.6.5` printed as the version number.
 
 ### Want to Visualize Data? Install These Too
 

{radgeetoolbox-1.6.3 → radgeetoolbox-1.6.5}/RadGEEToolbox/CollectionStitch.py

@@ -1,7 +1,9 @@
 import ee
+
+
 def CollectionStitch(img_col1, img_col2, copy_properties_from=1):
     """
-    Function to mosaic two RadGEETools image collection objects which share image dates. 
+    Function to mosaic two RadGEETools image collection objects which share image dates.
     Mosaics are only formed for dates where both image collections have images. Server-side friendly.
     Returned image collection is an eeImageCollection object. NOTE this is different from the CollectionStitch function available in the LandsatCollection and SentinelCollection classes.
 
@@ -23,17 +25,24 @@ def CollectionStitch(img_col1, img_col2, copy_properties_from=1):
             filtered_col2 = img_col2.image_grab(img_col2.dates_list.index(date))
             merged_col = ee.ImageCollection.fromImages([filtered_col1, filtered_col2])
             if copy_properties_from == 1:
-                mosaic = merged_col.mosaic().copyProperties(filtered_col1)  # new collection images contain all image properties of the northern landsat image
+                mosaic = merged_col.mosaic().copyProperties(
+                    filtered_col1
+                )  # new collection images contain all image properties of the northern landsat image
             elif copy_properties_from == 2:
-                mosaic = merged_col.mosaic().copyProperties(filtered_col2)  # new collection images contain all image properties of the southern landsat image
+                mosaic = merged_col.mosaic().copyProperties(
+                    filtered_col2
+                )  # new collection images contain all image properties of the southern landsat image
             else:
-                raise ValueError("Invalid value for 'copy_properties_from'. Must be 1 or 2.")  # new collection images contain all image properties of the northern landsat image
+                raise ValueError(
+                    "Invalid value for 'copy_properties_from'. Must be 1 or 2."
+                )  # new collection images contain all image properties of the northern landsat image
             image_list.append(mosaic)
         else:
             None  # If the condition isn't met, do nothing and keep going through the list
     new_col = ee.ImageCollection.fromImages(image_list)
     return new_col
 
+
 def MosaicByDate(img_col):
     """
     Function to mosaic collection images that share the same date. Server-side friendly. Requires images to have date property of "Date_Filter"
@@ -45,20 +54,21 @@ def MosaicByDate(img_col):
         ee.ImageCollection: ee.ImageCollection with mosaiced imagery
     """
     input_collection = img_col
-# Function to mosaic images of the same date and accumulate them
+
+    # Function to mosaic images of the same date and accumulate them
     def mosaic_and_accumulate(date, list_accumulator):
         # date = ee.Date(date)
         list_accumulator = ee.List(list_accumulator)
-        date_filter = ee.Filter.eq('Date_Filter', date)
+        date_filter = ee.Filter.eq("Date_Filter", date)
         date_collection = input_collection.filter(date_filter)
-        
+
         # Create mosaic
-        mosaic = date_collection.mosaic().set('Date_Filter', date)
+        mosaic = date_collection.mosaic().set("Date_Filter", date)
 
         return list_accumulator.add(mosaic)
 
     # Get distinct dates
-    distinct_dates = input_collection.aggregate_array('Date_Filter').distinct()
+    distinct_dates = input_collection.aggregate_array("Date_Filter").distinct()
 
     # Initialize an empty list as the accumulator
     initial = ee.List([])
@@ -69,4 +79,4 @@ def MosaicByDate(img_col):
     new_col = ee.ImageCollection.fromImages(mosaic_list)
 
     # Convert the list of mosaics to an ImageCollection
-    return new_col
+    return new_col

radgeetoolbox-1.6.5/RadGEEToolbox/GetPalette.py

@@ -0,0 +1,120 @@
+def get_palette(name):
+    """
+    Returns the color palette associated with the given name.
+
+    Args:
+        name (str): options are 'algae', 'dense', 'greens', 'haline', 'inferno', 'jet', 'matter', 'pubu', 'soft_blue_green_red', 'thermal', 'turbid', 'ylord'
+
+    Returns:
+        list: list of colors to be used for image visualization in GEE vis params
+
+    """
+    palettes = {
+        "jet": [
+            "#00007F",
+            "#002AFF",
+            "#00D4FF",
+            "#7FFF7F",
+            "#FFD400",
+            "#FF2A00",
+            "#7F0000",
+        ],
+        "soft_blue_green_red": ["#deeaee", "#b1cbbb", "#eea29a", "#c94c4c"],
+        "inferno": [
+            "#000004",
+            "#320A5A",
+            "#781B6C",
+            "#BB3654",
+            "#EC6824",
+            "#FBB41A",
+            "#FCFFA4",
+        ],
+        "thermal": [
+            "#042333",
+            "#2c3395",
+            "#744992",
+            "#b15f82",
+            "#eb7958",
+            "#fbb43d",
+            "#e8fa5b",
+        ],
+        "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],
+        "greens": [
+            "#f7fcf5",
+            "#e5f5e0",
+            "#c7e9c0",
+            "#a1d99b",
+            "#74c476",
+            "#41ab5d",
+            "#238b45",
+            "#006d2c",
+            "#00441b",
+        ],
+    }
+    return palettes.get(name, None)