Class DefaultImageDatum
Object
FormattableObject
AbstractIdentifiedObject
AbstractDatum
DefaultImageDatum
- All Implemented Interfaces:
Serializable,Formattable,Deprecable,LenientComparable,Printable,Datum,ImageDatum,IdentifiedObject
@Deprecated(since="1.5",
forRemoval=true)
public final class DefaultImageDatum
extends AbstractDatum
implements ImageDatum
Deprecated, for removal: This API element is subject to removal in a future version.
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.
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.- Since:
- 0.4
- See Also:
-
Field Summary
Fields inherited from class AbstractDatum
ANCHOR_DEFINITION_KEY, ANCHOR_EPOCH_KEY, CONVENTIONAL_RS_KEY, PUBLICATION_DATE_KEYFields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEYFields inherited from interface Datum
ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEYFields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY -
Constructor Summary
ConstructorsModifierConstructorDescriptionDefaultImageDatum(Map<String, ?> properties, PixelInCell pixelInCell) Deprecated, for removal: This API element is subject to removal in a future version.Creates an image datum from the given properties.protectedDefaultImageDatum(ImageDatum datum) Deprecated, for removal: This API element is subject to removal in a future version.Creates a new datum with the same values as the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultImageDatumcastOrCopy(ImageDatum object) Deprecated, for removal: This API element is subject to removal in a future version.Returns a SIS datum implementation with the same values as the given arbitrary implementation.protected StringDeprecated, for removal: This API element is subject to removal in a future version.Formats this datum as a Well Known TextImageDatum[…]element.Class<? extends ImageDatum> Deprecated, for removal: This API element is subject to removal in a future version.Returns the GeoAPI interface implemented by this class.Deprecated, for removal: This API element is subject to removal in a future version.Specification of the way the image grid is associated with the image data attributes.Methods inherited from class AbstractDatum
castOrCopy, getAnchorDefinition, getAnchorEpoch, getAnchorPoint, getConventionalRS, getDomainOfValidity, getPublicationDate, getRealizationEpoch, getScope, isHeuristicMatchForNameMethods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecatedMethods inherited from class FormattableObject
print, toString, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface Datum
getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScopeMethods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Constructor Details
-
DefaultImageDatum
Deprecated, for removal: This API element is subject to removal in a future version.Creates an image datum from the given properties. The properties map is given unchanged to the super-class constructor. The following table is a reminder of main (not all) properties:Recognized properties (non exhaustive list) Property name Value type Returned by "name" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"domains" DefaultObjectDomain(optionally as array)AbstractIdentifiedObject.getDomains()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"anchorPoint" InternationalStringorStringAbstractDatum.getAnchorDefinition()"anchorEpoch"TemporalAbstractDatum.getAnchorEpoch()- Parameters:
properties- the properties to be given to the identified object.pixelInCell- the way the image grid is associated with the image data attributes.- See Also:
-
DefaultImageDatum
Deprecated, for removal: This API element is subject to removal in a future version.Creates a new datum with the same values as the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS 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.- See Also:
-
-
Method Details
-
castOrCopy
Deprecated, for removal: This API element is subject to removal in a future version.Returns a SIS datum implementation with the same values as the given arbitrary implementation. If the given object isnull, then this method returnsnull. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.- Parameters:
object- the object to get as a SIS implementation, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
-
getInterface
Deprecated, for removal: This API element is subject to removal in a future version.Returns the GeoAPI interface implemented by this class. The SIS implementation returnsImageDatum.class.Note for implementers
Subclasses usually do not need to override this method since GeoAPI does not defineImageDatumsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterfacein classAbstractDatum- Returns:
ImageDatum.classor a user-defined sub-interface.
-
getPixelInCell
Deprecated, for removal: This API element is subject to removal in a future version.Specification of the way the image grid is associated with the image data attributes.- Specified by:
getPixelInCellin interfaceImageDatum- Returns:
- the way image grid is associated with image data attributes.
-
formatTo
Deprecated, for removal: This API element is subject to removal in a future version.Formats this datum as a Well Known TextImageDatum[…]element.Compatibility note
ImageDatumis defined only in the first edition of the WKT 2 specification (ISO 19162:2015).- Overrides:
formatToin classAbstractDatum- Parameters:
formatter- the formatter where to format the inner content of this WKT element.- Returns:
"IDatum"or"ImageDatum".- See Also:
-
ImageDatumclass has been removed in ISO 19111:2019. It is replaced byEngineeringDatum.