RadGEEToolbox 1.7.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

RadGEEToolbox/VisParams.py

@@ -1,221 +1,139 @@
 import ee
 from .GetPalette import get_palette
 
-
 def get_visualization_params(
     satellite, index, min_val=None, max_val=None, palette=None, scaled_bands=False
 ):
     """
-    Function to define visualization paramaters for image visualization. Outputs an vis_params dictionary.
+    Function to define visualization parameters for image visualization. Outputs a vis_params dictionary.
 
     Args:
-        satellite (string): Denote satellite for visualization. Options: 'Landsat', 'landsat', 'Sentinel2', or 'sentinel2'
-        index (string): Multispectral index to visualize. Options: 'TrueColor', 'NDVI', 'NDWI', 'halite', 'gypsum', 'LST', 'NDTI', 'KIVU', or '2BDA'. NOTE: LST and KIVU is not available for Sentinel2, and 2BDA is not available for Landsat.
-        min_val (int or float): Optional override for minimum value to stretch raster
-        max_val (int or float): Optional override for maximum value to stretch raster
-        palette (string): Optional override for color palette used for image visualization. Must be from GetPalette.get_palette() function. Options: 'algae', 'dense', 'greens', 'haline', 'inferno', 'jet', 'matter', 'pubu', 'soft_blue_green_red', 'thermal', 'turbid', 'ylord'
+        satellite (str): Denote satellite/source for visualization.
+                         Options: 'Landsat', 'Sentinel2', 'Sentinel1', 'Generic' (for DEMs, Precip, etc.).
+                         Case-insensitive.
+        index (str): Multispectral index or band to visualize.
+                     Options include: 'TrueColor', 'NDVI', 'NDWI', 'MNDWI', 'EVI', 'SAVI', 'MSAVI', 'NDMI',
+                     'NBR', 'NDSI', 'halite', 'gypsum', 'LST', 'NDTI', 'KIVU', '2BDA', 'Elevation',
+                     'Precipitation', 'Evapotranspiration'.
+        min_val (int or float): Optional override for minimum value to stretch raster.
+        max_val (int or float): Optional override for maximum value to stretch raster.
+        palette (str or list): Optional override for color palette. Can be a list of hex codes or
+                               a string name from GetPalette (e.g., 'ndvi', 'viridis', 'magma').
+        scaled_bands (bool): If True, indicates that surface reflectance bands are scaled (0-1) rather than raw DNs. Defaults to False.
 
     Returns:
-        dictionary: vis_params dictionary to be used when visualizing an image on a map. Supplies min, max, band(s), and color palette (when appropriate).
+        dict: vis_params dictionary to be used when visualizing an image on a map. Supplies min, max, bands, and palette.
     """
