PyPI - RadGEEToolbox - Versions diffs - 1.6.1__tar.gz → 1.6.2__tar.gz - Mend

RadGEEToolbox 1.6.1tar.gz → 1.6.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RadGEEToolbox
-Version: 1.6.1
+Version: 1.6.2
 Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 Home-page: https://github.com/radwinskis/RadGEEToolbox
 Author: Mark Radwin
@@ -67,15 +67,15 @@ _____________
 ### Installing via pip
-To install `RadGEEToolbox` version 1.6.1 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.2 using pip (NOTE: it is recommended to create a new virtual environment):
 ```bash
-pip install RadGEEToolbox==1.6.1
+pip install RadGEEToolbox==1.6.2
 ```
 ### Installing via Conda
-To install `RadGEEToolbox` version 1.6.1 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.2 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -106,7 +106,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
-You should see `1.6.1` printed as the version number.
+You should see `1.6.2` printed as the version number.
 ________
 # Usage Example

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/README.md RENAMED Viewed

@@ -38,15 +38,15 @@ _____________
 ### Installing via pip
-To install `RadGEEToolbox` version 1.6.1 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.2 using pip (NOTE: it is recommended to create a new virtual environment):
 ```bash
-pip install RadGEEToolbox==1.6.1
+pip install RadGEEToolbox==1.6.2
 ```
 ### Installing via Conda
-To install `RadGEEToolbox` version 1.6.1 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.2 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -77,7 +77,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
-You should see `1.6.1` printed as the version number.
+You should see `1.6.2` printed as the version number.
 ________
 # Usage Example

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/RadGEEToolbox/LandsatCollection.py RENAMED Viewed

@@ -3,221 +3,50 @@ import pandas as pd
 import numpy as np
 class LandsatCollection:
     """
-    Class object representing a combined collection of NASA/USGS Landsat 5, 8, and 9 TM & OLI surface reflectance satellite images at 30 m/px from Google Earth Engine.
+    Represents a user-defined collection of NASA/USGS Landsat 5, 8, and 9 TM & OLI surface reflectance satellite images at 30 m/px from Google Earth Engine (GEE).
-    This class provides methods to filter, process, and analyze Landsat satellite imagery for a given period and region.
+    This class enables simplified definition, filtering, masking, and processing of multispectral Landsat imagery.
+    It supports multiple spatial and temporal filters, caching for efficient computation, and direct computation of
+    key spectral indices like NDWI, NDVI, halite index, and more. It also includes utilities for cloud masking,
+    mosaicking, zonal statistics, and transect analysis.
-    Inspect the documentation or source code for details on the methods and properties available.
-    Arguments:
-        start_date (str): Start date string in format of yyyy-mm-dd for filtering collection (required unless collection is provided)
-        end_date (str): End date string in format of yyyy-mm-dd for filtering collection (required unless collection is provided)
-        tile_row (int or list): WRS-2 tile row of Landsat image (required unless boundary or collection is provided) - see https://www.usgs.gov/landsat-missions/landsat-shapefiles-and-kml-files
+    Initialization can be done by providing filtering parameters or directly passing in a pre-filtered GEE collection.
-        tile_path (int or list): WRS-2 tile path of Landsat image (required unless boundary or collection is provided) - see https://www.usgs.gov/landsat-missions/landsat-shapefiles-and-kml-files
-        cloud_percentage_threshold (int): Integer percentage threshold where only imagery with cloud % less than threshold will be provided (defaults to 100)
+    Inspect the documentation or source code for details on the methods and properties available.
-        boundary (ee.Geometry): Boundary for filtering images to images that intersect with the boundary shape (optional) - will override tile specifications
-        collection (ee.ImageCollection): Optional argument to provide an ee.ImageCollection object to be converted to a LandsatCollection object - will override other arguments!
+    Args:
+        start_date (str): Start date in 'YYYY-MM-DD' format. Required unless `collection` is provided.
+        end_date (str): End date in 'YYYY-MM-DD' format. Required unless `collection` is provided.
+        tile_row (int or list of int): WRS-2 tile row(s) to filter by. Ignored if `boundary` or `collection` is provided. See https://www.usgs.gov/landsat-missions/landsat-shapefiles-and-kml-files
+        tile_path (int or list of int): WRS-2 tile row(s) to filter by. Ignored if `boundary` or `collection` is provided. See https://www.usgs.gov/landsat-missions/landsat-shapefiles-and-kml-files
+        cloud_percentage_threshold (int, optional): Max allowed cloud cover percentage. Defaults to 100.
+        boundary (ee.Geometry, optional): A geometry for filtering to images that intersect with the boundary shape. Overrides `tile_path` and `tile_row` if provided.
+        collection (ee.ImageCollection, optional): A pre-filtered Landsat ee.ImageCollection object to be converted to a LandsatCollection object. Overrides all other filters.
     Attributes:
-        collection: Returns an ee.ImageCollection object from any LandsatCollection image collection object
-        _dates_list: Cache storage for dates_list property attribute
-        _dates: Cahce storgage for dates property attribute
-        ndwi_threshold: Default threshold for masking ndwi imagery
-        ndvi_threshold: Default threshold for masking ndvi imagery
-        halite_threshold: Default threshold for masking halite imagery
-        gypsum_threshold: Default threshold for masking gypsum imagery
-        turbidity_threshold: Default threshold for masking turbidity imagery
-        chlorophyll_threshold: Default threshold for masking chlorophyll imagery
-        _masked_clouds_collection: Cache storage for masked_clouds_collection property attribute
-        _masked_water_collection: Cache storage for masked_water_collection property attribute
-        _masked_to_water_collection: Cache storage for masked_to_water_collection property attribute
-        _geometry_masked_collection: Cache storage for mask_to_polygon method
-        _geometry_masked_out_collection: Cache storage for mask_out_polygon method
-        _median: Cache storage for median property attribute
-        _mean: Cache storage for mean property attribute
-        _max: Cache storage for max property attribute
-        _min: Cache storage for min property attribute
-        _ndwi: Cache storage for ndwi property attribute
-        _ndvi: Cache storage for ndvi property attribute
-        _halite: Cache storage for halite property attribute
-        _gypsum: Cache storage for gypsum property attribute
-        _turbidity: Cache storage for turbidity property attribute
-        _chlorophyll: Cache storage for chlorophyll property attribute
-        _LST: Cache storage for LST property attribute
-        _MosaicByDate: Cache storage for MosaicByDate property attribute
-    Property attributes:
-        dates_list (returns: Server-Side List): Unreadable Earth Engine list of image dates (server-side)
-        dates (returns: Client-Side List): Readable pythonic list of image dates (client-side)
-        masked_clouds_collection (returns: LandsatCollection image collection): Returns collection with clouds masked (transparent) for each image
-        masked_water_collection (returns: LandsatCollection image collection): Returns collection with water pixels masked (transparent) for each image
-        masked_to_water_collection (returns: LandsatCollection image collection): Returns collection with pixels masked to water (transparent) for each image (masks land and cloud pixels)
-        max (returns: ee.Image): Returns a temporally reduced max image (calculates max at each pixel)
-        median (returns: ee.Image): Returns a temporally reduced median image (calculates median at each pixel)
-        mean (returns: ee.Image): Returns a temporally reduced mean image (calculates mean at each pixel)
-        min (returns: ee.Image): Returns a temporally reduced min image (calculates min at each pixel)
-        MosaicByDate (returns: LandsatCollection image collection): Mosaics image collection where images with the same date are mosaiced into the same image. Calculates total cloud percentage for subsequent filtering of cloudy mosaics.
-        gypsum (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband gypsum index rasters
-        halite (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband halite index rasters
-        LST (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband land-surface-temperature rasters (Celcius)
-        ndwi (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband NDWI (water) rasters
-        ndvi (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband NDVI (vegetation) rasters
-        turbidity (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband NDTI (turbidity) rasters
-        chlorophyll (returns: ee.ImageCollection): Returns LandsatCollection image collection of singleband KIVU (relative chlorophyll-a) rasters
-    Methods:
-        get_filtered_collection(self)
-        get_boundary_filtered_collection(self)
-        ndwi_collection(self, threshold, ng_threshold=None)
-        ndvi_collection(self, threshold, ng_threshold=None)
-        halite_collection(self, threshold, ng_threshold=None)
-        gypsum_collection(self, threshold, ng_threshold=None)
-        turbidity_collection(self, threshold, ng_threshold=None)
-        chlorophyll_collection(self, threshold, ng_threshold=None)
-        masked_water_collection_NDWI(self, threshold)
-        masked_to_water_collection_NDWI(self, threshold)
-        surface_temperature_collection(self)
-        mask_to_polygon(self, polygon)
-        mask_out_polygon(self, polygon)
-        mask_halite(self, threshold, ng_threshold=None)
-        mask_halite_and_gypsum(self, halite_threshold, gypsum_threshold, halite_ng_threshold=None, gypsum_ng_threshold=None)
-        PixelAreaSumCollection(self, band_name, geometry, threshold, scale, maxPixels)
-        image_grab(self, img_selector)
-        custom_image_grab(self, img_col, img_selector)
-        image_pick(self, img_date)
-        CollectionStitch(self, img_col2)
-        transect_iterator(self, lines, line_names, save_folder_path, reducer='mean', n_segments=None, dist_interval=30, to_pandas=True)
-        iterate_zonal_stats(self, coordinates, buffer_size=1, reducer_type='mean', scale=10, tileScale=1, coordinate_names=None, file_path=None, dates=None)
-    Static Methods:
-        image_dater(image)
-        landsat5bandrename(img)
-        landsat_ndwi_fn(image, threshold, ng_threshold=None)
-        landsat_ndvi_fn(image, threshold, ng_threshold=None)
-        landsat_halite_fn(image, threshold, ng_threshold=None)
-        landsat_gypsum_fn(image, threshold, ng_threshold=None)
-        landsat_ndti_fn(image, threshold, ng_threshold=None)
-        landsat_kivu_chla_fn(image, threshold, ng_threshold=None)
-        MaskWaterLandsat(image)
-        MaskToWaterLandsat(image)
-        MaskWaterLandsatByNDWI(image, threshold, ng_threshold=None)
-        MaskToWaterLandsatByNDWI(image, threshold, ng_threshold=None)
-        halite_mask(image, threshold, ng_threshold=None)
-        gypsum_and_halite_mask(image, halite_threshold, gypsum_threshold, halite_ng_threshold=None, gypsum_ng_threshold=None)
-        maskL8clouds(image)
-        temperature_bands(img)
-        landsat_LST(image)
-        PixelAreaSum(image, band_name, geometry, threshold=-1, scale=30, maxPixels=1e12)
-        dNDWIPixelAreaSum(image, geometry, band_name='ndwi', scale=30, maxPixels=1e12)
-        extract_transect(image, line, reducer="mean", n_segments=100, dist_interval=None, scale=None, crs=None, crsTransform=None, tileScale=1.0, to_pandas=False)
-        transect(image, lines, line_names, reducer='mean', n_segments=None, dist_interval=30, to_pandas=True)
-        extract_zonal_stats_from_buffer(image, coordinates, buffer_size=1, reducer_type='mean', scale=10, tileScale=1, coordinate_names=None)
-    Usage:
-        The LandsatCollection object alone acts as a base object for which to further filter or process to indices or spatial reductions
-        To use the LandsatCollection functionality, use any of the built in class attributes or method functions. For example, using class attributes:
-        image_collection = LandsatCollection(start_date, end_date, tile_row, tile_path, cloud_percentage_threshold)
-        ee_image_collection = image_collection.collection #returns ee.ImageCollection from provided argument filters
-        latest_image = image_collection.image_grab(-1) #returns latest image in collection as ee.Image
-        cloud_masked_collection = image_collection.masked_clouds_collection #returns cloud-masked LandsatCollection image collection
-        NDWI_collection = image_collection.ndwi #returns NDWI LandsatCollection image collection
-        latest_NDWI_image = NDWI_collection.image_grab(-1) #Example showing how class functions work with any LandsatCollection image collection object, returning latest ndwi image
+        collection (ee.ImageCollection): The filtered or user-supplied image collection converted to an ee.ImageCollection object.
+    Raises:
+        ValueError: Raised if required filter parameters are missing, or if both `collection` and other filters are provided.
+    Note:
+        See full usage examples in the documentation or notebooks:
+        https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks
+    Examples:
+        >>> from RadGEEToolbox import LandsatCollection
+        >>> import ee
+        >>> ee.Initialize()
+        >>> image_collection = LandsatCollection(
+        ...     start_date='2023-06-01',
+        ...     end_date='2023-06-30',
+        ...     tile_row=32,
+        ...     tile_path=38,
+        ...     cloud_percentage_threshold=20
+        ... )
+        >>> cloud_masked = image_collection.masked_clouds_collection
+        >>> latest_image = cloud_masked.image_grab(-1)
+        >>> ndwi_collection = image_collection.ndwi
     """
     def __init__(self, start_date=None, end_date=None, tile_row=None, tile_path=None, cloud_percentage_threshold=None, boundary=None,  collection=None):
         if collection is None and (start_date is None or end_date is None):

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/RadGEEToolbox/Sentinel1Collection.py RENAMED Viewed

