Dataset

class bagPy.Dataset[source]

Bases: object

Proxy of C++ BAG::Dataset class.

Attributes Summary

thisown

The membership flag

Methods Summary

close(Dataset self)

create(std, Metadata metadata, ...)

param fileName:

createGeorefMetadataLayer(Dataset self, BAG, ...)

param indexType:

createMetadataProfileGeorefMetadataLayer(...)

param profile:

createSimpleLayer(Dataset self, BAG, ...)

param type:

createSurfaceCorrections(Dataset self, ...)

param type:

createVR(Dataset self, uint64_t chunkSize, ...)

param chunkSize:

geoToGrid(Dataset self, double x, double y)

param x:

getDescriptor(Dataset self)

getGeorefMetadataLayer(Dataset self, std)

param name:

getGeorefMetadataLayers(Dataset self)

getLayer(Dataset self, uint32_t id)

param id:

getLayerTypes(Dataset self)

getLayers(Dataset self)

getMetadata(Dataset self)

getSimpleLayer(Dataset self, BAG)

param type:

getSurfaceCorrections(Dataset self)

getTrackingList(Dataset self)

getVRMetadata(Dataset self)

getVRNode(Dataset self)

getVRRefinements(Dataset self)

getVRTrackingList(Dataset self)

gridToGeo(Dataset self, uint32_t row, ...)

param row:

openDataset(std, BAG)

param fileName:

Attributes Documentation

thisown

The membership flag

Methods Documentation

close(Dataset self)[source]
static create(std::string const & fileName, Metadata metadata, uint64_t chunkSize, int compressionLevel) → std::shared_ptr< BAG::Dataset >[source]
Parameters:

  • fileName (std::string const &) –

  • metadata (BAG::Metadata &&) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createGeorefMetadataLayer(Dataset self, BAG::DataType indexType, BAG::GeorefMetadataProfile profile, std::string const & name, RecordDefinition definition, uint64_t chunkSize, int compressionLevel) → GeorefMetadataLayer[source]
Parameters:

  • indexType (enum BAG::DataType) –

  • profile (enum BAG::GeorefMetadataProfile) –

  • name (std::string const &) –

  • definition (BAG::RecordDefinition const &) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createMetadataProfileGeorefMetadataLayer(Dataset self, BAG::GeorefMetadataProfile profile, std::string const & name, uint64_t chunkSize, int compressionLevel, BAG::DataType keyType=DT_UINT16) → GeorefMetadataLayer[source]
Parameters:

  • profile (enum BAG::GeorefMetadataProfile) –

  • name (std::string const &) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

  • keyType (enum BAG::DataType) –

createSimpleLayer(Dataset self, BAG::LayerType type, uint64_t chunkSize, int compressionLevel) → Layer[source]
Parameters:

  • type (enum BAG::LayerType) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createSurfaceCorrections(Dataset self, BAG_SURFACE_CORRECTION_TOPOGRAPHY type, uint8_t numCorrectors, uint64_t chunkSize, int compressionLevel) → SurfaceCorrections[source]
Parameters:

  • type (enum BAG_SURFACE_CORRECTION_TOPOGRAPHY) –

  • numCorrectors (uint8_t) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createVR(Dataset self, uint64_t chunkSize, int compressionLevel, bool makeNode)[source]
Parameters:

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

  • makeNode (bool) –

geoToGrid(Dataset self, double x, double y) → UInt32Pair[source]
Parameters:

  • x (double) –

  • y (double) –

getDescriptor(Dataset self) → Descriptor[source]
getGeorefMetadataLayer(Dataset self, std::string const & name) → std::shared_ptr< BAG::GeorefMetadataLayer >[source]
Parameters:

name (std::string const &) –

getGeorefMetadataLayers(Dataset self) → GeorefMetadataLayerVector[source]
getLayer(Dataset self, uint32_t id) → Layer[source]
Parameters:

  • id (uint32_t) –

  • self (getLayer(Dataset) –

  • type (enum BAG::LayerType) –

  • > (std::string const & name) -> std::shared_ptr< BAG::Layer) –

  • type –

  • name (std::string const &) –

getLayerTypes(Dataset self) → LayerTypeVector[source]
getLayers(Dataset self) → LayerVector[source]
getMetadata(Dataset self) → Metadata[source]
getSimpleLayer(Dataset self, BAG::LayerType type) → std::shared_ptr< BAG::SimpleLayer >[source]
Parameters:

type (enum BAG::LayerType) –

