Package org.apache.sis.referencing.crs
Class DefaultImageCRS
- Object
-
- FormattableObject
-
- AbstractIdentifiedObject
-
- AbstractReferenceSystem
-
- AbstractCRS
-
- DefaultImageCRS
-
- All Implemented Interfaces:
Serializable
,Deprecable
,LenientComparable
,CoordinateReferenceSystem
,ImageCRS
,SingleCRS
,IdentifiedObject
,ReferenceSystem
public class DefaultImageCRS extends AbstractCRS implements ImageCRS
A 2-dimensional engineering coordinate reference system applied to locations in images. Image coordinate reference systems are treated as a separate sub-type because a separate user community exists for images with its own terms of reference.Used with datum type: Image.
Used with coordinate system types: Cartesian or Affine.Immutability and thread safetyThis class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances 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:
DefaultImageDatum
,GeodeticAuthorityFactory.createImageCRS(String)
, Serialized Form
Defined in the
sis-referencing
module
-
-
Field Summary
-
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
-
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
Fields inherited from interface ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
-
-
Constructor Summary
Constructors Modifier Constructor Description DefaultImageCRS(Map<String,?> properties, ImageDatum datum, AffineCS cs)
Creates a coordinate reference system from the given properties, datum and coordinate system.protected
DefaultImageCRS(ImageCRS crs)
Constructs a new coordinate reference system with the same values than the specified one.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultImageCRS
castOrCopy(ImageCRS object)
Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.DefaultImageCRS
forConvention(AxesConvention convention)
Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected String
formatTo(Formatter formatter)
Formats this CRS as a Well Known TextImageCRS[…]
element.AffineCS
getCoordinateSystem()
Returns the coordinate system.ImageDatum
getDatum()
Returns the datum.Class<? extends ImageCRS>
getInterface()
Returns the GeoAPI interface implemented by this class.-
Methods inherited from class AbstractCRS
castOrCopy, computeHashCode, equals
-
Methods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScope
-
Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
-
Methods inherited from class FormattableObject
print, toString, toString, toWKT
-
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Methods inherited from interface ReferenceSystem
getDomainOfValidity, getScope
-
-
-
-
Constructor Detail
-
DefaultImageCRS
public DefaultImageCRS(Map<String,?> properties, ImageDatum datum, AffineCS cs)
Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than for 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" ReferenceIdentifier
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system.- See Also:
GeodeticObjectFactory.createImageCRS(Map, ImageDatum, AffineCS)
-
DefaultImageCRS
protected DefaultImageCRS(ImageCRS crs)
Constructs a new coordinate reference system with the same values than 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:
crs
- the coordinate reference system to copy.- See Also:
castOrCopy(ImageCRS)
-
-
Method Detail
-
castOrCopy
public static DefaultImageCRS castOrCopy(ImageCRS object)
Returns a SIS coordinate reference system implementation with the same values than 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, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
-
getInterface
public Class<? extends ImageCRS> getInterface()
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsImageCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineImageCRS
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classAbstractCRS
- Returns:
ImageCRS.class
or a user-defined sub-interface.
-
getDatum
public ImageDatum getDatum()
Returns the datum.- Specified by:
getDatum
in interfaceImageCRS
- Specified by:
getDatum
in interfaceSingleCRS
- Returns:
- the datum.
-
getCoordinateSystem
public AffineCS getCoordinateSystem()
Returns the coordinate system.- Specified by:
getCoordinateSystem
in interfaceCoordinateReferenceSystem
- Specified by:
getCoordinateSystem
in interfaceImageCRS
- Specified by:
getCoordinateSystem
in interfaceSingleCRS
- Overrides:
getCoordinateSystem
in classAbstractCRS
- Returns:
- the coordinate system.
-
forConvention
public DefaultImageCRS forConvention(AxesConvention convention)
Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returnsthis
.- Overrides:
forConvention
in classAbstractCRS
- Parameters:
convention
- the axes convention for which a coordinate reference system is desired.- Returns:
- a coordinate reference system compatible with the given convention (may be
this
). - See Also:
AbstractCS.forConvention(AxesConvention)
-
formatTo
protected String formatTo(Formatter formatter)
Formats this CRS as a Well Known TextImageCRS[…]
element.Compatibility note:ImageCRS
are defined in the WKT 2 specification only.- Overrides:
formatTo
in classAbstractCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"ImageCRS"
.- See Also:
- WKT 2 specification §12
-
-