GdalDataSet Class
A datasets that reads several different raster data formats.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDataSets assembly)
Syntax
public class GdalDataSet : MultiFileDataSetRemarks
This dataset is a bridge to the third party library GDAL, Geospatial Data Abstraction Library. Please see Acknowledgments for copyright information.
Raster Formats Included in the Carmenta Engine GDAL Build
Note that Carmenta does not have access to test data for all formats listed below and that we therefore cannot guarantee that they will work as expected in Carmenta Engine.
GDAL code | Long format name | Alternative reader in Carmenta Engine |
|---|---|---|
AAIGrid | Arc/Info ASCII Grid | |
ACE2 | ACE2 | |
ADRG | ADRG/ARC Digitized Raster Graphics (.gen/.thf) | |
AIRSAR | AIRSAR Polarimetric | |
ARG | Azavea Raster Grid | |
BLX | Magellan BLX Topo (.blx, .xlb) | |
BMP | Microsoft Windows Device Independent Bitmap (.bmp) | |
BSB | BSB Nautical Chart Format (.kap) | |
BT | VTP Binary Terrain Format (.bt) | |
CALS | CALS Type I | |
CEOS | CEOS (Spot for instance) | |
COASP | DRDC COASP SAR Processor Raster | |
COSAR | TerraSAR-X Complex SAR Data Product | |
CPG | Convair PolGASP data | |
CTG | USGS LULC Composite Theme Grid | |
DIMAP | Spot DIMAP (metadata.dim) | |
DIPEx | ELAS DIPEx | |
DOQ1 | First Generation USGS DOQ (.doq) | |
DOQ2 | New Labelled USGS DOQ (.doq) | |
DTED | US Digital Terrain Elevation Data (.dt0, .dt1, .dt2) | |
E00GRID | Arc/Info Export E00 GRID | |
ECRGTOC | ECRG Table Of Contents (TOC.xml) | |
EHdr | ESRI .hdr Labelled (also known as ESRI BIL) | |
EIR | Erdas Imagine Raw | |
ELAS | NASA: Earth resources Laboratory Applications Software | |
ENVI | ENVI .hdr Labelled Raster | |
ERS | ERMapper ASCII Header | |
ESAT | Envisat Image Product (.n1) | |
FAST | EOSAT FAST Format | |
FIT | SGI FIT file format (not the same as FITS) | |
FujiBAS | Fuji BAS Scanner Image | |
GENBIN | Generic Binary (.hdr Labelled) | |
GFF | GSat File Format | |
GIF | Graphics Interchange Format (.gif) | |
GRASSASCIIGrid | GRASS ASCII Grid | |
GRIB | WMO GRIB1/GRIB2 (.grb) | |
GSAG | Golden Software ASCII Grid | |
GSBG | Golden Software Binary Grid | |
GS7BG | Golden Software Surfer 7 Binary Grid | |
GTiff | TIFF / BigTIFF / GeoTIFF (.tif) | |
GTX | NOAA .gtx vertical datum shift | |
GXF | GXF - Grid eXchange File | |
HF2 | HF2/HFZ heightfield raster | |
HFA | Erdas Imagine (.img) | |
IDA | Image Display and Analysis (WinDisp 4) | |
ILWIS | ILWIS Raster Map (.mpr,.mpl) | |
INGR | Intergraph Raster | |
IRIS | IRIS | |
ISCE | ISCE Raster | |
ISIS2, ISIS3 | USGS Astrogeology ISIS cube (versions 2 and 3) | |
JAXAPALSAR | JAXA PALSAR Product Reader (Level 1.1/1.5) | |
JDEM | Japanese DEM (.mem) | |
JPEG | JPEG JFIF (.jpg) | |
KMLSUPEROVERLAY | KMLSUPEROVERLAY | |
KRO | KOLOR Raw format | |
L1B | NOAA Polar Orbiter Level 1b Data Set (AVHRR) | |
LAN | Erdas 7.x .LAN and .GIS | |
LCP | FARSITE v.4 LCP Format | |
Leveller | Daylon Leveller Heightfield (.TER) | |
MAP | OziExplorer .MAP | |
MFF | Vexcel MFF (formerly Atlantis MFF) | |
MRF | Meta Raster Format | |
MSGN | EUMETSAT Archive native (.nat) | |
NDF | NLAPS Data Format | |
NGSGEOID | NOAA NGS Geoid Height Grids | |
NITF | National Imagery Transmission Format | |
NWT_GRC | Northwood/VerticalMapper Classified Grid Format .grc/.tab | |
NWT_GRD | Northwood/VerticalMapper Numeric Grid Format .grd/.tab | |
OZI | OZI OZF2/OZFX3 | |
Paux | PCI .aux Labelled Raw Format | |
PCIDSK | PCI Geomatics Database File | |
PCRaster | PCRaster (.map) | |
PDS | NASA Planetary Data System | |
PLMosaic | Planet Labs Mosaics API¹ | |
PNG | Portable Network Graphics (.png) | |
PNM | Netpbm (.ppm,.pgm) | |
PRF | PHOTOMOD raster file (.prf,.x-dem) | |
R | R Object Data Store | |
RIK | RIK format (.rik) of Swedish Land Survey | |
RMF | Raster Matrix Format (.rsw, .mtw) | |
ROI_PAC | ROI_PAC Raster | |
RPFTOC | Raster Product Format/RPF (a.toc) | |
RRASTER | R Raster (.grd) | |
RS2 | RadarSat2 XML (product.xml) | |
RST | Idrisi Raster Format (.rst, .rdc, .smp, .ref) | |
SAFE | Sentinel 1 SAR SAFE (manifest.safe) | |
SAGA | SAGA GIS Binary format | |
SAR_CEOS | CEOS SAR Image | |
SDTS | USGS SDTS DEM (CATD.DDF) | |
SENTINEL2 | Sentinel 2 | |
SGI | SGI Image Format | |
SNODAS | Snow Data Assimilation System | |
SRP | Standard Raster Product (ASRP/USRP) | |
SRTMHGT | SRTM HGT Format | |
TERRAGEN | Terragen Heightfield (.ter) | |
TIL | EarthWatch/DigitalGlobe .TIL | |
TSX | TerraSAR-X Product | |
USGSDEM | USGS ASCII DEM (.dem) | |
VICAR | VICAR | |
VRT | GDAL Virtual Format (.vrt) | |
WCS | OGC Web Coverage Service | |
WMS | OGC Web Map Service | |
WMTS | OGC Web Map Tile Service | |
XPM | X11 Pixmap (.xpm) | |
XYZ | ASCII Gridded XYZ | |
ZMap | ZMap Plus Grid |
¹Not included in the GDAL build for Android.
Most of these formats are described in more detail on www.gdal.org/formats_list.html, although some may be mentioned only on the News page available via www.gdal.org.
For various reasons, the GdalDataSet of Carmenta Engine does not give access to every format available in the GDAL library. A few of the formats that have been turned off can instead be read by other datasets in Carmenta Engine, for example ECW (EcwDataSet) and MrSID (MrSidDataSet).
Some formats can be read either by the GdalDataSet or by some other Carmenta Engine dataset, as the rightmost column shows. In these cases, we usually recommend using the alternative to GdalDataSet, but there may be some rare variants of the data formats for which GdalDataSet is better.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
FileDataSet
MultiFileDataSet
GdalDataSet
Platforms
Windows, Linux, Android
GdalDataSet Members
The GdalDataSet type has the following members.
Constructors
| Name | Description |
|---|---|
| GdalDataSet | Initializes a new instance of the GdalDataSet class. |
Properties
| Name | Description |
|---|---|
| Bounds | Gets or sets the bounding rectangle of the dataset. Inherited from DataSet |
| Continuous | Gets or sets a flag indicating whether rasters created by this dataset should be interpreted as being continuous or discrete. |
| CreateOverviews | Gets or sets a flag indicating if the dataset should create downsampled versions of the original data, to speed up reading. |
| Crs | Gets or sets the coordinate reference system of the GdalDataSet. Inherited from DataSet |
| DatumShiftChoice | Gets or sets a flag that tells how to choose a default datum shift for the Crs. |
| Description | Gets or sets a short description of the dataset. Inherited from DataSet |
| DisplayName | Gets or sets a display name for the dataset. Inherited from DataSet |
| FileName | Gets or sets the name of the file to read from. Inherited from FileDataSet |
| GroundControlPointsCrs | Gets or sets the coordinate reference system of the ground control points, if ground control points are present. |
| Id | Gets a unique identifier for this dataset instance. Inherited from DataSet |
| IndexFileName | Gets or sets an explicit index file name used for the generated index files in IndexPath. Inherited from MultiFileDataSet |
| IndexPath | Gets or sets the directory where the dataset index files are saved. Inherited from MultiFileDataSet |
| IsDisposed | Gets a value that tells whether the current GdalDataSet has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the dataset. Inherited from DataSet |
| MinimumTileHeight | Gets or sets the minimum height of raster tiles read from the GDAL library. |
| MinimumTileWidth | Gets or sets the minimum width of raster tiles read from the GDAL library. |
| Name | Gets or sets the name of the GdalDataSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current GdalDataSet represents. Inherited from EngineObject |
| OverviewCompression | Gets or sets the compression type to use when creating overviews. |
| OverviewDivisionFactor | Gets or sets how much smaller an overview image is compared to the original data (or parent overview image). |
| OverviewResamplingMethod | Gets or sets the resampling method to use when creating overviews. |
| Path | Gets or sets the path to the file or files to read from. Inherited from FileDataSet |
| RasterCacheCompression | Gets or sets a value that controls which method is used to compress the tiles in a raster cache. |
| RasterCacheFilter | Gets or sets the down-sampling filter to use when creating raster overviews. |
| RasterCachePolicy | Gets or sets a value indicating the type of raster caching the dataset should use. |
| RasterFilter | Gets or sets the filter that will be used by the RasterVisualizer attached to rasters created by the dataset. |
| SearchSubdirectories | Gets or sets a flag indicating if the dataset will search for data files recursively. Inherited from MultiFileDataSet |
| SuppressInitializationErrors | Gets or sets a flag indicating how errors during dataset initialization are handled. Inherited from DataSet |
| UndefinedValue | Gets or sets the cell value that should be interpreted as no data. |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| VerifyIndexFiles | Gets or sets a flag indicating if the contents of index files should be verified before use. Inherited from MultiFileDataSet |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from DataSet |
| FlushCache | Frees any information the dataset may have cached, including all cached features. Inherited from DataSet |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from DataSet |
| GetDataCoverage | Gets coverage information for this dataset in a given area. Inherited from DataSet |
 GetDataSetById | Looks up an existing dataset instance from a dataset identity. Inherited from DataSet |
