Class DefaultGCP
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultGCP
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,GCP
Information on ground control point.
Ground control points (GCP) are large marked targets on the ground,
not to be confused with localization grid points embedded in some file formats like GeoTIFF or netCDF.
The following property is mandatory in a well-formed metadata according ISO 19115:
MI_GCP
└─geographicCoordinates…… Geographic or map position of the control point, in either two or three dimensions.Limitations
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use
XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty ground control point.DefaultGCP(GCP object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGCPcastOrCopy(GCP object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the accuracy of a ground control point.Returns the geographic or map position of the control point, in either two or three dimensions.voidsetAccuracyReports(Collection<? extends Element> newValues) Sets the accuracy of a ground control point.voidsetGeographicCoordinates(DirectPosition newValue) Sets the geographic or map position of the control point, in either two or three dimensions.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultGCP
public DefaultGCP()Constructs an initially empty ground control point. -
DefaultGCP
Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.- Parameters:
object- the metadata to copy values from, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null, then this method returnsnull. - Otherwise if the given object is already an instance of
DefaultGCP, then it is returned unchanged. - Otherwise a new
DefaultGCPinstance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
- 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.
- If the given object is
-
getGeographicCoordinates
Returns the geographic or map position of the control point, in either two or three dimensions.- Specified by:
getGeographicCoordinatesin interfaceGCP- Returns:
- geographic or map position of the control point, or
null. - TODO:
- finish the annotation on the referencing module before.
-
setGeographicCoordinates
Sets the geographic or map position of the control point, in either two or three dimensions.- Parameters:
newValue- the new geographic coordinates values.
-
getAccuracyReports
Returns the accuracy of a ground control point.- Specified by:
getAccuracyReportsin interfaceGCP- Returns:
- accuracy of a ground control point.
-
setAccuracyReports
Sets the accuracy of a ground control point.- Parameters:
newValues- the new accuracy report values.
-