001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.metadata.content;
019
020import javax.measure.quantity.Length;
021import javax.measure.Unit;
022import org.opengis.annotation.UML;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Range of wavelengths in the electromagnetic spectrum.
030 *
031 * @author  Martin Desruisseaux (IRD)
032 * @author  Cory Horner (Refractions Research)
033 * @author  Cédric Briançon (Geomatys)
034 * @author  Rémi Maréchal (Geomatys)
035 * @version 3.1
036 * @since   2.0
037 */
038@UML(identifier="MD_Band", specification=ISO_19115)
039public interface Band extends SampleDimension {
040    /**
041     * Shortest wavelength that the sensor is capable of collecting within a designated band.
042     *
043     * @return shortest wavelength that the sensor is capable of collecting within a designated band,
044     *         or {@code null} if unspecified.
045     *
046     * @since 3.1
047     */
048    @UML(identifier="boundMin", obligation=OPTIONAL, specification=ISO_19115)
049    default Double getBoundMin() {
050        return null;
051    }
052
053    /**
054     * Longest wavelength that the sensor is capable of collecting within a designated band.
055     *
056     * @return longest wavelength that the sensor is capable of collecting within a designated band,
057     *         or {@code null} if unspecified.
058     *
059     * @since 3.1
060     */
061    @UML(identifier="boundMax", obligation=OPTIONAL, specification=ISO_19115)
062    default Double getBoundMax() {
063        return null;
064    }
065
066    /**
067     * Units in which sensor wavelengths are expressed.
068     *
069     * @return units in which sensor wavelengths are expressed, or {@code null} if unspecified.
070     *
071     * @since 3.1
072     */
073    @UML(identifier="boundUnits", obligation=OPTIONAL, specification=ISO_19115)
074    default Unit<Length> getBoundUnits() {
075        return null;
076    }
077
078    /**
079     * Designation of criterion for defining maximum and minimum wavelengths for a spectral band.
080     *
081     * @return criterion for defining maximum and minimum wavelengths.
082     */
083    @UML(identifier="bandBoundaryDefinition", obligation=OPTIONAL, specification=ISO_19115_2)
084    default BandDefinition getBandBoundaryDefinition() {
085        return null;
086    }
087
088    /**
089     * Wavelength at which the response is the highest.
090     * Returns {@code null} if unspecified.
091     *
092     * @return wavelength at which the response is the highest, or {@code null} if unspecified.
093     */
094    @UML(identifier="peakResponse", obligation=OPTIONAL, specification=ISO_19115)
095    default Double getPeakResponse() {
096        return null;
097    }
098
099    /**
100     * Number of discrete numerical values in the grid data.
101     * Returns {@code null} if unspecified.
102     *
103     * @return number of discrete numerical values in the grid data, or {@code null}.
104     */
105    @UML(identifier="toneGradation", obligation=OPTIONAL, specification=ISO_19115)
106    default Integer getToneGradation() {
107        return null;
108    }
109
110    /**
111     * Polarization of the radiation transmitted.
112     *
113     * <div class="warning"><b>Upcoming API change</b><br>
114     * This method will be renamed {@code getTransmittedPolarisation} in GeoAPI 4.0
115     * for compliance with ISO 19115-2:2019.
116     * </div>
117     *
118     * @return polarization of the radiation transmitted.
119     */
120    @UML(identifier="transmittedPolarisation", obligation=OPTIONAL, specification=ISO_19115_2)
121    default PolarizationOrientation getTransmittedPolarization() {
122        return null;
123    }
124
125    /**
126     * Polarization of the radiation detected.
127     *
128     * <div class="warning"><b>Upcoming API change</b><br>
129     * This method will be renamed {@code getDetectedPolarisation} in GeoAPI 4.0
130     * for compliance with ISO 19115-2:2019.
131     * </div>
132     *
133     * @return polarization of the radiation detected.
134     */
135    @UML(identifier="detectedPolarisation", obligation=OPTIONAL, specification=ISO_19115_2)
136    default PolarizationOrientation getDetectedPolarization() {
137        return null;
138    }
139}