EcwDataSet Class
A dataset for reading ECW and JPEG 2000 files.
NuGet/Assembly: Carmenta.Engine.Ecw.5.16.2.nupkg (in the CEEcw assembly)
Syntax
public class EcwDataSet : MultiFileDataSetRemarks
This dataset reads databases in the ECW database format. The format was developed by Earth Resource Mapping and is now owned by ERDAS, which is owned by Intergraph. The databases usually consist of high resolution aerial or satellite photos. The dataset can also be used to read JPEG 2000 files.
Only version 2 of the ECW file format is currently supported. Trying to read an ECW version 3 file will generate an exception.
Both local files and Image Web Server URLs are accepted as file paths.
The resolution of the dataset is not fixed. The best possible resolution is usually determined by the dataset, so that one raster cell is about the size of one pixel on the screen. However, a Query instance may be used to control the actual resolution that will be read.
Important information regarding ECW runtime:
Because of ECW licensing issues, you need to do some extra steps and accept an additional license before before redistributing the ECW runtime files with your application. In some cases you may need to do this even to just use ECW data in an SDK installation.
On Windows, ECW runtime files are included with the SDK and Carmenta Studio installations, so you can use it in Carmenta Explorer and in your application. But to deploy your application with ECW support, or to use the ECW NuGet package in a .NET application, you need to execute the application "Carmenta Engine ECW Runtime Extractor.exe", located in the Carmenta Engine SDK root folder, and agree to the license terms. This will extract the ECW NuGet file to the packages folder, the ECW aar package for Android to the android folder, the ECW packages for Linux to the linux folder, and an ECW merge module to the redist folder.
On Linux, the ECW files are packaged as separate installation packages. You must select the ECW component and accept the additional license in the SDK or Carmenta Studio installer, to get access to these packages and use them in Carmenta Explorer or your applications.
Please refer to the ERDAS ECW/JP2 SDK pages at http://www.hexagongeospatial.com for more detailed information about restrictions that might apply when redistributing the runtime.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
FileDataSet
MultiFileDataSet
EcwDataSet
Platforms
Windows, Linux, Android
EcwDataSet Members
The EcwDataSet type has the following members.
Constructors
| Name | Description |
|---|---|
| EcwDataSet | Initializes a new instance of the EcwDataSet class. |
Properties
| Name | Description |
|---|---|
| Crs | Gets or sets the coordinate reference system of the EcwDataSet. 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 |
| 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 EcwDataSet 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 EcwDataSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current EcwDataSet represents. Inherited from EngineObject |
| Path | Gets or sets the path to the file or files to read from. Inherited from FileDataSet |
| 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 |
| 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 |