org.opengis.metadata.content.Band Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geoapi Show documentation
Show all versions of geoapi Show documentation
The development community in building GIS solutions is sustaining an enormous level
of effort. The GeoAPI project aims to reduce duplication and increase interoperability
by providing neutral, interface-only APIs derived from OGC/ISO Standards.
/*
* GeoAPI - Java interfaces for OGC/ISO standards
* http://www.geoapi.org
*
* Copyright (C) 2004-2011 Open Geospatial Consortium, Inc.
* All Rights Reserved. http://www.opengeospatial.org/ogc/legal
*
* Permission to use, copy, and modify this software and its documentation, with
* or without modification, for any purpose and without fee or royalty is hereby
* granted, provided that you include the following on ALL copies of the software
* and documentation or portions thereof, including modifications, that you make:
*
* 1. The full text of this NOTICE in a location viewable to users of the
* redistributed or derivative work.
* 2. Notice of any changes or modifications to the OGC files, including the
* date changes were made.
*
* THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
* NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
* THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
*
* COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
* CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
*
* The name and trademarks of copyright holders may NOT be used in advertising or
* publicity pertaining to the software without specific, written prior permission.
* Title to copyright in this software and any associated documentation will at all
* times remain with copyright holders.
*/
package org.opengis.metadata.content;
import javax.measure.quantity.Length;
import javax.measure.Unit;
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* Range of wavelengths in the electromagnetic spectrum.
*
* @author Martin Desruisseaux (IRD)
* @author Cory Horner (Refractions Research)
* @author Cédric Briançon (Geomatys)
* @version 3.0.1
* @since 2.0
*
* @navassoc 1 - - Unit
* @navassoc 1 - - BandDefinition
* @navassoc 1 - - TransferFunctionType
* @navassoc - - - PolarizationOrientation
*/
@UML(identifier="MD_Band", specification=ISO_19115)
public interface Band extends RangeDimension {
/**
* Longest wavelength that the sensor is capable of collecting within a designated band.
* Returns {@code null} if unspecified.
*
* @return Longest wavelength that the sensor is capable of collecting within a designated band,
* or {@code null} if unknown. The units of measurement is given by {@link #getUnits()}.
*/
@UML(identifier="maxValue", obligation=OPTIONAL, specification=ISO_19115)
Double getMaxValue();
/**
* Shortest wavelength that the sensor is capable of collecting within a designated band.
* Returns {@code null} if unspecified.
*
* @return Shortest wavelength that the sensor is capable of collecting within a designated band,
* or {@code null} if unknown. The units of measurement is given by {@link #getUnits()}.
*/
@UML(identifier="minValue", obligation=OPTIONAL, specification=ISO_19115)
Double getMinValue();
/**
* Wavelength at which the response is the highest.
* Returns {@code null} if unspecified.
*
* @return Wavelength at which the response is the highest, or {@code null} if unknown.
* The units of measurement is given by {@link #getUnits()}.
*/
@UML(identifier="peakResponse", obligation=OPTIONAL, specification=ISO_19115)
Double getPeakResponse();
/**
* Units in which sensor wavelengths are expressed.
*
* @return Units in which sensor wavelengths are expressed, or {@code null}.
*
* @condition {@linkplain #getMinValue min value}, {@linkplain #getMaxValue max value}
* or {@linkplain #getPeakResponse() peak response} is provided.
*/
@UML(identifier="units", obligation=CONDITIONAL, specification=ISO_19115)
Unit getUnits();
/**
* Maximum number of significant bits in the uncompressed representation for the value
* in each band of each pixel.
* Returns {@code null} if unspecified.
*
* @return Maximum number of significant bits in the uncompressed representation, or {@code null}.
*/
@UML(identifier="bitsPerValue", obligation=OPTIONAL, specification=ISO_19115)
Integer getBitsPerValue();
/**
* Number of discrete numerical values in the grid data.
* Returns {@code null} if unspecified.
*
* @return Number of discrete numerical values in the grid data, or {@code null}.
*/
@UML(identifier="toneGradation", obligation=OPTIONAL, specification=ISO_19115)
Integer getToneGradation();
/**
* Scale factor which has been applied to the cell value.
* Returns {@code null} if unspecified.
*
* @return Scale factor which has been applied to the cell value, or {@code null}.
*/
@UML(identifier="scaleFactor", obligation=OPTIONAL, specification=ISO_19115)
Double getScaleFactor();
/**
* The physical value corresponding to a cell value of zero.
* Returns {@code null} if unspecified.
*
* @return The physical value corresponding to a cell value of zero, or {@code null}.
*/
@UML(identifier="offset", obligation=OPTIONAL, specification=ISO_19115)
Double getOffset();
/**
* Designation of criterion for defining maximum and minimum wavelengths for a spectral band.
*
* @return Criterion for defining maximum and minimum wavelengths.
*
* @since 2.3
*/
@UML(identifier="bandBoundaryDefinition", obligation=OPTIONAL, specification=ISO_19115_2)
BandDefinition getBandBoundaryDefinition();
/**
* Smallest distance between which separate points can be distinguished, as specified in
* instrument design.
*
*
*
* Warning: The return type of this method may change in GeoAPI
* 3.1. It may be replaced by the {@link javax.measure.quantity.Length} type in order to
* provide unit of measurement together with the value.
*
*
* @return Smallest distance between which separate points can be distinguished.
* @unitof Distance
*
* @since 2.3
*/
@UML(identifier="nominalSpatialResolution", obligation=OPTIONAL, specification=ISO_19115_2)
Double getNominalSpatialResolution();
/**
* Type of transfer function to be used when scaling a physical value for a given element.
*
* @return Type of transfer function.
*
* @since 2.3
*/
@UML(identifier="transferFunctionType", obligation=OPTIONAL, specification=ISO_19115_2)
TransferFunctionType getTransferFunctionType();
/**
* Polarization of the radiation transmitted.
*
* @return Polarization of the radiation transmitted.
*
* @since 2.3
*/
@UML(identifier="transmittedPolarization", obligation=OPTIONAL, specification=ISO_19115_2)
PolarizationOrientation getTransmittedPolarization();
/**
* Polarization of the radiation detected.
*
* @return Polarization of the radiation detected.
*
* @since 2.3
*/
@UML(identifier="detectedPolarization", obligation=OPTIONAL, specification=ISO_19115_2)
PolarizationOrientation getDetectedPolarization();
}