Module org.apache.sis.metadata
Package org.apache.sis.metadata.iso.spatial

Class DefaultGeorectified

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractSpatialRepresentation
DefaultGridSpatialRepresentation
DefaultGeorectified
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Georectified, Grid­Spatial­Representation, Spatial­Representation
public class DefaultGeorectified extends DefaultGridSpatialRepresentation implements Georectified
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.

The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Georectified   ├─number­Of­Dimensions………………………………………………… Number of independent spatial-temporal axes.   ├─axis­Dimension­Properties…………………………………… Information about spatial-temporal axis properties.   │   ├─dimension­Name…………………………………………………… Name of the axis.   │   └─dimension­Size…………………………………………………… Number of elements along the axis.   ├─cell­Geometry………………………………………………………………… Identification of grid data as point or cell.   ├─transformation­Parameter­Availability…… Whether parameters for transformation exists.   ├─check­Point­Availability……………………………………… Whether geographic position points are available to test the accuracy of the georeferenced grid data.   ├─check­Point­Description………………………………………… Description of geographic position points used to test the accuracy of the georeferenced grid data.   ├─corner­Points………………………………………………………………… Earth location in the coordinate reference system and the grid coordinate of the cells at opposite ends.   └─point­In­Pixel………………………………………………………………… Point in a pixel corresponding to the Earth location of the pixel.
Providing the check point description implies that check point availability is 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 XML instead.
Since:
0.3
See Also:

  • Constructor Details

    • DefaultGeorectified

      public DefaultGeorectified()
      Constructs an initially empty georectified object.

    • DefaultGeorectified

      public DefaultGeorectified(Georectified object)
      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, or null if none.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultGeorectified castOrCopy(Georectified object)
      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 returns null.
      • Otherwise if the given object is already an instance of Default­Georectified, then it is returned unchanged.
      • Otherwise a new Default­Georectified instance 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, or null 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.

    • 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:
      is­Check­Point­Available in interface Georectified
      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 given new­Value is false, then this method automatically hides the check point description property. The description can be shown again by reverting check­Point­Availability to true.
      Parameters:
      new­Value - 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. This value is non-null only if is­Check­Point­Available() returns true.
      Specified by:
      get­Check­Point­Description in interface Georectified
      Returns:
      description of geographic position points used to test accuracy, or null.

    • setCheckPointDescription

      public void setCheckPointDescription(InternationalString newValue)
      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 given new­Value is non-null, then this method automatically sets the check point availability property to true.
      Parameters:
      new­Value - 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.
      Specified by:
      get­Corner­Points in interface Georectified
      Returns:
      the corner points.

    • setCornerPoints

      public void setCornerPoints(List<? extends Point> newValues)
      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:
      new­Values - 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.
      Upcoming API change
      This method may be renamed get­Centre­Point() in GeoAPI 4.0 for compliance with ISO 19115:2014.
      Specified by:
      get­Center­Point in interface Georectified
      Returns:
      the center point, or null.

    • setCenterPoint

      public void setCenterPoint(Point newValue)
      Sets the center point.
      Upcoming API change
      This method may be renamed set­Centre­Point(…) in GeoAPI 4.0 for compliance with ISO 19115:2014.
      Parameters:
      new­Value - the new center point.

    • getPointInPixel

      public PixelOrientation getPointInPixel()
      Returns the point in a pixel corresponding to the Earth location of the pixel.
      Specified by:
      get­Point­In­Pixel in interface Georectified
      Returns:
      earth location of the pixel, or null.

    • setPointInPixel

      public void setPointInPixel(PixelOrientation newValue)
      Sets the point in a pixel corresponding to the Earth location of the pixel.
      Parameters:
      new­Value - the new point in a pixel.

    • getTransformationDimensionDescription

      public InternationalString getTransformationDimensionDescription()
      Returns a general description of the transformation.
      Specified by:
      get­Transformation­Dimension­Description in interface Georectified
      Returns:
      general description of the transformation, or null.

    • setTransformationDimensionDescription

      public void setTransformationDimensionDescription(InternationalString newValue)
      Sets a general description of the transformation.
      Parameters:
      new­Value - the new general description.

    • getTransformationDimensionMapping

      public Collection<InternationalString> getTransformationDimensionMapping()
      Returns information about which grid dimensions are the spatial dimensions.
      Specified by:
      get­Transformation­Dimension­Mapping in interface Georectified
      Returns:
      information about which grid dimensions are the spatial dimensions, or null.

    • setTransformationDimensionMapping

      public void setTransformationDimensionMapping(Collection<? extends InternationalString> newValues)
      Sets information about which grid dimensions are the spatial dimensions. The given list should contain at most 2 elements.
      Parameters:
      new­Values - the new transformation mapping.

    • getCheckPoints

      public Collection<GCP> getCheckPoints()
      Returns the geographic references used to validate georectification of the data.
      Specified by:
      get­Check­Points in interface Georectified
      Returns:
      geographic references used to validate georectification.

    • setCheckPoints

      public void setCheckPoints(Collection<? extends GCP> newValues)
      Sets the geographic references used to validate georectification of the data.
      Parameters:
      new­Values - the new check points values.