Class DefaultGeorectified
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,Georectified,GridSpatialRepresentation,SpatialRepresentation
Grid whose cells are regularly spaced in a geographic or projected coordinate reference system.
Any cell in the grid can be geolocated given its grid coordinate and the grid origin, cell spacing,
and orientation indication of whether or not geographic.
Providing the check point description implies
that check point availability is
The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:
MD_Georectified
├─numberOfDimensions………………………………………………… Number of independent spatial-temporal axes.
├─axisDimensionProperties…………………………………… Information about spatial-temporal axis properties.
│ ├─dimensionName…………………………………………………… Name of the axis.
│ └─dimensionSize…………………………………………………… Number of elements along the axis.
├─cellGeometry………………………………………………………………… Identification of grid data as point or cell.
├─transformationParameterAvailability…… Whether parameters for transformation exists.
├─checkPointAvailability……………………………………… Whether geographic position points are available to test the accuracy of the georeferenced grid data.
├─checkPointDescription………………………………………… Description of geographic position points used to test the accuracy of the georeferenced grid data.
├─cornerPoints………………………………………………………………… Earth location in the coordinate reference system and the grid coordinate of the cells at opposite ends.
└─pointInPixel………………………………………………………………… Point in a pixel corresponding to the Earth location of the pixel.true.
The setter methods will ensure that this condition is not violated.
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 georectified object.DefaultGeorectified(Georectified object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGeorectifiedcastOrCopy(Georectified object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cell halfway between opposite ends of the grid in the spatial dimensions.Returns a description of geographic position points used to test the accuracy of the georeferenced grid data.Returns the geographic references used to validate georectification of the data.Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cells at opposite ends of grid coverage along two diagonals.Returns the point in a pixel corresponding to the Earth location of the pixel.Returns a general description of the transformation.Returns information about which grid dimensions are the spatial dimensions.booleanReturns an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.voidsetCenterPoint(Point newValue) Sets the center point.voidsetCheckPointAvailable(boolean newValue) Sets an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.voidsetCheckPointDescription(InternationalString newValue) Sets the description of geographic position points used to test the accuracy of the georeferenced grid data.voidsetCheckPoints(Collection<? extends GCP> newValues) Sets the geographic references used to validate georectification of the data.voidsetCornerPoints(List<? extends Point> newValues) Sets the corner points.voidsetPointInPixel(PixelOrientation newValue) Sets the point in a pixel corresponding to the Earth location of the pixel.voidSets a general description of the transformation.voidsetTransformationDimensionMapping(Collection<? extends InternationalString> newValues) Sets information about which grid dimensions are the spatial dimensions.Methods inherited from class DefaultGridSpatialRepresentation
castOrCopy, getAxisDimensionProperties, getCellGeometry, getNumberOfDimensions, isTransformationParameterAvailable, setAxisDimensionProperties, setCellGeometry, setNumberOfDimensions, setTransformationParameterAvailableMethods inherited from class AbstractSpatialRepresentation
castOrCopy, getScope, setScopeMethods 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, toStringMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface GridSpatialRepresentation
getAxisDimensionProperties, getCellGeometry, getNumberOfDimensions, isTransformationParameterAvailable
-
Constructor Details
-
DefaultGeorectified
public DefaultGeorectified()Constructs an initially empty georectified object. -
DefaultGeorectified
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
DefaultGeorectified, then it is returned unchanged. - Otherwise a new
DefaultGeorectifiedinstance 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
-
isCheckPointAvailable
public boolean isCheckPointAvailable()Returns an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.- Specified by:
isCheckPointAvailablein interfaceGeorectified- Returns:
- whether or not geographic position points are available to test accuracy.
-
setCheckPointAvailable
public void setCheckPointAvailable(boolean newValue) Sets an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.Effect on other properties
If and only if the givennewValueisfalse, then this method automatically hides the check point description property. The description can be shown again by revertingcheckPointAvailabilitytotrue.- Parameters:
newValue-trueif check points are available.
-
getCheckPointDescription
Returns a description of geographic position points used to test the accuracy of the georeferenced grid data. This value is non-null only ifisCheckPointAvailable()returnstrue.- Specified by:
getCheckPointDescriptionin interfaceGeorectified- Returns:
- description of geographic position points used to test accuracy, or
null.
-
setCheckPointDescription
Sets the description of geographic position points used to test the accuracy of the georeferenced grid data.Effect on other properties
If and only if the givennewValueis non-null, then this method automatically sets the check point availability property totrue.- Parameters:
newValue- the new check point description.
-
getCornerPoints
Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cells at opposite ends of grid coverage along two diagonals.- Specified by:
getCornerPointsin interfaceGeorectified- Returns:
- the corner points.
-
setCornerPoints
Sets the corner points. The list size should be 2 or 4. The list should contain at least two corner points along one diagonal. or may contains the 4 corner points of the georectified grid.The first corner point shall correspond to the origin of the grid.
- Parameters:
newValues- the new corner points.
-
getCenterPoint
Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cell halfway between opposite ends of the grid in the spatial dimensions.Upcoming API change
This method may be renamedgetCentrePoint()in GeoAPI 4.0 for compliance with ISO 19115:2014.- Specified by:
getCenterPointin interfaceGeorectified- Returns:
- the center point, or
null.
-
setCenterPoint
Sets the center point.Upcoming API change
This method may be renamedsetCentrePoint(…)in GeoAPI 4.0 for compliance with ISO 19115:2014.- Parameters:
newValue- the new center point.
-
getPointInPixel
Returns the point in a pixel corresponding to the Earth location of the pixel.- Specified by:
getPointInPixelin interfaceGeorectified- Returns:
- earth location of the pixel, or
null.
-
setPointInPixel
Sets the point in a pixel corresponding to the Earth location of the pixel.- Parameters:
newValue- the new point in a pixel.
-
getTransformationDimensionDescription
Returns a general description of the transformation.- Specified by:
getTransformationDimensionDescriptionin interfaceGeorectified- Returns:
- general description of the transformation, or
null.
-
setTransformationDimensionDescription
Sets a general description of the transformation.- Parameters:
newValue- the new general description.
-
getTransformationDimensionMapping
Returns information about which grid dimensions are the spatial dimensions.- Specified by:
getTransformationDimensionMappingin interfaceGeorectified- Returns:
- information about which grid dimensions are the spatial dimensions, or
null.
-
setTransformationDimensionMapping
Sets information about which grid dimensions are the spatial dimensions. The given list should contain at most 2 elements.- Parameters:
newValues- the new transformation mapping.
-
getCheckPoints
Returns the geographic references used to validate georectification of the data.- Specified by:
getCheckPointsin interfaceGeorectified- Returns:
- geographic references used to validate georectification.
-
setCheckPoints
Sets the geographic references used to validate georectification of the data.- Parameters:
newValues- the new check points values.
-