001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.spatial;
033
034 import java.util.Collection;
035 import java.util.List;
036 import org.opengis.util.InternationalString;
037 import org.opengis.geometry.primitive.Point;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Grid whose cells are regularly spaced in a geographic (i.e., lat / long) or map
046 * coordinate system defined in the Spatial Referencing System (SRS) so that any cell
047 * in the grid can be geolocated given its grid coordinate and the grid origin, cell spacing,
048 * and orientation indication of whether or not geographic.
049 *
050 * @author Martin Desruisseaux (IRD)
051 * @author Cédric Briançon (Geomatys)
052 * @version 3.0
053 * @since 2.0
054 *
055 * @navassoc - - - Point
056 * @navassoc 1 - - PixelOrientation
057 * @navassoc - - - GCP
058 */
059 @UML(identifier="MD_Georectified", specification=ISO_19115)
060 public interface Georectified extends GridSpatialRepresentation {
061 /**
062 * Indication of whether or not geographic position points are available to test the
063 * accuracy of the georeferenced grid data.
064 *
065 * @return Whether or not geographic position points are available to test accuracy.
066 */
067 @UML(identifier="checkPointAvailability", obligation=MANDATORY, specification=ISO_19115)
068 boolean isCheckPointAvailable();
069
070 /**
071 * Description of geographic position points used to test the accuracy of the
072 * georeferenced grid data.
073 *
074 * @return Description of geographic position points used to test accuracy, or {@code null}.
075 *
076 * @condition {@linkplain #isCheckPointAvailable() Check point availability} equals yes.
077 */
078 @UML(identifier="checkPointDescription", obligation=CONDITIONAL, specification=ISO_19115)
079 InternationalString getCheckPointDescription();
080
081 /**
082 * Earth location in the coordinate system defined by the Spatial Reference System
083 * and the grid coordinate of the cells at opposite ends of grid coverage along two
084 * diagonals in the grid spatial dimensions. There are four corner points in a
085 * georectified grid; at least two corner points along one diagonal are required.
086 *
087 * @return The corner points.
088 */
089 @UML(identifier="cornerPoints", obligation=MANDATORY, specification=ISO_19115)
090 List<? extends Point> getCornerPoints();
091
092 /**
093 * Earth location in the coordinate system defined by the Spatial Reference System
094 * and the grid coordinate of the cell halfway between opposite ends of the grid in the
095 * spatial dimensions.
096 *
097 * @return The center point, or {@code null}.
098 */
099 @UML(identifier="centerPoint", obligation=OPTIONAL, specification=ISO_19115)
100 Point getCenterPoint();
101
102 /**
103 * Point in a pixel corresponding to the Earth location of the pixel.
104 *
105 * @return Earth location of the pixel.
106 */
107 @UML(identifier="pointInPixel", obligation=MANDATORY, specification=ISO_19115)
108 PixelOrientation getPointInPixel();
109
110 /**
111 * Description of the information about which grid dimensions are the spatial dimensions.
112 *
113 * @return Description of the information about grid dimensions, or {@code null}.
114 */
115 @UML(identifier="transformationDimensionDescription", obligation=OPTIONAL, specification=ISO_19115)
116 InternationalString getTransformationDimensionDescription();
117
118 /**
119 * Information about which grid dimensions are the spatial dimensions.
120 *
121 * @return Information about which grid dimensions are the spatial dimensions, or {@code null}.
122 */
123 @UML(identifier="transformationDimensionMapping", obligation=OPTIONAL, specification=ISO_19115)
124 Collection<? extends InternationalString> getTransformationDimensionMapping();
125
126 /**
127 * Geographic references used to validate georectification of the data.
128 *
129 * @return Geographic references used to validate georectification.
130 *
131 * @since 2.3
132 */
133 @UML(identifier="checkPoint", obligation=OPTIONAL, specification=ISO_19115_2)
134 Collection<? extends GCP> getCheckPoints();
135 }