BandInfo#

class caris.coverage.Category#

Contains possible band categories.

  • SCALAR

  • STRING

  • STRING_TABLE

  • DATE

  • TIME

  • DATE_TIME

  • COLOR

  • FLAGSET

class caris.coverage.ColorFormat#

Contains possible color formats.

  • RGB

  • RGBA

class caris.coverage.DataType#

Contains the possible data types stored in the csar file.

  • FLOAT32

  • FLOAT64

  • INT8

  • UINT8

  • INT16

  • UINT16

  • INT32

  • UINT32

  • INT64

  • UINT64

class caris.coverage.Direction#

Contains unit direction types.

  • NAP

  • HEIGHT

  • DEPTH

  • GROUND

class caris.coverage.BandInfo([name=''[, type=DataType.FLOAT32[, tuple_length=0[, direction=Direction.NAP[, units=''[, category=Category.SCALAR[, color_format=ColorFormat.RGBA[, ndv=None[, minimum=None[, maximum=None[, level_policy=None[, follow_band_name=None[, string_table=None[, is_hidden=None[, true_pos_band_name=None]]]]]]]]]]]]]]])#

Band information

__init__()#

Constructor

Keyword Arguments:

  • name (str) – The band name

  • type (DataType, optional)

  • tuple_length (int) – Number of items in each point attribute for this band

  • direction (Direction) – Unit direction

  • units (str, optional) – Unit measurement (ex: "m", "ft")

  • category (Category, optional) – The type of attributes stored in this band

  • color_format (ColorFormat, optional) – The color format when category is COLOR

  • ndv – A tuple/value of size tuple_length containing the no-data-value (Optional)

  • minimum – A tuple/value of size tuple_length containing the minimum value (Optional)

  • maximum – A tuple/value of size tuple_length containing the maximum value (Optional)

  • level_policy (LevelPolicy, optional) – Policy for handling lower resolution levels

  • follow_band_name (str, optional) – Band to follow with follow level policy

  • string_table (list(str, optional)) – String table/list when the type is STRING_TABLE

  • is_hidden (bool, optional)) – Flag to hide this band

  • true_pos_band_name (str, optional) – Band to use to get the true positions of the data

property category#

The type of attributes stored in this band

Type:

Category

property color_format#

The color format when category is COLOR

Type:

ColorFormat

property direction#

Unit direction

Type:

Direction

property follow_band_name#

Band to follow with follow level policy

Type:

str

property is_hidden#

Flag to hide this band.

Type:

bool

property level_policy#

Policy for handling lower resolution levels

Type:

LevelPolicy

property maximum#

A tuple / value of size tuple_length containing the maximum value

property minimum#

A tuple/value of size tuple_length containing the minimum value

property name#

Band name

Type:

str

property ndv#

A tuple of size tuple_length containing the no-data-value

property numpy_dtype#

Data Type of numpy arrays returned for this band.

Type:

numpy.dtype

property string_table#

String table

Type:

list(str)

property true_pos_band_name#

Band to use to get the true positions of the data

Type:

str

property tuple_length#

Number of items in each point attribute for this band

Type:

int

property type#

Band type

Type:

DataType

property units#

Unit measurement (example “m”, “f”)

Type:

str