-    # Define visualization parameters for various image types
-    if satellite == "Landsat" or satellite == "landsat":
-        if scaled_bands == False:
-            params_dict = {
-                "TrueColor": {"min": 0, "max": 30000, "bands": ["SR_B4", "SR_B3", "SR_B2"]},
-                "NDVI": {
-                    "min": 0,
-                    "max": 0.5,
-                    "bands": ["ndvi"],
-                    "palette": get_palette("greens"),
-                },
-                "NDWI": {
-                    "min": -0.2,
-                    "max": 0.2,
-                    "bands": ["ndwi"],
-                    "palette": get_palette("inferno"),
-                },
-                "halite": {
-                    "min": 0.1,
-                    "max": 0.5,
-                    "bands": ["halite"],
-                    "palette": get_palette("haline"),
-                },
-                "gypsum": {
-                    "min": 0.0,
-                    "max": 0.5,
-                    "bands": ["gypsum"],
-                    "palette": get_palette("ylord"),
-                },
-                "LST": {
-                    "min": 0,
-                    "max": 40,
-                    "bands": ["LST"],
-                    "palette": get_palette("thermal"),
-                },
-                "NDTI": {
-                    "min": -0.2,
-                    "max": 0.2,
-                    "bands": ["ndti"],
-                    "palette": get_palette("turbid"),
-                },
-                "KIVU": {
-                    "min": -0.5,
-                    "max": 0.2,
-                    "bands": ["kivu"],
-                    "palette": get_palette("algae"),
-                },
-            }
-        else:
-            params_dict = {
-                "TrueColor": {"min": 0, "max": 1, "bands": ["SR_B4", "SR_B3", "SR_B2"]},
-                "NDVI": {
-                    "min": 0,
-                    "max": 0.5,
-                    "bands": ["ndvi"],
-                    "palette": get_palette("greens"),
-                },
-                "NDWI": {
-                    "min": -0.2,
-                    "max": 0.2,
-                    "bands": ["ndwi"],
-                    "palette": get_palette("inferno"),
-                },
-                "halite": {
-                    "min": 0.1,
-                    "max": 0.5,
-                    "bands": ["halite"],
-                    "palette": get_palette("haline"),
-                },
-                "gypsum": {
-                    "min": 0.0,
-                    "max": 0.5,
-                    "bands": ["gypsum"],
-                    "palette": get_palette("ylord"),
-                },
-                "LST": {
-                    "min": 0,
-                    "max": 40,
-                    "bands": ["LST"],
-                    "palette": get_palette("thermal"),
-                },
-                "NDTI": {
-                    "min": -0.2,
-                    "max": 0.2,
-                    "bands": ["ndti"],
-                    "palette": get_palette("turbid"),
-                },
-                "KIVU": {
-                    "min": -0.5,
-                    "max": 0.2,
-                    "bands": ["kivu"],
-                    "palette": get_palette("algae"),
-                },
-            }
-    elif satellite == "Sentinel2" or satellite == "sentinel2":
-        if scaled_bands == False:
-            params_dict = {
-                "TrueColor": {"min": 0, "max": 3500, "bands": ["B4", "B3", "B2"]},
-                "NDVI": {
-                    "min": 0.5,
-                    "max": 0.9,
-                    "bands": ["ndvi"],
-                    "palette": get_palette("greens"),
-                },
-                "NDWI": {
-                    "min": -0.2,
-                    "max": 0.2,
-                    "bands": ["ndwi"],
-                    "palette": get_palette("inferno"),
-                },
-                "halite": {
-                    "min": 0.1,
-                    "max": 0.7,
-                    "bands": ["halite"],
-                    "palette": get_palette("haline"),
-                },
-                "gypsum": {
-                    "min": 0.0,
-                    "max": 0.7,
-                    "bands": ["gypsum"],
-                    "palette": get_palette("ylord"),
-                },
-                "NDTI": {
-                    "min": -0.2,
-                    "max": 0.5,
-                    "bands": ["ndti"],
-                    "palette": get_palette("turbid"),
-                },
-                "2BDA": {
-                    "min": 0.5,
-                    "max": 1.75,
-                    "bands": ["2BDA"],
-                    "palette": get_palette("algae"),
-                },
-            }
-        else:
-            params_dict = {
-                "TrueColor": {"min": 0, "max": 1, "bands": ["B4", "B3", "B2"]},
-                "NDVI": {
-                    "min": 0.5,
-                    "max": 0.9,
-                    "bands": ["ndvi"],
-                    "palette": get_palette("greens"),
-                },
-                "NDWI": {
-                    "min": -0.2,
-                    "max": 0.2,
-                    "bands": ["ndwi"],
-                    "palette": get_palette("inferno"),
-                },
-                "halite": {
-                    "min": 0.1,
-                    "max": 0.7,
-                    "bands": ["halite"],
-                    "palette": get_palette("haline"),
-                },
-                "gypsum": {
-                    "min": 0.0,
-                    "max": 0.7,
-                    "bands": ["gypsum"],
-                    "palette": get_palette("ylord"),
-                },
-                "NDTI": {
-                    "min": -0.2,
-                    "max": 0.5,
-                    "bands": ["ndti"],
-                    "palette": get_palette("turbid"),
-                },
-                "2BDA": {
-                    "min": 0.5,
-                    "max": 1.75,
-                    "bands": ["2BDA"],
-                    "palette": get_palette("algae"),
-                },
-            }
+    # Normalize input
+    satellite_lower = satellite.lower() if satellite else "generic"
+
+    # --- Landsat ---
+    if "landsat" in satellite_lower:
+        tc_min = 0
+        tc_max = 1 if scaled_bands else 30000
+        
+        params_dict = {
+            "TrueColor": {"min": tc_min, "max": tc_max, "bands": ["SR_B4", "SR_B3", "SR_B2"]},
+            "NDVI": {"min": 0, "max": 1, "bands": ["ndvi"], "palette": get_palette("ndvi")},
+            "NDWI": {"min": -0.5, "max": 0.5, "bands": ["ndwi"], "palette": get_palette("ndwi")},
+            "MNDWI": {"min": -0.5, "max": 0.5, "bands": ["mndwi"], "palette": get_palette("ndwi")},
+            "EVI": {"min": 0, "max": 1, "bands": ["evi"], "palette": get_palette("ndvi")},
+            "SAVI": {"min": 0, "max": 1, "bands": ["savi"], "palette": get_palette("ndvi")},
+            "MSAVI": {"min": 0, "max": 1, "bands": ["msavi"], "palette": get_palette("ndvi")},
+            "NDMI": {"min": -0.8, "max": 0.8, "bands": ["ndmi"], "palette": get_palette("ocean")},
+            "NBR": {"min": -0.5, "max": 1, "bands": ["nbr"], "palette": get_palette("magma")},
+            "NDSI": {"min": -0.5, "max": 1, "bands": ["ndsi"], "palette": get_palette("blues")},
+            "halite": {"min": 0.1, "max": 0.5, "bands": ["halite"], "palette": get_palette("haline")},
+            "gypsum": {"min": 0.0, "max": 0.5, "bands": ["gypsum"], "palette": get_palette("ylord")},
+            "LST": {"min": 0, "max": 40, "bands": ["LST"], "palette": get_palette("thermal")},
+            "NDTI": {"min": -0.2, "max": 0.2, "bands": ["ndti"], "palette": get_palette("turbid")},
+            "KIVU": {"min": -0.5, "max": 0.2, "bands": ["kivu"], "palette": get_palette("algae")},
+        }
+
+    # --- Sentinel-2 ---
+    elif "sentinel2" in satellite_lower:
+        tc_min = 0
+        tc_max = 1 if scaled_bands else 3500
+
+        params_dict = {
+            "TrueColor": {"min": tc_min, "max": tc_max, "bands": ["B4", "B3", "B2"]},
+            "NDVI": {"min": 0, "max": 1, "bands": ["ndvi"], "palette": get_palette("ndvi")},
+            "NDWI": {"min": -0.5, "max": 0.5, "bands": ["ndwi"], "palette": get_palette("ndwi")},
+            "MNDWI": {"min": -0.5, "max": 0.5, "bands": ["mndwi"], "palette": get_palette("ndwi")},
+            "EVI": {"min": 0, "max": 1, "bands": ["evi"], "palette": get_palette("ndvi")},
+            "SAVI": {"min": 0, "max": 1, "bands": ["savi"], "palette": get_palette("ndvi")},
+            "MSAVI": {"min": 0, "max": 1, "bands": ["msavi"], "palette": get_palette("ndvi")},
+            "NDMI": {"min": -0.8, "max": 0.8, "bands": ["ndmi"], "palette": get_palette("ocean")},
+            "NBR": {"min": -0.5, "max": 1, "bands": ["nbr"], "palette": get_palette("magma")},
+            "NDSI": {"min": -0.5, "max": 1, "bands": ["ndsi"], "palette": get_palette("blues")},
+            "halite": {"min": 0.1, "max": 0.7, "bands": ["halite"], "palette": get_palette("haline")},
+            "gypsum": {"min": 0.0, "max": 0.7, "bands": ["gypsum"], "palette": get_palette("ylord")},
+            "NDTI": {"min": -0.2, "max": 0.5, "bands": ["ndti"], "palette": get_palette("turbid")},
+            "2BDA": {"min": 0, "max": 2, "bands": ["2BDA"], "palette": get_palette("algae")},
+        }
+
+    # --- Sentinel-1 ---
+    elif "sentinel1" in satellite_lower:
+        params_dict = {
+            "VV": {"min": -25, "max": 0, "bands": ["VV"]},
+            "VH": {"min": -30, "max": -5, "bands": ["VH"]},
+            "HH": {"min": -25, "max": 0, "bands": ["HH"]},
+            "HV": {"min": -30, "max": -5, "bands": ["HV"]},
+            "RGB": {"min": [-20, -25, 1], "max": [0, -5, 15], "bands": ["VV", "VH", "VV/VH"]},
+        }
+
+    # --- Generic (DEM, Precipitation, ET, etc.) ---
+    elif "generic" in satellite_lower or satellite is None:
+        params_dict = {
+            "Elevation": {"min": 0, "max": 3000, "bands": ["elevation"], "palette": get_palette("dem")},
+            "DEM": {"min": 0, "max": 3000, "bands": ["elevation"], "palette": get_palette("dem")},
+            "Terrain": {"min": 0, "max": 3000, "bands": ["elevation"], "palette": get_palette("terrain")},
+            "Precipitation": {"min": 0, "max": 2000, "bands": ["precipitation"], "palette": get_palette("precipitation")},
+            "Evapotranspiration": {"min": 0, "max": 1000, "bands": ["et"], "palette": get_palette("evapotranspiration")},
+            "ET": {"min": 0, "max": 1000, "bands": ["et"], "palette": get_palette("evapotranspiration")},
+            "NDVI": {"min": 0, "max": 1, "bands": ["ndvi"], "palette": get_palette("ndvi")},
+            "NDWI": {"min": -0.5, "max": 0.5, "bands": ["ndwi"], "palette": get_palette("ndwi")},
+            "Temperature": {"min": 270, "max": 310, "bands": ["temperature"], "palette": get_palette("thermal")},
+        }
+
     else:
         raise ValueError(
-            "Incorrect definition of satellite. Options: 'Landsat', 'landsat', 'Sentinel2', or 'sentinel2'"
+            f"Incorrect definition of satellite '{satellite}'. Options: 'Landsat', 'Sentinel2', 'Sentinel1', or 'Generic'."
         )
 
