HdrDataSet Class
A dataset for reading .hdr files and corresponding binary raster files.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDataSets assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDataSets assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class HdrDataSet : MultiFileDataSetRemarks
This dataset reads uncompressed raster files with accompanying header files, usually with a .hdr extension. The header file is described below. This header format is used for various databases such as GTOPO30 DEM data from USGS and by various tools such as ArcView.
The header files consist of rows with a tag followed by a value. The following tags are read from the header file:
Tag | Allowed values | Comment |
|---|---|---|
# | Comment, row ignored | |
BYTEORDER | I, M | Intel or Motorola byte order |
LAYOUT | BIL, BIP, BSQ | Defines if the image is Band Interleaved by Line, Band Interleaved by Point or Band SeQuential. |
NROWS | Number of pixel rows in image. | |
NCOLS | Number of pixel columns in image. | |
NBANDS | Number of bands in image. | |
NBITS | 1, 2, 4, 8, 16, 32 | Number of bits per band in image. |
BANDROWBYTES | Number of bytes per band per row. | |
TOTALROWBYTES | Total number of bytes per row. | |
NODATA | Value which should be treated as undefined (undefinedValue). | |
ULXMAP | Geographic x coordinate for the center of the upper left pixel. | |
ULYMAP | Geographic y coordinate for the center of the upper left pixel. | |
XDIM | Geographic width of one pixel | |
YDIM | Geographic height of one pixel |
Header file tags
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
FileDataSet
MultiFileDataSet
HdrDataSet
Platforms
Windows, Linux, Android
HdrDataSet Members
The HdrDataSet type has the following members.
Constructors
| Name | Description |
|---|---|
| HdrDataSet | Initializes a new instance of the HdrDataSet class. |
Properties
| Name | Description |
|---|---|
| AllowNegativeValues | Gets or sets a flag indicating if negative raster values should be replaced by 0. |
| Band | Gets or sets the raster band that should be read. |
| Continuous | Gets or sets a flag indicating if rasters created by this dataset should be interpreted as continuous or discrete. |
| Crs | Gets or sets the coordinate reference system of the HdrDataSet. Inherited from DataSet |
| 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 |
| HeaderFileExtension | Gets or sets the extension for the header files. |
| 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 HdrDataSet has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the dataset. Inherited from DataSet |
| Name | Gets or sets the name of the HdrDataSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current HdrDataSet represents. Inherited from EngineObject |
| 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. |
| 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 |
| TopFirst | Gets or sets a flag indicating if rasters are stored with the top or bottom row first. |
| 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 |