class ImageInfo in Tinman.Terrain.Imaging

Default implementation of the IImageInfo interface.

sealed class

ImageInfo

implements

IImageInfo

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<IImageInfo>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

public method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	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.

Public / Attributes

Coverage

The pixel coverage of the image.

public property	Coverage { get }
type	PixelCoverage
value		The pixel coverage.
implements	IImageInfo.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.

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

Remarks:

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

• V > 0
  Given a normalized image pixel value N, the resulting linear pixel value L is computed as L = pow(N, V).
• V = -2.2 (see GammaFromSrgb)
  The normalized image pixel value is fed into the FromSrgbF method and its return value is used as the linear pixel value.
• V = -0.45455 (see GammaToSrgb)
  The normalized image pixel value is fed into the ToSrgbF method and its return value is used as the linear pixel value (which is not correct in a mathematical sense, but might be necessary in rare cases).
• For all other values of V, the normalized and linear pixel values are treated as being equivalent.

See also:

IImageReader

Georef

Returns georeferencing information.

public property	Georef { get }
type	Raster
value		The georeferencing object or null if no georeferencing is available.
implements	IGeorefInfo.Georef

Height

Height of the image, in pixels.

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

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.

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

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.

public property	Layer { get }
type	HeightmapLayer
value		The target heightmap layer.
implements	IImageInfo.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.

public property	Map { get }
type	MapInfo
value		The map info value.
implements	IMapInfo.Map

NoData

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

public property	NoData { get }
type	float64
value		The nodata value.
implements	IImageInfo.NoData

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.

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

Remarks:

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

PixelFormat

The pixel format of the image.

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

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.

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

See also:

IImageReader

Width

Width of the image, in pixels.

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

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.

Public / Constructors

For

Returns an ImageInfo instance for the given image info.

public static method	For (IImageInfo source)
type	ImageInfo
params	source	[not-null]	The image info.
returns		[not-null]	The ImageInfo instance.

ImageInfo

Creates a new instance of ImageInfo.

public constructor	ImageInfo (int32 width, int32 height, PixelFormat pixelFormat = PixelFormat.Default, PixelRange range = )
params	width	[>0]	Width of the image, in pixels.
	height	[>0]	Height of the image, in pixels.
	pixelFormat		The pixel format of the image. Defaults to Default.
	range		The pixel range. Defaults to Default for pixelFormat.

Public / Methods

SetCoverage

Sets the pixel coverage.

public method	SetCoverage (PixelCoverage coverage)
type	ImageInfo
params	coverage		The pixel coverage.
returns		[not-null]	this

See also:

Coverage

SetFileInfo

Sets file specific information.

public method	SetFileInfo (Path pathInfo, ImageFormat format = null)
type	ImageInfo
params	pathInfo	[not-null]	The file path or Unknown.
	format		The file format. If null, Any will be used. Defaults to null.
returns		[not-null]	this

See also:

PathInfo
ImageFormat

SetGamma

Sets the gamma correction.

public method	SetGamma (float64 gamma)
type	ImageInfo
params	gamma		The gamma correction.
returns		[not-null]	this

See also:

Gamma

SetGeoref

Sets georeferencing information.

public method	SetGeoref (Raster georef)
type	ImageInfo
params	georef		The georef info object.
returns		[not-null]	this

See also:

Georef

SetLayer

Sets the target heightmap layer.

public method	SetLayer (HeightmapLayer layer)
type	ImageInfo
params	layer		The target heightmap layer.
returns		[not-null]	this

See also:

Layer

SetNoData

Sets the no-data raw pixel value.

public method	SetNoData (float64 noData)
type	ImageInfo
params	noData		The no-data value.
returns		[not-null]	this

See also:

NoData

ToString

[Pure]
public override method	ToString ()
type	string