@@ -4,144 +4,59 @@ import pandas as pd
 import numpy as np
 class Sentinel1Collection:
     """
-    Class object representing a collection of Sentinel-1 C-band Synthetic Aperture Radar (SAR) GRD data at 10 m/px resolution from Google Earth Engine (GEE). Units of backscatter are in decibels (dB) by default.
+    Represents a user-defined collection of ESA Sentinel-1 C-band Synthetic Aperture Radar (SAR) GRD data at 10 m/px resolution from Google Earth Engine (GEE). Units of backscatter are in decibels (dB) by default.
-    This class module provides methods to filter, process, and analyze Sentinel-1 satellite imagery for a given period and region.
+    This class enables simplified definition, filtering, masking, and processing of Seninel-1 SAR imagery.
+    It supports multiple spatial and temporal filters, multilooking and speckle filtering, caching for efficient computation, and direct conversion between log and linear backscatter scales. It also includes utilities for
+    mosaicking, zonal statistics, and transect analysis.
-    Inspect the documentation or source code for details on the methods and properties available.
-    Arguments:
-        start_date (str): Start date string in format of yyyy-mm-dd for filtering collection (required unless collection is provided)
-        end_date (str): End date string in format of yyyy-mm-dd for filtering collection (required unless collection is provided)
-        relative_orbit_start (int or list): Relative orbit start number for filtering collection (required unless collection is provided)
-        relative_orbit_stop (int or list): Relative orbit stop number for filtering collection (required unless collection is provided)
-        instrument_mode (str or list): Instrument mode for filtering collection, with options of IW, EW, or SM (optional - defaults to IW)
-        polarization (str or list): Polarization bands in image for filtering collection. Options: ['VV'], ['HH'], ['VV', 'VH'], or ['HH', 'HV'] (optional; default is ['VV', 'VH'])
-        bands (str or list): Band(s) of interest in each image (optional, must match polarization type; default is ['VV', 'VH'])
+    Initialization can be done by providing filtering parameters or directly passing in a pre-filtered GEE collection.
-        orbit_direction (str or list): Orbit direction for filtering collection. Options: 'ASCENDING' and/or 'DESCENDING' (required unless collection is provided). For example, ['ASCENDING', 'DESCENDING'] will include both ascending and descending images.
-        boundary (ee.Geometry): Boundary for filtering images to images that intersect with the boundary shape (optional)
+    Inspect the documentation or source code for details on the methods and properties available.
-        resolution_meters (int): Resolution in meters for filtering collection. Options of 10, 25, or 40 (required unless collection is provided; NOTE: this is for filtering the GEE collection, not multilooking/reprojecting)
-        collection (ee.ImageCollection): Optional argument to provide an ee.ImageCollection object to be converted to a Sentinel1Collection object - will override other arguments!
+    Args:
+        start_date (str): Start date in 'YYYY-MM-DD' format. Required unless `collection` is provided.
+        end_date (str): End date in 'YYYY-MM-DD' format. Required unless `collection` is provided.
+        relative_orbit_start (int or list): Relative orbit start number for filtering collection. Required unless `collection` is provided.
+        relative_orbit_stop (int or list): Relative orbit stop number for filtering collection. Required unless `collection` is provided.
+        instrument_mode (str or list, optional): Instrument mode for filtering collection, with options of 'IW', 'EW', or 'SM'. Defaults to 'IW'
+        polarization (str or list, optional): Polarization bands in image for filtering collection. Options: ['VV'], ['HH'], ['VV', 'VH'], or ['HH', 'HV']. Default is ['VV', 'VH'].
+        bands (str or list, optional): Desired band(s). Must match polarization type. Default is ['VV', 'VH']
+        orbit_direction (str or list): Orbit direction for filtering collection. Options: 'ASCENDING' and/or 'DESCENDING'. Required unless `collection` is provided. For example, ['ASCENDING', 'DESCENDING'] will include both ascending and descending images.
+        boundary (ee.Geometry, optional): A geometry for filtering to images that intersect with the boundary shape. Overrides `relative_orbit_start` and `relative_orbit_stop` if provided.
+        resolution_meters (int): Resolution in meters for filtering collection. Options of 10, 25, or 40. Required unless collection is provided. NOTE: this is for filtering the GEE collection, not multilooking/reprojecting)
+        collection (ee.ImageCollection, optional): A pre-filtered Sentinel-1 ee.ImageCollection object to be converted to a Sentinel1Collection object. Overrides all other filters.
     Attributes:
-        collection: Returns an ee.ImageCollection object from any Sentinel1Collection image collection object
-        _dates_list: Cache storage for dates_list property attribute
-        _dates: Cahce storgage for dates property attribute
-        _geometry_masked_collection: Cache storage for mask_to_polygon method
-        _geometry_masked_out_collection: Cache storage for mask_out_polygon method
-        _median: Cache storage for median property attribute
-        _mean: Cache storage for mean property attribute
-        _max: Cache storage for max property attribute
-        _min: Cache storage for min property attribute
-        _MosaicByDate: Cache storage for MosaicByDate property attribute
-        _PixelAreaSumCollection: Cache storage for PixelAreaSumCollection property attribute
-        _speckle_filter: Cache storage for speckle_filter property attribute
-        _Sigma0FromDb: Cache storage for Sigma0FromDb property attribute
-        _DbFromSigma0: Cache storage for DbFromSigma0 property attribute
-        _multilook: Cache storage for multilook property attribute
-    Property attributes:
-        dates_list (returns: Server-Side List): Unreadable Earth Engine list of image dates (server-side)
-        dates (returns: Client-Side List): Readable pythonic list of image dates (client-side)
-        max (returns: ee.Image): Returns a temporally reduced max image (calculates max at each pixel)
-        median (returns: ee.Image): Returns a temporally reduced median image (calculates median at each pixel)
-        mean (returns: ee.Image): Returns a temporally reduced mean image (calculates mean at each pixel)
-        min (returns: ee.Image): Returns a temporally reduced min image (calculates min at each pixel)
-        MosaicByDate (returns: Sentinel1Collection image collection): Mosaics image collection where images with the same date are mosaiced into the same image. Calculates total cloud percentage for subsequent filtering of cloudy mosaics.
-        Sigma0FromDb (returns: Sentinel1Collection image collection): Converts image collection from decibels to sigma0
-        DbFromSigma0 (returns: Sentinel1Collection image collection): Converts image collection from sigma0 to decibels
-        multilook (returns: Sentinel1Collection image collection): Multilooks image collection by specified number of looks (1, 2, 3, or 4)
-        speckle_filter (returns: Sentinel1Collection image collection): Applies speckle filter to image collection
-    Methods:
-        get_filtered_collection(self)
-        get_boundary_filtered_collection(self)
-        mask_to_polygon(self, polygon)
-        mask_out_polygon(self, polygon)
-        PixelAreaSumCollection(self, band_name, geometry, threshold, scale, maxPixels)
-        image_grab(self, img_selector)
-        custom_image_grab(self, img_col, img_selector)
-        image_pick(self, img_date)
-        CollectionStitch(self, img_col2)
-        transect_iterator(self, lines, line_names, save_folder_path, reducer='mean', n_segments=None, dist_interval=30, to_pandas=True)
-        iterate_zonal_stats(self, coordinates, buffer_size=1, reducer_type='mean', scale=40, tileScale=1, coordinate_names=None, file_path=None, dates=None)
-    Static Methods:
-        image_dater(image)
-        PixelAreaSum(image, band_name, geometry, threshold=-1, scale=30, maxPixels=1e12)
-        multilook_fn(image, looks)
-        leesigma(image, KERNEL_SIZE, geometry, Tk=7, sigma=0.9, looks=1)
-        extract_transect(image, line, reducer="mean", n_segments=100, dist_interval=None, scale=None, crs=None, crsTransform=None, tileScale=1.0, to_pandas=False)
-        transect(image, lines, line_names, reducer='mean', n_segments=None, dist_interval=30, to_pandas=True)
-        extract_zonal_stats_from_buffer(image, coordinates, buffer_size=1, reducer_type='mean', scale=40, tileScale=1, coordinate_names=None)
-    Usage:
-        The Sentinel1Collection object alone acts as a base object for which to further filter or process to indices or spatial reductions
-        To use the Sentinel1Collection functionality, use any of the built in class attributes or method functions. For example, using class attributes:
-        image_collection = Sentinel1Collection(start_date, end_date, tile_row, tile_path, cloud_percentage_threshold)
-        ee_image_collection = image_collection.collection #returns ee.ImageCollection from provided argument filters
-        latest_image = image_collection.image_grab(-1) #returns latest image in collection as ee.Image
-        cloud_masked_collection = image_collection.masked_clouds_collection #returns cloud-masked Sentinel1Collection image collection
-        NDWI_collection = image_collection.ndwi #returns NDWI Sentinel1Collection image collection
-        latest_NDWI_image = NDWI_collection.image_grab(-1) #Example showing how class functions work with any Sentinel1Collection image collection object, returning latest ndwi image
+        collection (ee.ImageCollection): The filtered or user-supplied image collection converted to an ee.ImageCollection object.
+    Raises:
+        ValueError: Raised if required filter parameters are missing, or if both `collection` and other filters are provided.
+    Note:
+        See full usage examples in the documentation or notebooks:
+        https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks
+    Examples:
+        >>> from RadGEEToolbox import Sentinel1Collection
+        >>> import ee
+        >>> ee.Initialize()
+        >>> counties = ee.FeatureCollection('TIGER/2018/Counties')
+        >>> salt_lake_county = counties.filter(ee.Filter.And(
+        ...    ee.Filter.eq('NAME', 'Salt Lake'),
+        ...    ee.Filter.eq('STATEFP', '49')))
+        >>> salt_lake_geometry = salt_lake_county.geometry()
+        >>> SAR_collection = Sentinel1Collection(
+        ...    start_date='2024-05-01',
+        ...    end_date='2024-05-31',
+        ...    instrument_mode='IW',
+        ...    polarization=['VV', 'VH'],
+        ...    orbit_direction='DESCENDING',
+        ...    boundary=salt_lake_geometry,
+        ...    resolution_meters=10
+        ... )
+        >>> latest_image = SAR_collection.image_grab(-1)
+        >>> mean_SAR_backscatter = SAR_collection.mean
     """
     def __init__(self, start_date=None, end_date=None, relative_orbit_start=None, relative_orbit_stop=None, instrument_mode=None, polarization=None, bands=None, orbit_direction=None, boundary=None, resolution=None, resolution_meters=None, collection=None):
         if collection is None and (start_date is None or end_date is None):

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/RadGEEToolbox/Sentinel2Collection.py RENAMED Viewed