getSurfaceCorrections(Dataset self) → std::shared_ptr< BAG::SurfaceCorrections >[source]
getTrackingList(Dataset self) → TrackingList[source]
getVRMetadata(Dataset self) → std::shared_ptr< BAG::VRMetadata >[source]
getVRNode(Dataset self) → std::shared_ptr< BAG::VRNode >[source]
getVRRefinements(Dataset self) → std::shared_ptr< BAG::VRRefinements >[source]
getVRTrackingList(Dataset self) → std::shared_ptr< BAG::VRTrackingList >[source]
gridToGeo(Dataset self, uint32_t row, uint32_t column) → DoublePair[source]
Parameters:

  • row (uint32_t) –

  • column (uint32_t) –

static openDataset(std::string const & fileName, BAG::OpenMode openMode) → std::shared_ptr< BAG::Dataset >[source]
Parameters:

  • fileName (std::string const &) –

  • openMode (enum BAG::OpenMode) –

__init__(*args, **kwargs)[source]
close(Dataset self)[source]
static create(std::string const & fileName, Metadata metadata, uint64_t chunkSize, int compressionLevel) → std::shared_ptr< BAG::Dataset >[source]
Parameters:

  • fileName (std::string const &) –

  • metadata (BAG::Metadata &&) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createGeorefMetadataLayer(Dataset self, BAG::DataType indexType, BAG::GeorefMetadataProfile profile, std::string const & name, RecordDefinition definition, uint64_t chunkSize, int compressionLevel) → GeorefMetadataLayer[source]
Parameters:

  • indexType (enum BAG::DataType) –

  • profile (enum BAG::GeorefMetadataProfile) –

  • name (std::string const &) –

  • definition (BAG::RecordDefinition const &) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createMetadataProfileGeorefMetadataLayer(Dataset self, BAG::GeorefMetadataProfile profile, std::string const & name, uint64_t chunkSize, int compressionLevel, BAG::DataType keyType=DT_UINT16) → GeorefMetadataLayer[source]
Parameters:

  • profile (enum BAG::GeorefMetadataProfile) –

  • name (std::string const &) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

  • keyType (enum BAG::DataType) –

createSimpleLayer(Dataset self, BAG::LayerType type, uint64_t chunkSize, int compressionLevel) → Layer[source]
Parameters:

  • type (enum BAG::LayerType) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createSurfaceCorrections(Dataset self, BAG_SURFACE_CORRECTION_TOPOGRAPHY type, uint8_t numCorrectors, uint64_t chunkSize, int compressionLevel) → SurfaceCorrections[source]
Parameters:

  • type (enum BAG_SURFACE_CORRECTION_TOPOGRAPHY) –

  • numCorrectors (uint8_t) –

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

createVR(Dataset self, uint64_t chunkSize, int compressionLevel, bool makeNode)[source]
Parameters:

  • chunkSize (uint64_t) –

  • compressionLevel (int) –

  • makeNode (bool) –

geoToGrid(Dataset self, double x, double y) → UInt32Pair[source]
Parameters:

  • x (double) –

  • y (double) –

getDescriptor(Dataset self) → Descriptor[source]
getGeorefMetadataLayer(Dataset self, std::string const & name) → std::shared_ptr< BAG::GeorefMetadataLayer >[source]
Parameters:

name (std::string const &) –

getGeorefMetadataLayers(Dataset self) → GeorefMetadataLayerVector[source]
getLayer(Dataset self, uint32_t id) → Layer[source]
Parameters:

  • id (uint32_t) –

  • self (getLayer(Dataset) –

  • type (enum BAG::LayerType) –

  • > (std::string const & name) -> std::shared_ptr< BAG::Layer) –

  • type –

  • name (std::string const &) –

getLayerTypes(Dataset self) → LayerTypeVector[source]
getLayers(Dataset self) → LayerVector[source]
getMetadata(Dataset self) → Metadata[source]
getSimpleLayer(Dataset self, BAG::LayerType type) → std::shared_ptr< BAG::SimpleLayer >[source]
Parameters:

type (enum BAG::LayerType) –

getSurfaceCorrections(Dataset self) → std::shared_ptr< BAG::SurfaceCorrections >[source]
getTrackingList(Dataset self) → TrackingList[source]
getVRMetadata(Dataset self) → std::shared_ptr< BAG::VRMetadata >[source]
getVRNode(Dataset self) → std::shared_ptr< BAG::VRNode >[source]
getVRRefinements(Dataset self) → std::shared_ptr< BAG::VRRefinements >[source]
getVRTrackingList(Dataset self) → std::shared_ptr< BAG::VRTrackingList >[source]
gridToGeo(Dataset self, uint32_t row, uint32_t column) → DoublePair[source]
Parameters:

  • row (uint32_t) –

  • column (uint32_t) –

static openDataset(std::string const & fileName, BAG::OpenMode openMode) → std::shared_ptr< BAG::Dataset >[source]
Parameters:

  • fileName (std::string const &) –

  • openMode (enum BAG::OpenMode) –

property thisown

The membership flag