org.geotoolkit.referencing.datum
Class DefaultImageDatum

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractDatum
              DefaultImageDatum

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, Datum, ImageDatum, IdentifiedObject

@Immutable
public class DefaultImageDatum
extends AbstractDatum
implements ImageDatum

Defines the origin of an image coordinate reference system. An image datum is used in a local context only. For an image datum, the anchor point is usually either the centre of the image or the corner of the image.

Since:

2.0

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultImageDatum(ImageDatum datum)
Constructs a new datum with the same values than the specified one.

DefaultImageDatum(Map<String,?> properties, PixelInCell pixelInCell)
Constructs an image datum from a set of properties.

DefaultImageDatum(String name, PixelInCell pixelInCell)
Constructs an image datum from a name.

Method Summary

static DefaultImageDatum	castOrCopy(ImageDatum object) Returns a Geotk datum implementation with the same values than the given arbitrary implementation.
protected int	computeHashCode() Computes a hash value for this identified object.
boolean	equals(Object object, ComparisonMode mode) Compare this datum with the specified object for equality.
String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.
PixelInCell	getPixelInCell() Specification of the way the image grid is associated with the image data attributes.
static DefaultImageDatum	wrap(ImageDatum object) Deprecated. Renamed castOrCopy.

Methods inherited from class AbstractDatum

getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope

Methods inherited from class AbstractIdentifiedObject

equals, getAlias, getIdentifier, getIdentifiers, getName, getName, getRemarks, hashCode, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Datum

getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

DefaultImageDatum

public DefaultImageDatum(ImageDatum datum)

Constructs a new datum with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a Geotk one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.

Parameters:

datum - The datum to copy.

Since:

2.2

DefaultImageDatum

public DefaultImageDatum(String name,
                         PixelInCell pixelInCell)

Constructs an image datum from a name.

Parameters:

name - The datum name.

pixelInCell - the way the image grid is associated with the image data attributes.

DefaultImageDatum

public DefaultImageDatum(Map<String,?> properties,
                         PixelInCell pixelInCell)

Constructs an image datum from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

pixelInCell - the way the image grid is associated with the image data attributes.

Method Detail

castOrCopy

public static DefaultImageDatum castOrCopy(ImageDatum object)

Returns a Geotk datum implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

wrap

@Deprecated
public static DefaultImageDatum wrap(ImageDatum object)

Deprecated. Renamed castOrCopy.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

The given object as a Geotk implementation.

getPixelInCell

public PixelInCell getPixelInCell()

Specification of the way the image grid is associated with the image data attributes.

Specified by:

getPixelInCell in interface ImageDatum

Returns:

The way image grid is associated with image data attributes.

equals

public boolean equals(Object object,
                      ComparisonMode mode)

Compare this datum with the specified object for equality.

Specified by:

equals in interface LenientComparable

Overrides:

equals in class AbstractDatum

Parameters:

object - The object to compare to this.

mode - STRICT for performing a strict comparison, or IGNORE_METADATA for comparing only properties relevant to transformations.

Returns:

true if both objects are equal.

computeHashCode

protected int computeHashCode()

Computes a hash value for this identified object. This method is invoked by AbstractIdentifiedObject.hashCode() when first needed.

Implementation specific feature
In the Geotk implementation, the name, identifiers and remarks are not used for hash code computation. Consequently two identified objects will return the same hash value if they are equal in the sense of equals(…, ComparisonMode.IGNORE_METADATA). This feature allows users to implement metadata-insensitive HashMap.

Overrides:

computeHashCode in class AbstractIdentifiedObject

Returns:

The hash code value. This value may change between different execution of the Geotk library.

formatWKT

public String formatWKT(Formatter formatter)

Format the inner part of a Well Known Text (WKT) element.

Note: WKT of image datum is not yet part of OGC specification.

Specified by:

formatWKT in interface Formattable

Overrides:

formatWKT in class AbstractDatum

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name.

See Also:

FormattableObject.toWKT(), FormattableObject.toString()