-    # Get default visualization parameters for the given image name
+    # --- Retrieval & Override Logic ---
+    
+    # Get default params for the requested index
     params = params_dict.get(index, None)
     if params is None:
-        raise ValueError(
-            "Incorrect definition of index. Options: 'TrueColor', 'NDVI', 'NDWI', 'halite', 'gypsum', 'LST', 'NDTI', or 'KIVU'. Note LST is not available for Sentinel2"
-        )
+        # Fallback: If index isn't a known key, create a basic config assuming 'index' is the band name
+        # This makes the function flexible for unknown bands
+        params = {"bands": [index]}
+        # Default min/max/palette if creating a generic fallback (user overrides encouraged)
+        if min_val is None: params["min"] = 0
+        if max_val is None: params["max"] = 1
+        
+        print(f"Warning: Index '{index}' not explicitly defined for '{satellite}'. Using '{index}' as band name with default 0-1 stretch.")
 
-    # Override default values if provided by the user
+    # Override values if provided
     if min_val is not None:
         params["min"] = min_val
     if max_val is not None:
         params["max"] = max_val
+    
     if palette is not None:
-        # Check if palette is a string and get the palette list if it is
+        # If palette is a string name, look it up; otherwise assume it's a list of colors
         if isinstance(palette, str):
-            palette = get_palette(palette)
-            if palette is None:
-                raise ValueError(f"Palette {palette} not found.")
-        params["palette"] = palette
+            fetched_palette = get_palette(palette)
+            if fetched_palette is not None:
+                params["palette"] = fetched_palette
+            else:
+                # Assume user provided a custom string that isn't in our dictionary? 
+                # Actually, GEE usually expects a list. If it's a string not in our dict, 
+                # it might be a single hex code or error. 
+                # We'll assume it's a custom palette name we don't know, or just pass it through if valid.
+                pass
+        else:
+            params["palette"] = palette
 
     return params

