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.coverage.processing;
033
034 import java.util.Collection;
035 import org.opengis.coverage.grid.GridCoverage;
036 import org.opengis.coverage.SampleDimensionType;
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * Provides operations for different ways of accessing the grid coverage values as well as
045 * image processing functionality. The list of available processing operations is implementation
046 * dependent. The interface has a discovery mechanism to determine the available processing
047 * operations.
048 * <p>
049 * These processing operations will transform values within a single sample dimension, and
050 * leave the values in other sample dimensions unaffected. The modified sample dimension may
051 * also change its type (e.g. from {@link SampleDimensionType#UNSIGNED_4BITS UNSIGNED_4BITS} to
052 * {@link SampleDimensionType#UNSIGNED_1BIT UNSIGNED_1BIT}). The actual underlying grid data
053 * remains unchanged.
054 * <p>
055 * The interface has been designed to allow the adaptations to be done in a "pipe-lined" manner.
056 * The interface operates on {@link GridCoverage} to create new a {@link GridCoverage}. The
057 * interface does not need to make a copy of the source grid data. Instead, it can return a
058 * grid coverage object which applies the adaptations on the original grid coverage whenever
059 * a block of data is requested. In this way, a pipeline of several grid coverages can be
060 * constructed cheaply.
061 * <p>
062 * This interface can perform any of the following:
063 * <ul>
064 * <li>Change the number of bands being accessed.</li>
065 * <li>Change the value sequencing in which the grid values are retrieved.</li>
066 * <li>Allow re-sampling of the grid coverage for a different geometry.
067 * Creating a new {@link GridCoverage} with different grid geometry allows for reprojecting
068 * the grid coverage to another projection and another georeferencing type, resampling to
069 * another cell resolution and subsetting the grid coverage.</li>
070 * <li>Modify the way the grid values are accessed (filtered, classified...).</li>
071 * <li>Change the interpolation method used when evaluating points which fall between grid cells.</li>
072 * <li>Filtering.</li>
073 * <li>Image enhancements.</li>
074 * <li><i>etc.</i></li>
075 * </ul>
076 *
077 * <P> </P>
078 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
079 * <TR><TD>
080 * <P align="justify"><STRONG>WARNING: THIS CLASS WILL CHANGE.</STRONG> Current API is derived from OGC
081 * <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverages Implementation specification 1.0</A>.
082 * We plan to replace it by new interfaces derived from ISO 19123 (<CITE>Schema for coverage geometry
083 * and functions</CITE>). Current interfaces should be considered as legacy and are included in this
084 * distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much
085 * compatibility as possible, but no migration plan has been determined yet.</P>
086 * </TD></TR>
087 * </TABLE>
088 *
089 * @version <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverage specification 1.0</A>
090 * @author Martin Desruisseaux (IRD)
091 * @since GeoAPI 1.0
092 *
093 * @deprecated Need to be replaced by a mechanism better aligned on WCPS specification.
094 */
095 @Deprecated
096 @UML(identifier="GP_GridCoverageProcessor", specification=OGC_01004)
097 public interface GridCoverageProcessor {
098 /**
099 * Retrieves grid processing operations information.
100 * Each operation information will contain the name of the operation as well
101 * as a list of its parameters.
102 *
103 * @return The available operations.
104 */
105 @UML(identifier="getOperation", obligation=MANDATORY, specification=OGC_01004)
106 Collection<Operation> getOperations();
107 }