src.api.catacloud.caclpcloud_ops

Classes

class src.api.catacloud.caclpcloud_ops.CaClPcloudOps(ses: CaClSession)

Class that supports operations on point clouds in the Catacloud platform through its API (typically as LAS/LAZ files).

Variables:

pagination_size (int) – The pagination size to be used when retrieving the list of available point clouds.
hash_buffer_size (int) – The buffer size (in bytes) to be used when hashing a point cloud file.
upload_chunk_size (int) – The chunk size (in bytes) to be used when uploading a point cloud to the Catacloud platform.
download_chunk_size (int) – The chunk size (in bytes) to be used when downloading a point cloud from the Catacloud platform.

__init__(ses: CaClSession): Instantiate a Catacloud point cloud operations object.

ls()

List available point clouds in the Catacloud platform.

rm(file_id)

Remove a point cloud from the Catacloud platform.

Parameters:: file_id (str) – The identifier of the point cloud to be removed from the Catacloud platform.
Returns:: Dictionary with the contents of the answer to the request.
Return type:: dict

pull(file_id, out_path)

Download a point cloud given its file id from the Catacloud platform.

Parameters:

file_id (str) – The identifier of the point cloud file to download.
out_path (str) – The local path where the downloaded point cloud will be written.

Returns:

Nothing at all but the point cloud file is written to the specified local path.

Return type:

None

push(las_path, pcloud_description=None)

Upload a LAS/LAZ file representing a point cloud to the Catacloud platform.

Parameters:

las_path (str) – Path to the LAS/LAZ file to upload.
pcloud_description (str or None) – The description (optional) for the point cloud.

Returns:

Nothing at all.