class RasterTransformMatrix in Tinman.Terrain.Georef

A raster transform that uses a homogeneous 2D transformation matrix.

sealed class

RasterTransformMatrix

extends

RasterTransform

Remarks

The transformation matrix can be updated at any time.

Configuration

ToConfig

Returns the configuration value that describes this object.

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

Serialization

SerialId

Serialization information about this type.

public static readonly field	SerialId
type	ISerialTypeInfo

Public / Attributes

Bounds

The valid map bounds.

public property	Bounds { get set }
type	Box2D
value		The valid map bounds, or Max if disabled.

Remarks:

Set to Max to disable map bounds checking. If enabled, calls to MapToRaster and RasterToMap will return Undefined if the input resp. output map coordinates do not lie within the given bounds.

IsCubemap

Is this raster transform a placeholder for a cubemap raster?

public virtual property	IsCubemap { get }
type	bool
value		true if this raster transform is a cubemap raster placeholder, false if not.
inherited	RasterTransform.IsCubemap

Remarks:

A cubemap is composed of six two-dimensional rasters, one for each cubemap face. A georeferencing Raster only contains a single raster transform object which takes two-dimensional raster coordinates as input.

Matrix

Returns the homogeneous 2D transformation matrix that corresponds to this raster transform (i.e. RasterToMap).

public override property	Matrix { get }
type	Mat3D
value		The homogeneous 2D transformation matrix, or Zero if this raster transform cannot be represented with a matrix.
overrides	RasterTransform.Matrix

SerialType

Returns the serial type of this object.

public property	SerialType { get }
type	ISerialTypeInfo
value	[not-null]	The serial type.
inherited	SerializableBase.SerialType

SerialVersion

Returns the serial data version.

public virtual property	SerialVersion { get }
type	int32
value	[>=1]	The serial data version tag.
inherited	SerializableBase.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Public / Methods

Deserialize

Initializes the state of this object from the given data stream.

public override method	Deserialize (int32 serialVersion, ISerializer data)
type	ISerializable
params	serialVersion	[>=1]	The serial data version.
	data	[not-null]	The serial data stream.
returns		[not-null]	The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
overrides	SerializableBase.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

Equals

Compares this object with the given one.

[Pure]
public method	Equals (IRasterTransform other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
inherited	RasterTransform.Equals

MapToRaster

Translates the given map coordinates to raster coordinates.

[Pure]
public override method	MapToRaster (float64 x, float64 y)
type	Vec2D
params	x		The map X-coordinate.
	y		The map Y-coordinate.
returns			The raster coordinates.
implements	RasterTransform.MapToRaster

RasterOffset

Returns an IRasterTransform that translates the raster coordinates when applying this transform.

public virtual method	RasterOffset (float64 offsetX, float64 offsetY)
type	IRasterTransform
params	offsetX		The translation along the raster X-axis.
	offsetY		The translation along the raster Y-axis.
returns		[not-null]	The resulting raster transform.
inherited	RasterTransform.RasterOffset

Remarks:

The given coordinate offsets will be subtracted from the output raster coordinates of IRasterTransform and will be added to the input raster coordinates of IRasterTransform after resp. before plugging them into this raster transform.

RasterScale

Returns an IRasterTransform that scales the raster coordinates when applying this transform.

public virtual method	RasterScale (float64 scaleX, float64 scaleY)
type	IRasterTransform
params	scaleX		The scale factor along the raster X-axis.
	scaleY		The scale factor along the raster Y-axis.
returns		[not-null]	The resulting raster transform.
inherited	RasterTransform.RasterScale

Remarks:

The output raster coordinates of IRasterTransform will be divided by the given scale factors and the input raster coordinates of IRasterTransform will be multiplied with the scale factors after resp. before plugging them into this raster transform.

RasterToMap

Translates the given raster coordinates to map coordinates.

[Pure]
public override method	RasterToMap (float64 x, float64 y)
type	Vec2D
params	x		The raster X-coordinate.
	y		The raster Y-coordinate.
returns			The resulting map coordinates.
implements	RasterTransform.RasterToMap

Serialize

Serializes the current state of this object to the given data stream.

public override method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
overrides	SerializableBase.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

Set

Sets the transformation matrix.

public method	Set (Mat3D matrix)
params	matrix		The transformation matrix (see Matrix).