Package org.apache.sis.referencing.crs
Class DefaultImageCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultImageCRS
- All Implemented Interfaces:
Serializable,Formattable,Deprecable,LenientComparable,CoordinateReferenceSystem,ImageCRS,SingleCRS,IdentifiedObject,ReferenceSystem
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 safety
This 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:
Defined in the sis-referencing module
-
Field Summary
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEYFields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEYFields inherited from interface ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY -
Constructor Summary
ConstructorsModifierConstructorDescriptionDefaultImageCRS(Map<String, ?> properties, ImageDatum datum, AffineCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protectedConstructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultImageCRScastOrCopy(ImageCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.forConvention(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected StringFormats this CRS as a Well Known TextImageCRS[…]element.Returns the coordinate system.Returns the datum.Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractCRS
castOrCopy, computeHashCode, equalsMethods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScopeMethods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObject
print, toString, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKTMethods inherited from interface ReferenceSystem
getDomainOfValidity, getScope
-
Constructor Details
-
DefaultImageCRS
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" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"domainOfValidity" ExtentAbstractReferenceSystem.getDomainOfValidity()"scope" InternationalStringorStringAbstractReferenceSystem.getScope()- Parameters:
properties- the properties to be given to the coordinate reference system.datum- the datum.cs- the coordinate system.- See Also:
-
DefaultImageCRS
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:
-
-
Method Details
-
castOrCopy
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, 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
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 defineImageCRSsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterfacein classAbstractCRS- Returns:
ImageCRS.classor a user-defined sub-interface.
-
getDatum
Returns the datum.- Specified by:
getDatumin interfaceImageCRS- Specified by:
getDatumin interfaceSingleCRS- Returns:
- the datum.
-
getCoordinateSystem
Returns the coordinate system.- Specified by:
getCoordinateSystemin interfaceCoordinateReferenceSystem- Specified by:
getCoordinateSystemin interfaceImageCRS- Specified by:
getCoordinateSystemin interfaceSingleCRS- Overrides:
getCoordinateSystemin classAbstractCRS- Returns:
- the coordinate system.
-
forConvention
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:
forConventionin 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:
-
formatTo
Formats this CRS as a Well Known TextImageCRS[…]element.Compatibility note:ImageCRSare defined in the WKT 2 specification only.- Overrides:
formatToin classAbstractCRS- Parameters:
formatter- the formatter where to format the inner content of this WKT element.- Returns:
"ImageCRS".- See Also:
-