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

geobox/task.py

@@ -249,7 +249,7 @@ class Task(Base):
 
     def _check_timeout(self, start_time: float, timeout: Union[int, None]) -> None:
         """Checks if the task has exceeded the timeout period."""
-        if timeout and time.time() - start_time > timeout:
+        if timeout and time.time() - start_time > float(timeout):
             raise TimeoutError(f"Task {self.name} timed out after {timeout} seconds")
 
 

geobox/vectorlayer.py

@@ -8,7 +8,7 @@ from .field import Field, FieldType
 from .feature import Feature
 from .enums import LayerType
 from .task import Task
-from .enums import InputGeomType, FileOutputFormat
+from .enums import InputGeomType, FileOutputFormat, AnalysisDataType
 from .version import VectorLayerVersion
 
 if TYPE_CHECKING:
@@ -1360,4 +1360,109 @@ class VectorLayer(Base):
         """
         from .aio.vectorlayer import VectorLayer as AsyncVectorLayer
 
-        return AsyncVectorLayer(api=async_client, uuid=self.uuid, layer_type=self.layer_type, data=self.data)
+        return AsyncVectorLayer(api=async_client, uuid=self.uuid, layer_type=self.layer_type, data=self.data)
+
+
+    def rasterize(self, 
+        output_raster_name: str,
+        pixel_size: int = 10,
+        nodata: Optional[int] = -9999,
+        data_type: Optional[AnalysisDataType] = AnalysisDataType.int16,
+        burn_value: Optional[int] = 1,
+        burn_attribute: Optional[str] = None,
+        user_id: Optional[int] = None) -> 'Task':
+        """
+        Rasterize a vector layer.
+
+        This method converts a vector layer (or view) to a raster dataset using the specified parameters. 
+        You can control the output raster's name, pixel size, data type, nodata value, and the value to burn (either a constant or from an attribute field). 
+        Only users with Publisher role or higher can perform this operation.
+
+        Args:
+            output_raster_name (str): Name for the output raster dataset
+            pixel_size (int, optional): Pixel size for the output raster (must be > 0). default: 10
+            nodata (int, optional): NoData value to use in the output raster. default: -9999
+            data_type (AnalysisDataType, optional): Data type for the output raster (e.g., int16, float32). default: AnalysisDataType.int16
+            burn_value (int, optional): Value to burn into the raster for all features (if burn_attribute is not set). default: 1
+            burn_attribute (str, optional): Name of the attribute field to use for burning values into the raster
+            user_id (int, optional): specific user. priviledges required!
+
+        Returns:
+            Task: task instance of the process
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> vector = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> task = vector.rasterize(output_raster_name='test')
+        """
+        from .analysis import Analysis
+        return Analysis.rasterize(self.api,
+                                    self,
+                                    output_raster_name=output_raster_name,
+                                    burn_attribute=burn_attribute,
+                                    pixel_size=pixel_size,
+                                    nodata=nodata,
+                                    data_type=data_type,
+                                    burn_value=burn_value,
+                                    user_id=user_id)
+
+
+    def idw_interpolation(self,
+        output_raster_name: str,
+        z_field: Field,
+        match_raster_uuid: Optional[str] = None,
+        pixel_size: int = 10,
+        extent: Optional[str] = None,
+        power: float = 2.0,
+        smoothing: float = 0.0,
+        max_points: int = 16,
+        radius: int = 1000,
+        nodata: int = -9999,
+        out_dtype: AnalysisDataType = AnalysisDataType.float32,
+        user_id: Optional[int] = None) -> 'Task':
+        """
+        Create an IDW (Inverse Distance Weighting) interpolation raster from point data.
+
+        it creates a raster using IDW interpolation from point data in a vector layer. 
+        Only users with Publisher role or higher can perform this operation.
+
+        Args:
+            output_raster_name (str): Name for the output IDW raster dataset.
+            z_field (Field): the field containing the values to interpolate.
+            match_raster_uuid (str, optional): UUID of reference raster to match resolution/extent.
+            pixel_size (int, optional): Pixel size for the output raster. default: 10
+            extent (str, optional): Extent as 'minX,minY,maxX,maxY'.
+            power (float, optional): Power parameter for IDW. default: 2.0
+            smoothing (float, optional): Smoothing parameter for IDW. default: 0.0
+            max_points (int, optional): Maximum number of neighbors to use. default: 16
+            radius (int, optional): Search radius in map units. default: 1000
+            nodata (int, optional): NoData value for the output raster. default: -9999
+            out_dtype (AnalysisDataType, optional): Output data type.
+            user_id (int, optional): specific user. priviledges required!
+
+        Returns:
+            Task: task instance of the process
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> vector = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> field = vector.get_field_by_name('field_name')
+            >>> task = vector.idw(output_raster_name='test', z_field=field)
+        """
+        from .analysis import Analysis
+        return Analysis.idw_interpolation(self.api,
+            self,
+            output_raster_name=output_raster_name,
+            z_field=z_field,
+            match_raster_uuid=match_raster_uuid,
+            pixel_size=pixel_size,
+            extent=extent,
+            power=power,
+            smoothing=smoothing,
+            max_points=max_points,
+            radius=radius,
+            nodata=nodata,
+            out_dtype=out_dtype,
+            user_id=user_id)

geobox/view.py

@@ -80,8 +80,8 @@ class VectorLayerView(VectorLayer):
             search_fields(str): Comma separated list of fields for searching.
             order_by(str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
             return_count(bool): Whether to return the count of the layer views. default is False.
-            skip(int): The number of layer views to skip. minimum is 0.
-            limit(int): The maximum number of layer views to return. minimum is 1. default is 10.
+            skip(int): The number of views to skip. minimum is 0.
+            limit(int): The maximum number of views to return. minimum is 1. default is 10.
             user_id(int): Specific user. privileges required.
             shared(bool): Whether to return shared views. default is False.
 

{geobox-2.0.0.dist-info → geobox-2.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geobox
-Version: 2.0.0
+Version: 2.1.0
 Summary: SDK for Geobox's APIs
 Author-email: Hamid Heydari <heydari.h62@gmail.com>
 License: MIT

{geobox-2.0.0.dist-info → geobox-2.1.0.dist-info}/RECORD

@@ -1,11 +1,12 @@
 geobox/__init__.py,sha256=ne0OfIpHDw_RiSuNmk1APBL66jAYXXPn_FAKHzkBrRM,1895
-geobox/api.py,sha256=zGlroMvfb_mnFQXCDJTpNYYecIE-IAL2vXBVpxCHq2U,105298
+geobox/analysis.py,sha256=jVx6Q_NAe6jMIz5ib3bxdqo8_3IKCdcTwawT1HSlsYo,35086
+geobox/api.py,sha256=uRpZoDrcXglNazv142EhsEEZ0AEV1y4QEqeKRsICJzM,110295
 geobox/apikey.py,sha256=p1kmnpjIa41vVKrz2nApWFQltorv68MNawtIWz5Ja0k,8562
 geobox/attachment.py,sha256=kbTmEayMf66f7gIS8uhD36SdnQrl1Nq_DRXjBdCeXDI,13026
 geobox/base.py,sha256=-7Qsxw7OzgtFygKqaDVB__HxmUqA521XGxj9ibtTmO8,12967
 geobox/basemap.py,sha256=998m2lpgESIGsJuADWFnqg5eShskCtlp6Qcri4IM6Hg,5587
 geobox/dashboard.py,sha256=iBK1ZFl3pM95q0lFAeRDnuk2vhhfm9-zBV0YOTKXAu0,12821
-geobox/enums.py,sha256=Ur8zbUjfx09oxXb-uzwFfDT_Nt8I4AP5pFQKJ9bxVxI,6204
+geobox/enums.py,sha256=PBePp0v9Qp5sR0ky2yj5w6dSfjFpRD4BjyA2sNJvQLE,7511
 geobox/exception.py,sha256=jvpnv0M2Ck1FpxHTL_aKYWxGvLnCQ3d9vOrMIktjw1U,1507
 geobox/feature.py,sha256=PphGJLSya2FR-JSaC7lE0YE-nf2A2wHPTCG3Rj6iz9Y,19239
 geobox/field.py,sha256=ZNbuf3ayemyguVee10yCKH4aq62xUEmY--qQLTeRz4Q,10897
@@ -16,23 +17,24 @@ geobox/map.py,sha256=CGorSxO5vuiOtmwUs3Mk4PeOg-HF5py3sRo6ahx9GF8,38074
 geobox/model3d.py,sha256=e_d_E7yj-Ria3oJm9V14vfXV-g1iMHa7u7sl9Or4FlA,14938
 geobox/mosaic.py,sha256=Ceh_kleRlZqBSDTTV27iwahG-TGsdpVzUyXcB3dbJIo,25128
 geobox/plan.py,sha256=f7ciVE_VKM7onuzE3bGK63XxxrtfUsMv16oImyDgZ3c,13061
-geobox/query.py,sha256=C0tqAEjqExb5a_0kO9mr63i62DobKwwDWphNQTU6WTE,25499
-geobox/raster.py,sha256=YSO-Qc73PWu2jIZdoF2xfqgVlBKGgAiYUhswjbgBfrY,31098
+geobox/query.py,sha256=ndppWvwpWdCE5tzU2rVtr6gglbDLvnPkWhvj-UMxhOY,25334
+geobox/raster.py,sha256=MtuabSJCLDTbczjroupG39M02kkooy6oGmuovMDl1sw,50656
 geobox/route.py,sha256=cKZTTHBHM8woWbhHIpCvrRX_doJcTkGktouee0z7oG0,2723
 geobox/scene.py,sha256=iUkMxH4YqPk3vCIQq1uAZgQGWUvtujKBylUWcmUpQkM,12356
 geobox/settings.py,sha256=ue6vZYYIirisYBwnuTsZnV7fG0jOQampX1xroC5lpdk,6856
-geobox/task.py,sha256=xc7UyyRm3cmzH1uznOZ-osRGSAdVufIQsmeVuoJ-IWs,14505
+geobox/task.py,sha256=IdCpE6tFGUIHXieP69_09yFY3Mtp-1DbAv7fMlBSg68,14512
 geobox/tile3d.py,sha256=nEFs2TuzJFC9k__rPlkWwL6s-WjIsyQZS5FEhmfsck0,12093
 geobox/tileset.py,sha256=wk0vSSON0DHiO6NzaScZnmu7d424jFCgNk0kJLDAtA8,25041
 geobox/usage.py,sha256=47nR-JDA3yfsK-o3eWSYA7FeDVJNPIIfvsRTGkfNv9A,9215
 geobox/user.py,sha256=GFQTw8EwLcyf-AMatmejtrgnSHB6Qg-ctE5YrzYIMEQ,17509
 geobox/utils.py,sha256=JmlRqDVIo0vBikzH1XakRrCrEIfLA7_eTJnBWBvGhJI,2243
-geobox/vectorlayer.py,sha256=_i1RdIw_P9BglnsERDLRxDRz6RU3tP7kVjFnRGepfyk,58622
+geobox/vectorlayer.py,sha256=IXs5kLx1-viMYx8zzQ6ZDNE-ieXe1nncZsmBvcDU-oQ,63623
 geobox/version.py,sha256=6IO8AHVTbS4z-cwaqqPt0o3ggwmskimKUoUoeFzx5UE,10560
-geobox/view.py,sha256=fUWOC_ZJ5mg6T0jHYJ5-rb7k2blI_EWT_lu4yE-cD_c,42333
+geobox/view.py,sha256=saYWWs3tY4ZScy2m5GrIqAQ_lwQ3GqCkHyOfHAGyQCo,42321
 geobox/workflow.py,sha256=Gi4AJlsvo_SFY3Ptgp_3sg_f37eIZNL2whn2yMW8Dkg,12666
 geobox/aio/__init__.py,sha256=EO8VP0d5JPPZH1o1CBdwSMkPZOpyGPK0v9UbIvf6g7w,1906
-geobox/aio/api.py,sha256=NIVHOKNA_UWD4V-prLmzxEQOFhkHJL4LW0fnXbn53BM,112430
+geobox/aio/analysis.py,sha256=9fV0MyZPLTzUl1vkGYJC5pzWnxKm4tlbPI_DoIIZgig,36362
+geobox/aio/api.py,sha256=IFjAwUN9GTkXVi_hzrXXKHXzfrkrtlPWvKEYXXW0hBU,117614
 geobox/aio/apikey.py,sha256=J_4XqTJ3PZUxsOqR1F-WIbpWzIihX32Y2sjPdSEUboY,9232
 geobox/aio/attachment.py,sha256=EXBdtlb5aKlnm5GHWDfX67v0mFON5gDBtF13rknETYM,13644
 geobox/aio/base.py,sha256=-B56CC7uMbb84DzT1YzytpOwalFRZ8mAtaVajcE4cNI,9189
@@ -47,22 +49,22 @@ geobox/aio/map.py,sha256=cOSCSVF3ERWXkMnneGLUryNZsXiScerLzmDw7K81uNE,40441
 geobox/aio/model3d.py,sha256=Gg1fbfNILMeLjBwS6vxcPx-AJWdriIGKtkJ6b06GxsE,15959
 geobox/aio/mosaic.py,sha256=wqXzrK9C-rZeMVamurqZj5Og6rSruvXBssnYfpWmt-g,27029
 geobox/aio/plan.py,sha256=pUBfmd-AfzAn7ejv3x2mp3cYr5mM9nMMdO-YDh1JDVY,13690
-geobox/aio/query.py,sha256=iLHt2MIzCP8ayUCahWMy1yPR0e9w9wZutNzp2M-FisA,27011
-geobox/aio/raster.py,sha256=dPCfoD-OP5o4lgX87edYDmOgl4R-APyaNcbU6H5Y13A,33084
+geobox/aio/query.py,sha256=oypo7QKPFUgGoZc5gNzy_s1JxaSGSO7xfmUMdEuL_vk,26838
+geobox/aio/raster.py,sha256=wPCoTHQlLAWieOuJsZCTewFz8tFeDHLIzuA7BCDZyRg,53233
 geobox/aio/route.py,sha256=YCTcAfaSFE429fpL4eIb2VrBEdBo6SmolPomVM1F66A,2854
 geobox/aio/scene.py,sha256=cxQdFkFD-Z-ZWJyhrW_W53DyUVILmEQgJoFaG3KU_FI,13130
 geobox/aio/settings.py,sha256=q1B2iZf0ekl21cByP5P9Z0ivWCDxw8UNi16NOXm76qA,7042
-geobox/aio/task.py,sha256=6TEwrBqpT3YWRLo9_c0U9WFs1SHsX3h5Xe0m7XbjHR4,15329
+geobox/aio/task.py,sha256=svwE65xih9WGm1bwSFcgJ8R9UAQiH0KiqfYTctMpdQw,15336
 geobox/aio/tile3d.py,sha256=QWYdmMQSlWqztflLTqFDqQaynkgRLoVZPF4NlwOMqDg,12935
 geobox/aio/tileset.py,sha256=LUsCtafwFCYqG41vNNlbe3GyWXjJ1_UYV-4o7-w-Xk8,27379
-geobox/aio/usage.py,sha256=AC2TPsomnK-W7EbXOGP6Flkkeh7n4KRCJmBuTdIofQo,9776
+geobox/aio/usage.py,sha256=bcfeNyKk1vm67K1aRT2XMnHazG3Ue93adCv3QY-Riok,9776
 geobox/aio/user.py,sha256=k3JCPQpwiIzJBP6xvKsPkueElW6e1i9a-odNAOIZB9U,18622
-geobox/aio/vectorlayer.py,sha256=1635i0Vc4mvcYmgTx53sanpZJYLe5Ho4YsO2pEPH23A,62087
+geobox/aio/vectorlayer.py,sha256=agiKbt4M1dVauCcYBhPB_n9ZeVruNEXmv8OGr4OSMOk,67234
 geobox/aio/version.py,sha256=HAKB9jHGZ0-EirNg9aNwYYPVFT3YOYQ0JNCxP7Nvk9g,11201
 geobox/aio/view.py,sha256=peTf__JNMqdiTb6VQeuhj_RqljzcskbwwDaHhQ3Cf9w,45353
-geobox/aio/workflow.py,sha256=itqTO7XlO1YmLd7pnS5BHhaC48ykEmYDXPs-2hDxey4,13411
-geobox-2.0.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
-geobox-2.0.0.dist-info/METADATA,sha256=wrMvTlsryT7tzWgl7NcLvaeVn8yxPB26qEgz5dijo68,2760
-geobox-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geobox-2.0.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
-geobox-2.0.0.dist-info/RECORD,,
+geobox/aio/workflow.py,sha256=PVw4S8P9bvuKtFwcwYQIoVAeBAsO5bxiPb-nGj56ifU,13411
+geobox-2.1.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
+geobox-2.1.0.dist-info/METADATA,sha256=BdUHYhcJq7NirDrtJIDhEQBfLKKZzvrz88znrJHlF5w,2760
+geobox-2.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geobox-2.1.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
+geobox-2.1.0.dist-info/RECORD,,