TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

interface IImageInfo in Tinman.Terrain.Imaging

Provides information about an image.

interface IImageInfo extends IConfigurable
  IGeorefInfo
  IPathInfo
  base of IImageReader
  ImageInfo

Attributes

Coverage

The pixel coverage of the image.

property Coverage { get }
type PixelCoverage
value The pixel coverage.

Remarks:

Usually, images have a pixel coverage of PixelIsArea.

Gamma

The gamma correction that must be applied to normalized image pixels in order to obtain linear pixel values.

property Gamma { get }
type float64
value The gamma correction value (see remarks).

Remarks:

Depending on the value V of this property, the following gamma correction is applied:

See also:

IImageReader

Georef

Returns geo-referencing information.

property Georef { get }
type Raster
value The geo-referencing object or null if no geo-referencing is available.
inherited IGeorefInfo.Georef

Height

Height of the image, in pixels.

property Height { get }
type int32
value [>0] Height of the image, in pixels.

Remarks:

This is the number of image pixels along the Y-axis, which may be different from the raster height (see MapInfo), depending on the pixel coverage.

ImageFormat

The file format of the image file.

property ImageFormat { get }
type ImageFormat
value [not-null] The image file format.

Remarks:

The default file format is Any, which will try to load image data using any of the available image formats.

Layer

The heightmap layer which shall receive the data of this image.

property Layer { get }
type HeightmapLayer
value The target heightmap layer.

Remarks:

This is not an actual property of the image, but included here for convenience when images are imported into heightmap datasets.

Map

Returns a MapInfo value that describes the used map raster.

[Constant]
property Map { get }
type MapInfo
value The map info value.
inherited IMapInfo.Map

NoData

The raw pixel value that represents missing data (i.e. void pixels).

property NoData { get }
type float64
value The nodata value.

Remarks:

The default value is NanD (i.e. all raw pixel values are valid).

See also:

IImageReader

PathInfo

Returns a Path object that represents the file path this object is associated with.

property PathInfo { get }
type Path
value [not-null] The path info.
inherited IPathInfo.PathInfo

Remarks:

Objects that do not have a meaningful file path association simply return Unknown.

PixelFormat

The pixel format of the image.

property PixelFormat { get }
type PixelFormat
value The pixel format of the image.

Remarks:

Image processing is always performed with with four 24-bit integer channels (see Scanline). The pixel format provides additional information about the stored pixel data.

Range

The mapping between raw pixels values and normalized image pixels.

property Range { get }
type PixelRange
value The pixel range.

See also:

IImageReader

Width

Width of the image, in pixels.

property Width { get }
type int32
value [>0] Width of the image, in pixels.

Remarks:

This is the number of image pixels along the X-axis, which may be different from the raster width (see MapInfo), depending on the pixel coverage.

Methods

ToConfig

Returns the configuration value that describes this object.

method ToConfig ()
type ConfigValue
returns [not-null] The configuration value.
inherited IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Exceptions: