Options¶

class caris.coverage.OpenType¶

Contains open modes for csar files. Note that if xml metadata is to be written out to a pre-existing file,use WRITE mode.

• READ
• WRITE

class caris.coverage.Options([open_type = OpenType.READ[, log_callback_func = None[, log_callback_user_data = None[, iso19139_xml = ''[, wkt_cosys = None[, dims = None[, raster_read_callback_func = None[, pixel_type = None[, raster2geo_matrix = None]]]]]]]]])¶

Read and/or write options when opening a csar file.

band_info¶

Dictionary of BandInfo specifying what bands to create [Used during creation only]

Type:	dict of BandInfo

dims¶

The dimensions of the raster [Used during raster creation only]

Type:	(width, height) of int

extents¶

The extents of the new raster (2D) or point cloud (3D) [Used during creation only]

Type:	((x1, y1[, z1]), (x2, y2[, z2])) of double

iso19139_xml¶

The iso xml data to output [Used during creation only]

Type:	str

iterator¶

Block iterator that gives a dictionary (key=band_name, value=list_of_points) at each iteration [Used during point cloud creation only]

log_callback_func¶

Callback function for log information. Should return 0 on success.

Type:	func(log_callback_user_data, message : str) -> int

log_callback_user_data¶

Callback data to pass to log callback function

open_type¶

Open mode

Type:	OpenType

pixel_type¶

The pixel type of the raster [Used during raster creation only]

Type:	PixelType

position_band_name¶

Position band name [Used during point cloud creation only]

Type:	str

raster2geo_matrix¶

The raster to geo transform matrix [Used during raster creation only]

Type:	(ofsx, res_xx, res_xy, ofsy, res_yx, res_yy) of double

raster_read_callback_func¶

The read callback function for rasters [Used during raster creation only]

Type:	func(band_name : str, gridBox : ((x1, y1), (x2, y2)) of int [, level : int]) -> 1D list of elements in grid.

wkt_cosys¶

The coordinate system in WKT format [Used during creation only]

Type:	str