Cloud#

class caris.coverage.Cloud#

CSAR Point Cloud

add_band()#

Adds a new band

Parameters:

band_info (BandInfo) – The band info describing the band to be added

begin_transaction()#

Begin a new transaction

commit_transaction()#

Commit a transaction

create_copy()#

Creates a copy of this cloud

Either uri or path must be specified.

Keyword Arguments:

  • path (str) – The file path of the destination CSAR file

  • uri (str) – The file uri of the destination CSAR file.

query()#

Added in version 5.2.0: Added flags parameter.

Query values in the Cloud

When specifying flags, if any skipped flags exists in the specified band for a sounding, that sounding is skipped. For required flags, all specified flags must exist for that sounding to be returned. The user may specify flag option for any number of flagset bands by reapeating the flag options in a containing tuple.

Parameters:

  • bands (list(str), optional) – List of band names to query. If None all bands will be available.

  • box (((x1, y1), (x2, y2))) – Optional box to query

  • flags – Optional tuple of (BandName, SkippedFlags, RequiredFlags).

Returns:

Iterator that retuns dict(str: numpy.ndarray)

Return type:

BlockIterator

Example

To offer full flexbility, single flags may be specified without a tuple and required flags may be omitted if not used. The following are equivalent. This will skip any rejected soundings. flags=(‘Status’,(‘Rejected’,),()) flags=(‘Status’,’Rejected’)

This means for single flags, there is no need to include it in its own tuple.

For specifying multiple flag setting on multiple bands, here is an example of skipping all rejected flags while returning only soundings that have the Overlap LAS flag. In other words, only non-rejected Overlap soundings will be returned. flags=((‘Status’,’Rejected’),(‘LAS_Flags’,(),’Overlap’))

remove_band()#

Removes a band

Parameters:

band_name (str) – The name of the band to be removed

set_string_table()#

Added in version 5.3.0.

Replace a band’s string table

Parameters:

  • band_name (str) – The name of the band to update.

  • string_table (list(str)) – The new string table.

property band_info#

The band information

Type:

dict(BandInfo)

property bounding_polygon#

Added in version 5.1.0.

str: The bounding polygon in WKT format.

property extents#

The geographic extents of the point cloud

Type:

((x1, y1[, z1]),(x2, y2[, z2])) of float

property iso19139_xml#

The iso xml metadata.

Type:

str

property point_count#

The total number of points in the point cloud

Type:

int

property position_band_name#

The position band name.

Type:

str

property uri#

The uri of the opened csar file

Type:

str

property wkt_cosys#

The coordinate system in WKT format.

Type:

str