org.geotoolkit.metadata.iso.spatial
Class DefaultGeorectified

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractSpatialRepresentation
                  DefaultGridSpatialRepresentation
                      DefaultGeorectified

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Georectified, GridSpatialRepresentation, SpatialRepresentation

@ThreadSafe
public class DefaultGeorectified
extends DefaultGridSpatialRepresentation
implements Georectified

Grid whose cells are regularly spaced in a geographic (i.e., lat / long) or map coordinate system defined in the Spatial Referencing System (SRS) so that 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.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultGeorectified()
Constructs an initially empty georectified object.

DefaultGeorectified(Georectified source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultGeorectified(int numberOfDimensions, List<? extends Dimension> axisDimensionsProperties, CellGeometry cellGeometry, boolean transformationParameterAvailable, boolean checkPointAvailable, List<? extends Point> cornerPoints, PixelOrientation pointInPixel)
Creates a georectified object initialized to the specified values.

Method Summary

static DefaultGeorectified	castOrCopy(Georectified object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Point	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.
InternationalString	getCheckPointDescription() Returns a description of geographic position points used to test the accuracy of the georeferenced grid data.
Collection<GCP>	getCheckPoints() Returns the geographic references used to validate georectification of the data.
List<Point>	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 in the grid spatial dimensions.
PixelOrientation	getPointInPixel() Returns the point in a pixel corresponding to the Earth location of the pixel.
InternationalString	getTransformationDimensionDescription() Returns a description of the information about which grid dimensions are the spatial dimensions.
Collection<InternationalString>	getTransformationDimensionMapping() Returns information about which grid dimensions are the spatial dimensions.
boolean	isCheckPointAvailable() Returns an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.
void	setCenterPoint(Point newValue) Sets the center point.
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.
void	setCheckPointDescription(InternationalString newValue) Sets the description of geographic position points used to test the accuracy of the georeferenced grid data.
void	setCheckPoints(Collection<? extends GCP> newValues) Sets the geographic references used to validate georectification of the data.
void	setCornerPoints(List<? extends Point> newValues) Sets the corner points.
void	setPointInPixel(PixelOrientation newValue) Sets the point in a pixel corresponding to the Earth location of the pixel.
void	setTransformationDimensionDescription(InternationalString newValue) Sets the description of the information about which grid dimensions are the spatial dimensions.
void	setTransformationDimensionMapping(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, setTransformationParameterAvailable

Methods inherited from class AbstractSpatialRepresentation

castOrCopy

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GridSpatialRepresentation

getAxisDimensionProperties, getCellGeometry, getNumberOfDimensions, isTransformationParameterAvailable

Constructor Detail

DefaultGeorectified

public DefaultGeorectified()

Constructs an initially empty georectified object.

DefaultGeorectified

public DefaultGeorectified(Georectified source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultGeorectified

public DefaultGeorectified(int numberOfDimensions,
                           List<? extends Dimension> axisDimensionsProperties,
                           CellGeometry cellGeometry,
                           boolean transformationParameterAvailable,
                           boolean checkPointAvailable,
                           List<? extends Point> cornerPoints,
                           PixelOrientation pointInPixel)

Creates a georectified object initialized to the specified values.

Parameters:

numberOfDimensions - The number of independent spatial-temporal axes.

axisDimensionsProperties - Information about spatial-temporal axis properties.

cellGeometry - Identification of grid data as point or cell.

transformationParameterAvailable - Indication of whether or not parameters for transformation exists.

checkPointAvailable - Indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.

cornerPoints - The corner points.

pointInPixel - The point in a pixel corresponding to the Earth location of the pixel.

Method Detail

castOrCopy

public static DefaultGeorectified castOrCopy(Georectified object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

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:

isCheckPointAvailable in interface Georectified

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.

Parameters:

newValue - true if check points are available.

getCheckPointDescription

public InternationalString getCheckPointDescription()

Returns a description of geographic position points used to test the accuracy of the georeferenced grid data.

Specified by:

getCheckPointDescription in interface Georectified

setCheckPointDescription

public void setCheckPointDescription(InternationalString newValue)

Sets the description of geographic position points used to test the accuracy of the georeferenced grid data.

Parameters:

newValue - The new check point description.

getCornerPoints

public List<Point> 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 in the grid spatial dimensions. There are four corner points in a georectified grid; at least two corner points along one diagonal are required.

Specified by:

getCornerPoints in interface Georectified

setCornerPoints

public void setCornerPoints(List<? extends Point> newValues)

Sets the corner points.

Parameters:

newValues - The new corner points.

getCenterPoint

public Point 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.

Specified by:

getCenterPoint in interface Georectified

setCenterPoint

public void setCenterPoint(Point newValue)

Sets the center point.

Parameters:

newValue - The new center point.

getPointInPixel

public PixelOrientation getPointInPixel()

Returns the point in a pixel corresponding to the Earth location of the pixel.

Specified by:

getPointInPixel in interface Georectified

setPointInPixel

public void setPointInPixel(PixelOrientation newValue)

Sets the point in a pixel corresponding to the Earth location of the pixel.

Parameters:

newValue - The new point in a pixel.

getTransformationDimensionDescription

public InternationalString getTransformationDimensionDescription()

Returns a description of the information about which grid dimensions are the spatial dimensions.

Specified by:

getTransformationDimensionDescription in interface Georectified

setTransformationDimensionDescription

public void setTransformationDimensionDescription(InternationalString newValue)

Sets the description of the information about which grid dimensions are the spatial dimensions.

Parameters:

newValue - The new transformation dimension description.

getTransformationDimensionMapping

public Collection<InternationalString> getTransformationDimensionMapping()

Returns information about which grid dimensions are the spatial dimensions.

Specified by:

getTransformationDimensionMapping in interface Georectified

setTransformationDimensionMapping

public void setTransformationDimensionMapping(Collection<? extends InternationalString> newValues)

Sets information about which grid dimensions are the spatial dimensions.

Parameters:

newValues - The new transformation mapping.

getCheckPoints

public Collection<GCP> getCheckPoints()

Returns the geographic references used to validate georectification of the data.

Specified by:

getCheckPoints in interface Georectified

Since:

3.03

setCheckPoints

public void setCheckPoints(Collection<? extends GCP> newValues)

Sets the geographic references used to validate georectification of the data.

Parameters:

newValues - The new check points values.

Since:

3.03