@@ -3,214 +3,52 @@ import pandas as pd
 import numpy as np
 class Sentinel2Collection:
     """
-    Class object representing a collection of ESA Sentinel-2 MSI surface reflectance satellite images at 10 m/px resolution from Google Earth Engine.
+    Represents a user-defined collection of ESA Sentinel-2 MSI surface reflectance satellite images at 10 m/px from Google Earth Engine (GEE).
-    This class provides methods to filter, process, and analyze Sentinel-2 satellite imagery for a given period and region.
+    This class enables simplified definition, filtering, masking, and processing of multispectral Sentinel-2 imagery.
+    It supports multiple spatial and temporal filters, caching for efficient computation, and direct computation of
+    key spectral indices like NDWI, NDVI, halite index, and more. It also includes utilities for cloud masking,
+    mosaicking, zonal statistics, and transect analysis.
-    Inspect the documentation or source code for details on the methods and properties available.
-    Arguments:
-        start_date (str): Start date string in format of yyyy-mm-dd for filtering collection (required unless collection is provided)
-        end_date (str): End date string in format of yyyy-mm-dd for filtering collection (required unless collection is provided)
-        tile (str or list): MGRS tile(s) of Sentinel image (required unless boundary, relative_orbit_number, or collection is provided) | user is allowed to provide multiple tiles as list (note tile specifications will override boundary or orbits) - see https://hls.gsfc.nasa.gov/products-description/tiling-system/
-        cloud_percentage_threshold (int): Integer percentage threshold where only imagery with cloud % less than threshold will be provided (defaults to 100)
+    Initialization can be done by providing filtering parameters or directly passing in a pre-filtered GEE collection.
-        nodata_threshold (int): Integer percentage threshold where only imagery with nodata pixels encompassing a % less than the threshold will be provided (defaults to 100)
+    Inspect the documentation or source code for details on the methods and properties available.
-        boundary (ee.Geometry): Boundary for filtering images to images that intersect with the boundary shape (optional) - can be used in conjunction with relative_orbit_number
-        relative_orbit_number (int or list): Relative orbit number(s) to filter collection (optional) - can be used in conjunction with boundary | provide multiple values as list
-        collection (ee.ImageCollection): Optional argument to convert an ee.ImageCollection object to a Sentinel2Collection object - will override other arguments!
+    Args:
+        start_date (str): Start date in 'YYYY-MM-DD' format. Required unless `collection` is provided.
+        end_date (str): End date in 'YYYY-MM-DD' format. Required unless `collection` is provided.
+        tile (str or list): MGRS tile(s) of Sentinel image. Required unless `boundary`, `relative_orbit_number`, or `collection` is provided. The user is allowed to provide multiple tiles as list (note tile specifications will override boundary or orbits). See https://hls.gsfc.nasa.gov/products-description/tiling-system/
+        cloud_percentage_threshold (int, optional): Max allowed cloud cover percentage. Defaults to 100.
+        nodata_threshold (int, optional): Integer percentage threshold where only imagery with nodata pixels encompassing a % less than the threshold will be provided (defaults to 100)
+        boundary (ee.Geometry, optional): A geometry for filtering to images that intersect with the boundary shape. Overrides `tile` if provided.
+        relative_orbit_number (int or list, optional): Relative orbit number(s) to filter collection. Provide multiple values as list
+        collection (ee.ImageCollection, optional): A pre-filtered Sentinel-2 ee.ImageCollection object to be converted to a Sentinel2Collection object. Overrides all other filters.
     Attributes:
-        collection (returns: ee.ImageCollection): Returns an ee.ImageCollection object from any Sentinel2Collection image collection object
-        _dates_list: Cache storage for dates_list property attribute
-        _dates: Cahce storgage for dates property attribute
-        ndwi_threshold: Default threshold for masking ndwi imagery
-        ndvi_threshold: Default threshold for masking ndvi imagery
-        halite_threshold: Default threshold for masking halite imagery
-        gypsum_threshold: Default threshold for masking gypsum imagery
-        turbidity_threshold: Default threshold for masking turbidity imagery
-        chlorophyll_threshold: Default threshold for masking chlorophyll imagery
-        _masked_clouds_collection: Cache storage for masked_clouds_collection property attribute
-        _masked_water_collection: Cache storage for masked_water_collection property attribute
-        _masked_to_water_collection: Cache storage for masked_to_water_collection property attribute
-        _geometry_masked_collection: Cache storage for mask_to_polygon method
-        _geometry_masked_out_collection: Cache storage for mask_out_polygon method
-        _median: Cache storage for median property attribute
-        _mean: Cache storage for mean property attribute
-        _max: Cache storage for max property attribute
+        collection (ee.ImageCollection): The filtered or user-supplied image collection converted to an ee.ImageCollection object.
-        _min: Cache storage for min property attribute
+    Raises:
+        ValueError: Raised if required filter parameters are missing, or if both `collection` and other filters are provided.
-        _ndwi: Cache storage for ndwi property attribute
-        _ndvi: Cache storage for ndvi property attribute
-        _halite: Cache storage for halite property attribute
-        _gypsum: Cache storage for gypsum property attribute
-        _turbidity: Cache storage for turbidity property attribute
-        _chlorophyll: Cache storage for chlorophyll property attribute
-        _MosaicByDate: Cache storage for MosaicByDate property attribute
-    Property Attributes:
-        dates_list (returns: Server-Side List): Unreadable Earth Engine list of image dates (server-side)
-        dates (returns: Client-Side List): Readable pythonic list of image dates (client-side)
-        masked_clouds_collection (returns: Sentinel2Collection image collection): Returns collection with clouds masked (transparent) for each image
-        masked_to_water_collection (returns: Sentinel2Collection image collection): Returns collection masked to just water pixels
-        masked_water_collection (returns: Sentinel2Collection image collection): Returns collection with water pixels masked
-        max (returns: ee.Image): Returns a temporally reduced max image (calculates max at each pixel)
-        median (returns: ee.Image): Returns a temporally reduced median image (calculates median at each pixel)
-        mean (returns: ee.Image): Returns a temporally reduced mean image (calculates mean at each pixel)
-        min (returns: ee.Image): Returns a temporally reduced min image (calculates min at each pixel)
-        ndwi (returns: ee.ImageCollection): Returns Sentinel2Collection image collection of singleband NDWI (water) rasters
-        ndvi (returns: ee.ImageCollection): Returns Sentinel2Collection image collection of singleband NDVI (vegetation) rasters
-        halite (returns: ee.ImageCollection): Returns Sentinel2Collection image collection of singleband halite index rasters
-        gypsum (returns: ee.ImageCollection): Returns Sentinel2Collection image collection of singleband gypsum index rasters
-        turbidity (returns: ee.ImageCollection): Returns Sentinel2Collection image collection of singleband NDTI (turbidity) rasters
-        chlorophyll (returns: ee.ImageCollection): Returns Sentinel2Collection image collection of singleband 2BDA (relative chlorophyll-a) rasters
-        MosaicByDate (returns: Sentinel2Collection image collection): Mosaics image collection where images with the same date are mosaiced into the same image. Calculates total cloud percentage for subsequent filtering of cloudy mosaics.
-    Methods:
-        ndwi_collection(self, threshold)
-        ndvi_collection(self, threshold)
+    Note:
+        See full usage examples in the documentation or notebooks:
+        https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks
-        halite_collection(self, threshold)
-        gypsum_collection(self, threshold)
-        turbidity_collection(self, threshold)
-        chlorophyll_collection(self, threshold)
-        get_filtered_collection(self)
-        get_boundary_filtered_collection(self)
-        get_orbit_filtered_collection(self)
-        get_orbit_and_boundary_filtered_collection(self)
-        mask_to_polygon(self, polygon)
-        mask_out_polygon(self, polygon)
-        masked_water_collection_NDWI(self, threshold)
-        masked_to_water_collection_NDWI(self, threshold)
-        mask_halite(self, threshold)
-        mask_halite_and_gypsum(self, halite_threshold, gypsum_threshold)
-        PixelAreaSumCollection(self, band_name, geometry, threshold, scale, maxPixels)
-        image_grab(self, img_selector)
-        custom_image_grab(self, img_col, img_selector)
-        image_pick(self, img_date)
-        CollectionStitch(self, img_col2)
-        transect_iterator(self, lines, line_names, save_folder_path, reducer='mean', n_segments=None, dist_interval=30, to_pandas=True)
-        iterate_zonal_stats(self, coordinates, buffer_size=1, reducer_type='mean', scale=10, tileScale=1, coordinate_names=None, file_path=None, dates=None)
-    Static Methods:
-        image_dater(image)
-        sentinel_ndwi_fn(image, threshold)
-        sentinel_ndvi_fn(image, threshold)
-        sentinel_halite_fn(image, threshold)
-        sentinel_gypsum_fn(image, threshold)
-        sentinel_turbidity_fn(image, threshold)
-        sentinel_chlorophyll_fn(image, threshold)
-        MaskWaterS2(image)
-        MaskToWaterS2(image)
-        MaskWaterS2ByNDWI(image, threshold)
-        MaskToWaterS2ByNDWI(image, threshold)
-        halite_mask(image, threshold)
-        gypsum_and_halite_mask(image, halite_threshold, gypsum_threshold)
-        MaskCloudsS2(image)
-        PixelAreaSum(image, band_name, geometry, threshold=-1, scale=30, maxPixels=1e12)
-        extract_transect(image, line, reducer="mean", n_segments=100, dist_interval=None, scale=None, crs=None, crsTransform=None, tileScale=1.0, to_pandas=False)
-        transect(image, lines, line_names, reducer='mean', n_segments=None, dist_interval=30, to_pandas=True)
-        extract_zonal_stats_from_buffer(image, coordinates, buffer_size=1, reducer_type='mean', scale=10, tileScale=1, coordinate_names=None)
-    Usage:
-        The Sentinel2Collection object alone acts as a base object for which to further filter or process to indices or spatial reductions
-        To use the Sentinel2Collection functionality, use any of the built in class attributes or method functions. For example, using class attributes:
-        image_collection = Sentinel2Collection(start_date, end_date, tile, cloud_percentage_threshold)
-        ee_image_collection = image_collection.collection #returns ee.ImageCollection from provided argument filters
-        latest_image = image_collection.image_grab(-1) #returns latest image in collection as ee.Image
-        cloud_masked_collection = image_collection.masked_clouds_collection #returns cloud-masked Sentinel2Collection image collection
-        NDWI_collection = image_collection.ndwi #returns NDWI Sentinel2Collection image collection
-        latest_NDWI_image = NDWI_collection.image_grab(-1) #Example showing how class functions work with any Sentinel2Collection image collection object, returning latest ndwi image
+    Examples:
+        >>> from RadGEEToolbox import Sentinel2Collection
+        >>> import ee
+        >>> ee.Initialize()
+        >>> image_collection = Sentinel2Collection(
+        ...     start_date='2023-06-01',
+        ...     end_date='2023-06-30',
+        ...     tile=['12TUL', '12TUM', '12TUN'],
+        ...     cloud_percentage_threshold=20,
+        ...     nodata_threshold=10,
+        ... )
+        >>> mosaic_collection = image_collection.MosaicByDate #mosaic images/tiles with same date
+        >>> cloud_masked = mosaic_collection.masked_clouds_collection #mask out clouds
+        >>> latest_image = cloud_masked.image_grab(-1) #grab latest image for viewing
+        >>> ndwi_collection = cloud_masked.ndwi #calculate ndwi for all images
     """
     def __init__(self, start_date=None, end_date=None, tile=None, cloud_percentage_threshold=None, nodata_threshold=None, boundary=None, relative_orbit_number=None, collection=None):

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/RadGEEToolbox.egg-info/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RadGEEToolbox
-Version: 1.6.1
+Version: 1.6.2
 Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 Home-page: https://github.com/radwinskis/RadGEEToolbox
 Author: Mark Radwin
@@ -67,15 +67,15 @@ _____________
 ### Installing via pip
-To install `RadGEEToolbox` version 1.6.1 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.2 using pip (NOTE: it is recommended to create a new virtual environment):
 ```bash
-pip install RadGEEToolbox==1.6.1
+pip install RadGEEToolbox==1.6.2
 ```
 ### Installing via Conda
-To install `RadGEEToolbox` version 1.6.1 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.2 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -106,7 +106,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
-You should see `1.6.1` printed as the version number.
+You should see `1.6.2` printed as the version number.
 ________
 # Usage Example

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/pyproject.toml RENAMED Viewed

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "RadGEEToolbox"
-version = "1.6.1"
+version = "1.6.2"
 description = "Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API"
 authors = [
     {name = "Mark Radwin", email = "markradwin@gmail.com"}

{radgeetoolbox-1.6.1 → radgeetoolbox-1.6.2}/setup.py RENAMED Viewed

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 setup(
     name="RadGEEToolbox",
-    version="1.6.1",
+    version="1.6.2",
     author="Mark Radwin",
     author_email="markradwin@gmail.com",
     description="Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API",