satcube 0.1.13__py3-none-any.whl → 0.1.15__py3-none-any.whl

satcube/utils.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 
 import gc
+import itertools
 from typing import Any, Optional
-
 import torch
 
-
 def _reset_gpu() -> None:
     """Release CUDA memory and reset allocation statistics.
 
@@ -15,6 +14,65 @@ def _reset_gpu() -> None:
     torch.cuda.reset_peak_memory_stats()
 
 
+def define_iteration(dimension: tuple, chunk_size: int, overlap: int = 0):
+    """
+    Define the iteration strategy to walk through the image with an overlap.
+
+    Args:
+        dimension (tuple): Dimension of the S2 image.
+        chunk_size (int): Size of the chunks.
+        overlap (int): Size of the overlap between chunks.
+
+    Returns:
+        list: List of chunk coordinates.
+    """
+    dimy, dimx = dimension
+
+    if chunk_size > max(dimx, dimy):
+        return [(0, 0)]
+
+    # Adjust step to create overlap
+    y_step = chunk_size - overlap
+    x_step = chunk_size - overlap
+
+    # Generate initial chunk positions
+    iterchunks = list(itertools.product(range(0, dimy, y_step), range(0, dimx, x_step)))
+
+    # Fix chunks at the edges to stay within bounds
+    iterchunks_fixed = fix_lastchunk(
+        iterchunks=iterchunks, s2dim=dimension, chunk_size=chunk_size
+    )
+
+    return iterchunks_fixed
+
+
+def fix_lastchunk(iterchunks, s2dim, chunk_size):
+    """
+    Fix the last chunk of the overlay to ensure it aligns with image boundaries.
+
+    Args:
+        iterchunks (list): List of chunks created by itertools.product.
+        s2dim (tuple): Dimension of the S2 images.
+        chunk_size (int): Size of the chunks.
+
+    Returns:
+        list: List of adjusted chunk coordinates.
+    """
+    itercontainer = []
+
+    for index_i, index_j in iterchunks:
+        # Adjust if the chunk extends beyond bounds
+        if index_i + chunk_size > s2dim[0]:
+            index_i = max(s2dim[0] - chunk_size, 0)
+        if index_j + chunk_size > s2dim[1]:
+            index_j = max(s2dim[1] - chunk_size, 0)
+
+        itercontainer.append((index_i, index_j))
+
+    return itercontainer
+
+
+
 class DeviceManager:
     """Hold a compiled mlstac model and move it between devices on demand."""
 
@@ -68,3 +126,4 @@ class DeviceManager:
         self.model = self._experiment.compiled_model(device=new_device, mode="max")
         self.device = new_device
         return self.model
+

{satcube-0.1.13.dist-info → satcube-0.1.15.dist-info}/METADATA

@@ -1,29 +1,25 @@
 Metadata-Version: 2.1
 Name: satcube
-Version: 0.1.13
+Version: 0.1.15
 Summary: A Python package to create cloud-free monthly composites by fusing Landsat and Sentinel-2 data.
 Home-page: https://github.com/IPL-UV/satcube
 Author: Cesar Aybar
 Author-email: fcesar.aybar@uv.es
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.9
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: full
-Requires-Dist: cubexpress (>=0.1.7)
-Requires-Dist: earthengine-api (>=1.5.12)
+Requires-Dist: cubexpress (>=0.1.10)
 Requires-Dist: mlstac (>=0.4.0)
-Requires-Dist: numpy (>=1.25.0)
-Requires-Dist: pandas (>=2.0.0)
 Requires-Dist: phicloudmask (>=0.0.2)
-Requires-Dist: pydantic (>=2.8.0)
-Requires-Dist: rasterio (>=1.3.9)
 Requires-Dist: requests (>=2.26.0)
-Requires-Dist: satalign (>=0.1.11)
+Requires-Dist: satalign (>=0.1.9)
 Requires-Dist: scikit-learn (>=1.2.0)
 Requires-Dist: segmentation-models-pytorch (>=0.3.0)
-Requires-Dist: utm (>=0.7.0)
+Requires-Dist: tqdm (>=4.67.1)
 Requires-Dist: xarray (>=2023.7.0)
 Project-URL: Documentation, https://ipl-uv.github.io/satcube/
 Project-URL: Repository, https://github.com/IPL-UV/satcube

satcube-0.1.15.dist-info/RECORD

@@ -0,0 +1,10 @@
+satcube/__init__.py,sha256=1q5c8Kx1dePuPBo29O7-1MA0L_GdBhi56gbxjQAa1_o,317
+satcube/align.py,sha256=0QOzX9f-r05F8niI91xlvifmyHaAQjWgBit_4Jc6OeM,2979
+satcube/cloud_detection.py,sha256=05OifUtWjE5jco8Q1jf_7qoQ45qrnJQgRc6LrPlMkLI,7898
+satcube/download.py,sha256=o8kwPzipU1f_pV0KNPLmLmjUEsoWb6yhkCt7kerDViU,1545
+satcube/objects.py,sha256=zhiYu-rUTm65TuEl2qIo7kLfpdam17_6CZl2KBCT9Jw,1988
+satcube/utils.py,sha256=QBdmSg6_4Vy-4mXH1Z3Z2AvbIKAXBYi5g3-IgWSE1MY,3660
+satcube-0.1.15.dist-info/LICENSE,sha256=YdB4BQMkMzWuKvXRIpQR4g91IQ_pwA5PSH2lNM97zFI,1070
+satcube-0.1.15.dist-info/METADATA,sha256=iyw3WijWmTfyg0-c-1qdxZ8UkgTd7XbnOnzZAs2QAV4,6558
+satcube-0.1.15.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+satcube-0.1.15.dist-info/RECORD,,

satcube/cloud_detection_old.py

@@ -1,24 +0,0 @@
-import torch
-
-class LandsatCloudDetector(torch.nn.Module):
-    def __init__(self):
-        super().__init__()
-
-    def forward(self, x: torch.Tensor) -> torch.Tensor:
-        # Define bit flags for clouds based on the
-        # Landsat QA band documentation
-        cloud_flags = (1 << 3) | (1 << 4) | (1 << 1)
-
-        ## Get the QA band
-        qa_band = x[6]
-        mask_band = x[:6].mean(axis=0)
-        mask_band[~torch.isnan(mask_band)] = 1
-
-        ## Create a cloud mask
-        cloud_mask = torch.bitwise_and(qa_band.int(), cloud_flags) == 0
-        cloud_mask = cloud_mask.float()
-        cloud_mask[cloud_mask == 0] = torch.nan
-        cloud_mask[cloud_mask == 0] = 1
-        final_mask = cloud_mask * mask_band
-        return final_mask
-

satcube/dataclass.py

@@ -1,39 +0,0 @@
-import pathlib
-from datetime import datetime
-from typing import List, Optional
-
-import pydantic
-
-
-class Sensor(pydantic.BaseModel):
-    start_date: str
-    end_date: str
-    edge_size: int
-    bands: List[str]
-
-
-class Sentinel2(Sensor):
-    weight_path: pathlib.Path
-    start_date: Optional[str] = "2015-06-27"
-    end_date: Optional[str] = datetime.now().strftime("%Y-%m-%d")
-    resolution: Optional[int] = 10
-    edge_size: Optional[int] = 384
-    embedding_universal: Optional[str] = "s2_embedding_model_universal.pt"
-    cloud_model_universal: str = "s2_cloud_model_universal.pt"
-    cloud_model_specific: str = "s2_cloud_model_specific.pt"
-    super_model_specific: str = "s2_super_model_specific.pt"
-    bands: List[str] = [
-        "B01",
-        "B02",
-        "B03",
-        "B04",
-        "B05",
-        "B06",
-        "B07",
-        "B08",
-        "B8A",
-        "B09",
-        "B10",
-        "B11",
-        "B12",
-    ]

satcube/download_old.py

@@ -1,82 +0,0 @@
-import ee
-import cubexpress
-import pathlib
-from typing import Optional
-from datetime import datetime
-
-def download_data(
-    lon: float,
-    lat: float,
-    cs_cdf: Optional[float] = 0.6,
-    buffer_size: Optional[int] = 1280,
-    start_date: Optional[str] = "2015-01-01",
-    end_date: Optional[str] = datetime.today().strftime('%Y-%m-%d'),
-    outfolder: Optional[str] = "raw/"
-) -> pathlib.Path:
-    """
-    Download Sentinel-2 imagery data using cubexpress and Earth Engine API.
-
-    Args:
-        lon (float): Longitude of the point of interest.
-        lat (float): Latitude of the point of interest.
-        cs_cdf (Optional[float]): Cloud mask threshold (default 0.6).
-        buffer_size (Optional[int]): Buffer size for image extraction (default 1280).
-        start_date (Optional[str]): Start date for image filtering (default "2015-01-01").
-        end_date (Optional[str]): End date for image filtering (default today’s date).
-        outfolder (Optional[str]): Output folder to save images (default "raw/").
-
-    Returns:
-        pathlib.Path: Path to the folder where the data is stored.
-    """
-    
-    # Initialize Earth Engine
-    ee.Initialize(project="ee-julius013199")
-
-    # Define point of interest
-    point = ee.Geometry.Point([lon, lat])
-    
-    # Filter image collection by location and date
-    collection = ee.ImageCollection("COPERNICUS/S2_SR_HARMONIZED") \
-                    .filterBounds(point) \
-                    .filterDate(start_date, end_date)
-
-    # Get image IDs
-    image_ids = collection.aggregate_array('system:id').getInfo()
-    
-    # Cloud mask function
-    def cloud_mask(image) -> ee.Image:
-        """Apply cloud mask to the image."""
-        return image.select('MSK_CLDPRB').lt(20)
-
-    # Apply cloud mask
-    collection = collection.map(cloud_mask)
-    
-    # Generate geotransform for cubexpress
-    geotransform = cubexpress.lonlat2rt(lon=lon, lat=lat, edge_size=buffer_size, scale=10)
-
-    # Prepare requests for cubexpress
-    requests = [
-        cubexpress.Request(
-            id=f"s2test_{i}",
-            raster_transform=geotransform,
-            bands=["B4", "B3", "B2"],  # RGB bands
-            image=ee.Image(image_id).divide(10000)  # Adjust image scaling
-        )
-        for i, image_id in enumerate(image_ids)
-    ]
-    
-    # Create request set
-    cube_requests = cubexpress.RequestSet(requestset=requests)
-
-    # Set output folder
-    output_path = pathlib.Path(outfolder)
-
-    # Download the data
-    cubexpress.getcube(
-        request=cube_requests,
-        output_path=output_path,
-        nworkers=4,
-        max_deep_level=5
-    )
-    
-    return output_path