RadGEEToolbox/__init__.py

@@ -1,4 +1,4 @@
-GenericCollection__version__ = "1.7.0"
+GenericCollection__version__ = "1.7.1"
 
 from .CollectionStitch import CollectionStitch, MosaicByDate
 from .GetPalette import get_palette

{radgeetoolbox-1.7.0.dist-info → radgeetoolbox-1.7.1.dist-info}/METADATA

@@ -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.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+RadGEEToolbox/CollectionStitch.py,sha256=dLRzJZLZ1QTJqqbWPElyTjxb1m0T_WuBTo6wNzcCXq4,3884
+RadGEEToolbox/GenericCollection.py,sha256=bzsywaoq3tdpmvLsICI_Te3nbgYQmcfVwir-Eo_7SHQ,136701
+RadGEEToolbox/GetPalette.py,sha256=Ve7vYzs0EYHZyvFwaB_k8FR4uo5RRDy4pcq7eBK9yM0,7145
+RadGEEToolbox/LandsatCollection.py,sha256=w8Y5FHZPEw6mGi_xzE9xtBQCmhe7wPmTICfU_dWLjEU,201214
+RadGEEToolbox/Sentinel1Collection.py,sha256=1fH4JgROjSD73nUhkfOw-erpnMCsAhhqpaHSNL99u1o,125353
+RadGEEToolbox/Sentinel2Collection.py,sha256=B8LWgCuzbpf9mGLcH4wnLx7jdjadbb0AisPnFFtTJvs,171072
+RadGEEToolbox/VisParams.py,sha256=ONjnJd83jfaM1r-hbtlcIxiBOGMoJGtdHF0mw1iaw5c,8183
+RadGEEToolbox/__init__.py,sha256=gIzVzpUzTD9_5lvvXNCD8aLx91FUBXUhVgUEDEV_534,623
+radgeetoolbox-1.7.1.dist-info/licenses/LICENSE.txt,sha256=5Xj9dwVkawz6d8zhCwJy0SmXvm0U4K_msJnOrkHLO1w,1089
+radgeetoolbox-1.7.1.dist-info/METADATA,sha256=krn1-S8sIElabSBRHHuORU6XJJmqG2DDy3aUxSIggEI,17504
+radgeetoolbox-1.7.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+radgeetoolbox-1.7.1.dist-info/top_level.txt,sha256=W2E520tugQoptDkhctKFbzsheL2l_DyYLKqKXkD9G_E,14
+radgeetoolbox-1.7.1.dist-info/RECORD,,

