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[, bounding_polygon = ''[, band_info = None[, extents = None[, iso19139_xml = None[, wkt_cosys = None[, position_band_name = None[, iterator = None[, dims = None[, elevation_band_name = None[, pixel_type = None[, raster2geo_matrix = None[, raster_read_callback_func = None]]]]]]]]]]]]]]])¶
Read and/or write options when opening a csar file.
- __init__()¶
Constructor
- Keyword Arguments
open_type (
OpenType) – The open modelog_callback_func (func(log_callback_user_data, message) -> int) – Callback function for log information. Should return 0 on success.
log_callback_user_data – Callback data to pass to log callback function.
bounding_polygon (
str) – The bounding polygon in WKT formatband_info (dict(
BandInfo)) – Dictionary ofBandInfospecifying what bands to create [Used during creation only].extents ((x1, y1[, z1]), (x2, y2[, z2])) of double) – The geographic extents of the new raster (2D) or point cloud (2D or 3D depending on position band tuple length) [Used during creation only]
iso19139_xml (
str) – The iso xml data to output [Used during creation only]wkt_cosys (
str) – The coordinate system in WKT format [Used during creation only]position_band_name (
str) – Position band name [Used during point cloud creation only]iterator – Block iterator that gives a dictionary (key=band_name, value=list_of_points) at each iteration [Used during point cloud creation only]
dims ((width, height) of
int) – The dimensions of the raster [Used during raster creation only]elevation_band_name (
str) – Elevation band name [Used during raster creation only]pixel_type (
PixelType) – The pixel type of the raster [Used during raster creation only]raster2geo_matrix ((ofsx, res_xx, res_xy, ofsy, res_yx, res_yy) of float) – The raster to geo transform matrix. res_xy and res_yx are usually 0 if no rotation. [Used during raster creation only]
raster_read_callback_func (Callable[[str, ((int, int), (int, int))], [object]]) – (func(band_name : str, gridBox : ((x1, y1), (x2, y2)) of int [, level : int]) -> 1D list of elements in grid)
- property band_info¶
Dictionary of
BandInfospecifying what bands to create [Used during creation only].- Type
- property bounding_polygon¶
New in version 5.6.6.
str: The bounding polygon in WKT format.
- property dims¶
The dimensions of the raster [Used during raster creation only] (width, height).
- property extents¶
The geographic extents of the new raster (2D) or point cloud (2D or 3D depending on position band tuple length) [Used during creation only].
- Type
((x1, y1[, z1]), (x2, y2[, z2]))
- property iterator¶
Block iterator that gives a dictionary (key=band_name, value=numpy_array) at each iteration [Used during point cloud creation only].
- Type
- property log_callback_func¶
Callback function for log information. Takes log_user_callback_data and a message. Should return 0 on success.
- property log_callback_user_data¶
Callback data to pass to log callback function.
- property pixel_type¶
The pixel type of the raster [Used during raster creation only].
- Type
- property raster2geo_matrix¶
The raster to geo transform matrix [Used during raster creation only](ofsx, res_xx, res_xy, ofsy, res_yx, res_yy) of float
- property raster_read_callback_func¶
The read callback function for rasters [Used during raster creation only]. It takes the band name and extents, returns a 1d list of elements
