Package org.geotools.referencing.datum
Class DefaultImageDatum
- Object
-
- Formattable
-
- AbstractIdentifiedObject
-
- AbstractDatum
-
- DefaultImageDatum
-
- All Implemented Interfaces:
Serializable
,Datum
,ImageDatum
,IdentifiedObject
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.1
- Author:
- Martin Desruisseaux (IRD)
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class AbstractIdentifiedObject
EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR
-
Fields inherited from class Formattable
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
Constructors Constructor Description DefaultImageDatum(String name, PixelInCell pixelInCell)
Constructs an image datum from a name.DefaultImageDatum(Map<String,?> properties, PixelInCell pixelInCell)
Constructs an image datum from a set of properties.DefaultImageDatum(ImageDatum datum)
Constructs a new datum with the same values than the specified one.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(AbstractIdentifiedObject object, boolean compareMetadata)
Compare this datum with the specified object for equality.protected 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.int
hashCode()
Returns a hash value for this image datum.-
Methods inherited from class AbstractDatum
getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope
-
Methods inherited from class AbstractIdentifiedObject
asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches
-
Methods inherited from class Formattable
cleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKT
-
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 wrap an arbitrary implementation into a Geotools 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
-
getPixelInCell
public PixelInCell getPixelInCell()
Specification of the way the image grid is associated with the image data attributes.- Specified by:
getPixelInCell
in interfaceImageDatum
- Returns:
- The way image grid is associated with image data attributes.
-
equals
public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)
Compare this datum with the specified object for equality.- Overrides:
equals
in classAbstractDatum
- Parameters:
object
- The object to compare tothis
.compareMetadata
-true
for performing a strict comparaison, orfalse
for comparing only properties relevant to transformations.- Returns:
true
if both objects are equal.
-
hashCode
public int hashCode()
Returns a hash value for this image datum. Name, remarks and the like are not taken in account. In other words, two image datums will return the same hash value if they are equal in the sense ofequals
(AbstractIdentifiedObject, false)- Overrides:
hashCode
in classAbstractIdentifiedObject
- Returns:
- The hash code value. This value doesn't need to be the same in past or future versions of this class.
-
formatWKT
protected 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.
- Overrides:
formatWKT
in classAbstractDatum
- Parameters:
formatter
- The formatter to use.- Returns:
- The WKT element name.
- See Also:
Formattable.toWKT()
,Formattable.toString()
-
-