Raster Class
Represents raster data with or without color information.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class Raster : EngineObjectRemarks
Raster is used to store different types of raster data, with or without color information. It is typically used for storing images but it can also contain other types of data, for example height data.
A Raster by itself only represents the raster data, it has no geographic location. To associate raster data with a geographic location use a Feature with a RasterGeometry.
Limitations
The size limitation of an individual raster in 32bit is 128 MB. In 64bit, this limit is 512MB by default but can be removed completely with the Runtime.RasterSizeLimitEnabled method. There is no limit on the total size of several rasters except available memory resources.
A raster extent is limited by the bounds of the CRS that the raster is expressed in. These bounds can be obtained with the Crs.GetBoundary method.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Raster
Platforms
Windows, Linux, Android
Raster Members
The Raster type has the following members.
Constructors
| Name | Description |
|---|---|
| Raster | Initializes a new instance of the Raster class. |
Properties
| Name | Description |
|---|---|
| BitDepth | Gets the bit depth of the raster. |
| BytesPerRow | Gets the number of bytes used to store each row in the Raster. |
| Continuous | Gets or sets a value that determines whether the Raster is continuous. |
| Data | Gets a reference to the read/write raster data. |
| Format | Gets a value that tells what kind of data the Raster contains. |
| Height | Gets the height of the Raster. |
| IsDisposed | Gets a value that tells whether the current Raster has been disposed. Inherited from EngineObject |
| MaxValue | Gets the maximum value a cell in the Raster can contain. |
| MinValue | Gets the minimum value a cell in the Raster can contain. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Raster represents. Inherited from EngineObject |
| Palette | Gets or sets the palette of the Raster. |
| ReadOnlyData | Gets a reference to the read-only raster data. |
| UndefinedValue | Gets or sets the value used to represent undefined values in the Raster. |
| Width | Gets the width of the Raster. |
Methods
| Name | Description |
|---|---|
 CellValueToColor | Converts an integer cell value from an RGB or RGBA raster to a color value. |
| Clear | Overloaded. Resets all cells in the raster. |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| ColorToCellValue | Converts a color value to an equivalent cell value that can be written to an RGB or RGBA raster. |
| 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 |
| FromFile | Initializes a new instance of the Raster class from the specified image file. |
| FromStream | Initializes a new instance of the Raster class from the specified data. |
| GetCellValue | Gets the integer cell value at the specified coordinates. |
| GetFloatValue | Gets the float cell value at the specified coordinates. |
| GetImage | Overloaded. Saves the raster to a memory buffer, possibly with georeferencing information. |
| Save | Overloaded. Saves the raster to a file, possibly with georeferencing information. |
| SetCellValue | Sets the cell at the specified coordinates to the given integer value. |
| SetFloatValue | Sets the cell at the specified coordinates to the given float value. |