radgeetoolbox-1.7.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-RadGEEToolbox/CollectionStitch.py,sha256=dLRzJZLZ1QTJqqbWPElyTjxb1m0T_WuBTo6wNzcCXq4,3884
-RadGEEToolbox/GenericCollection.py,sha256=jEges6kTn4JXA7dBLrByYhKVli4LIlMS3ndh4ME6xNg,130817
-RadGEEToolbox/GetPalette.py,sha256=YpAE9lzI5aXWHJKs1SXwZ62e8nKo8zfjKSpz5oJQSA8,2872
-RadGEEToolbox/LandsatCollection.py,sha256=Zc0vlFoCE7UuhBKSODpOIEC3oG4RmdJEXFnedSnK6B8,178197
-RadGEEToolbox/Sentinel1Collection.py,sha256=w18ebXjhgBgh2_ZBbThd1xlT-C3gGtREFUpcqWlbdh0,93333
-RadGEEToolbox/Sentinel2Collection.py,sha256=V1N8q4sk_GvoJUUonEcBYEvHI4beTaNFl2GBbG03ozY,147513
-RadGEEToolbox/VisParams.py,sha256=4aQV4l_IA-CjMBUXYDDLQ2fQyA3USSRN0A3VY07dGQ8,8571
-RadGEEToolbox/__init__.py,sha256=ISa20_SfGMR-B4GMsoRMhi8QJF6rSEjOfxR8fwKSt90,623
-radgeetoolbox-1.7.0.dist-info/licenses/LICENSE.txt,sha256=5Xj9dwVkawz6d8zhCwJy0SmXvm0U4K_msJnOrkHLO1w,1089
-radgeetoolbox-1.7.0.dist-info/METADATA,sha256=97vdZE6HZfatWd-Tu0kUUxncYEO-_i8yFUITNaiOZyk,16891
-radgeetoolbox-1.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-radgeetoolbox-1.7.0.dist-info/top_level.txt,sha256=W2E520tugQoptDkhctKFbzsheL2l_DyYLKqKXkD9G_E,14
-radgeetoolbox-1.7.0.dist-info/RECORD,,