| GetDataSetInfo | Returns a dataset info that describes the contents of this dataset. Inherited from DataSet |
| GetDataSetInfoAsync | Makes an asynchronous call to GetDataSetInfo. Inherited from DataSet |
| GetFeature | Gets the feature with the specified identity. Inherited from DataSet |
| GetFeatures | Overloaded. Gets features from the dataset. Inherited from DataSet |
| GetFloatValueAt | Overloaded. Gets the float raster value from a cell at the specified position. Inherited from DataSet |
| GetFloatValuesAt | Overloaded. Gets a number of float raster values. Inherited from DataSet |
| GetLocalizedDescription | Gets a localized version of the dataset description in a specific language. Inherited from DataSet |
| GetLocalizedDisplayName | Gets a localized version of the dataset display name in a specific language. Inherited from DataSet |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from DataSet |
| GetNormalizedFloatValueAt | Overloaded. Gets the raster value from a cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| GetNormalizedFloatValuesAt | Overloaded. Gets a number of raster values, normalized by Scale and Offset. Inherited from DataSet |
| GetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |
| GetValuesAt | Overloaded. Gets a number of raster values. Inherited from DataSet |
| HasLocalizedDescription | Checks if a localized version of the dataset description is available in a specific language. Inherited from DataSet |
| HasLocalizedDisplayName | Checks if a localized version of the dataset display name is available in a specific language. Inherited from DataSet |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from DataSet |
| HighestRasterValue | Finds the highest raster value inside the given polygon. Inherited from DataSet |
| Initialize | Initializes the dataset. Inherited from DataSet |
| SetLocalizedDescription | Sets a dataset description in a specific language. Inherited from DataSet |
| SetLocalizedDisplayName | Sets a dataset display name in a specific language. Inherited from DataSet |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the dataset, for a specific language. Inherited from DataSet |
| TryGetFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position. Inherited from DataSet |
| TryGetNormalizedFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| TryGetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |