geobox 2.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

geobox/api.py

@@ -2,9 +2,11 @@ import requests
 import logging
 import os
 from urllib.parse import urljoin
-from typing import Dict, List, Union
+from typing import Dict, List, Optional, Union
 from datetime import datetime
 
+from geobox.enums import AnalysisDataType, AnalysisResampleMethod
+
 from .exception import AuthenticationError, ApiRequestError, NotFoundError, ValidationError, ServerError, AuthorizationError
 from .vectorlayer import VectorLayer, LayerType
 from .feature import Feature
@@ -134,7 +136,6 @@ class _RequestSession(requests.Session):
         kwargs['headers'] = request_headers
         
         try:
-            print(kwargs['headers'])
             response = super().request(method, url, **kwargs)
         finally:
             if original_content_type:
@@ -327,7 +328,6 @@ class GeoboxClient:
 
         try:
             if files:
-                print(files)
                 response = self.session.request(method, url, data=payload, files=files)
             elif is_json:
                 response = self.session.request(method, url, json=payload)
@@ -746,7 +746,7 @@ class GeoboxClient:
         return VectorLayerView.get_views_by_ids(self, ids, user_id, include_settings)
     
 
-    def get_view(self, uuid: str) -> 'VectorLayerView':
+    def get_view(self, uuid: str, user_id: int = None) -> 'VectorLayerView':
         """
         Get a specific vector layer view by its UUID.
 
@@ -762,7 +762,7 @@ class GeoboxClient:
             >>> client = GeoboxClient()
             >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
         """
-        return VectorLayerView.get_view(self, uuid)
+        return VectorLayerView.get_view(self, uuid, user_id)
 
 
     def get_view_by_name(self, name: str, user_id: int = None) -> Union['VectorLayerView', None]:
@@ -2620,4 +2620,102 @@ class GeoboxClient:
             >>> client = GeoboxClient()
             >>> client.update_usage()
         """
-        return Usage.update_usage(self, user_id=user_id)
+        return Usage.update_usage(self, user_id=user_id)
+
+
+    def raster_calculator(self,
+        variables: str,
+        expr: str,
+        output_raster_name: str,
+        match_raster_uuid: Optional[str] = None,
+        resample: AnalysisResampleMethod = AnalysisResampleMethod.bilinear,
+        out_dtype: AnalysisDataType = AnalysisDataType.float32,
+        dst_nodata: int = -9999,
+        user_id: Optional[int] = None) -> 'Task':
+        """
+        Perform raster calculator operations on multiple raster datasets.
+
+        it allows you to perform mathematical operations on one or more raster datasets using NumPy expressions. 
+        Variables in the expression correspond to raster datasets specified in the variables dictionary.
+
+        Examples:
+            NDVI calculation: variables='{"NIR": "raster_uuid_1", "RED": "raster_uuid_2"}', expr="(NIR-RED)/(NIR+RED)"
+            Slope threshold: variables='{"SLOPE": "raster_uuid_1"}', expr="np.where(SLOPE>30,1,0)"
+            Multi-band operations: variables='{"IMG": ["raster_uuid_1", 2]}', expr="IMG*2"
+
+        Args:
+            variables (str): JSON string mapping variable names to raster specifications. Format: '{"NIR": "raster_uuid_1", "RED": "raster_uuid_2"}' or '{"IMG": ["raster_uuid_1", 2]}' for multi-band operations.
+            expr (str): Mathematical expression using NumPy syntax. Use variable names from the variables dict, e.g., '(NIR-RED)/(NIR+RED)' or 'where(SLOPE>30,1,0)' or 'where((dist_to_highway < 1000) & (slope < 10), 1, 0)' .Supported functions: np, sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, exp, log, log10, sqrt, abs, floor, ceil, round, minimum, maximum, clip, where, isnan, isfinite, pi, e.
+            output_raster_name (str): Name for the output raster dataset.
+            match_raster_uuid (str, optional): Optional raster UUID to match the output grid and projection. If not provided, the first variable becomes the reference grid.
+            resample (CropResample, optional): Resampling method: 'near', 'bilinear', 'cubic', 'lanczos', etc. default: CropResample.near
+            out_dtype (AnalysisDataType, optional): Data type for the output raster (e.g., int16, float32). default: AnalysisDataType.float32
+            dst_nodata (int, optional): NoData value for the output raster. default = -9999
+            user_id (int, optional): specific user. priviledges required!
+
+        Returns:
+            Task: task instance of the process
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> task = client.raster_calculator(api=client, variables={"NIR": "raster_uuid_1", "RED": "raster_uuid_2"},
+            ...     expr='where(SLOPE>30,1,0)',
+            ...     output_raster_name='test')
+        """
+        from .analysis import Analysis
+        return Analysis.calculator(self,
+            variables=variables,
+            expr=expr,
+            output_raster_name=output_raster_name,
+            match_raster_uuid=match_raster_uuid,
+            resample=resample,
+            out_dtype=out_dtype,
+            dst_nodata=dst_nodata,
+            user_id=user_id)
+
+
+
+    def create_constant_raster(self,
+        output_raster_name: str,
+        extent: str,
+        value : int,
+        pixel_size: int = 10,
+        dtype: AnalysisDataType = AnalysisDataType.float32,
+        nodata: int = -9999,
+        align_to: Optional[str] = None,
+        user_id: Optional[int] = None) -> 'Task':
+        """
+        Create a raster filled with a constant value.
+
+        This endpoint creates a north-up GeoTIFF filled with a constant value. 
+        Only users with Publisher role or higher can perform this operation.
+
+        Args:
+            output_raster_name (str): Name for the output constant raster dataset.
+            extent (str): Extent as 'minX,minY,maxX,maxY' (e.g., '0,0,100,100').
+            value (int): Constant value to fill the raster with.
+            pixel_size (int, optional): Pixel size for the output raster (must be > 0). default: 10
+            dtype (AnalysisDataType, optoinal): Output data type. default: AnalysisDataType.float32
+            nodata (int, optional): NoData value for the raster. default: -9999
+            align_to (str, optional): Grid origin to snap to as 'x0,y0' (e.g., '0,0').
+            user_id (int, optional): specific user. priviledges required!
+
+        Returns:
+            Task: task instance of the process
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> task = client.create_constant_raster(output_raster_name='test', extent='0,0,100,100', value=10)
+        """
+        from .analysis import Analysis
+        return Analysis.constant(self,
+            output_raster_name=output_raster_name,
+            extent=extent,
+            value=value,
+            pixel_size=pixel_size,
+            dtype=dtype,
+            nodata=nodata,
+            align_to=align_to,
+            user_id=user_id)