org.geotools.styling.ChannelSelection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

The newest version!

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.styling;

/**
 * The ChannelSelection element specifies the false-color channel selection for a multi-spectral
 * raster source (such as a multi-band satellite-imagery source). It is defined as:
 *
 *  * <xs:element name="ChannelSelection">
 * <xs:complexType>
 *     <xs:choice>
 *       <xs:sequence>
 *         <xs:element ref="sld:RedChannel"/>
 *         <xs:element ref="sld:GreenChannel"/>
 *         <xs:element ref="sld:BlueChannel"/>
 *       </xs:sequence>
 *       <xs:element ref="sld:GrayChannel"/>
 *     </xs:choice>
 *   </xs:complexType>
 * </xs:element>
 * <xs:element name="RedChannel" type="sld:SelectedChannelType"/>
 * <xs:element name="GreenChannel" type="sld:SelectedChannelType"/>
 * <xs:element name="BlueChannel" type="sld:SelectedChannelType"/>
 * <xs:element name="GrayChannel" type="sld:SelectedChannelType"/>
 * 
 *
 * Either a channel may be selected to display in each of red, green, and blue, or a single channel
 * may be selected to display in grayscale. (The spelling ?gray? is used since it seems to be more
 * common on the Web than ?grey? by a ratio of about 3:1.) Contrast enhancement may be applied to
 * each channel in isolation. Channels are identified by a system and data-dependent character
 * identifier. Commonly, channels will be labelled as ?1?, ?2?, etc.
 *
 * @author iant
 */
public interface ChannelSelection extends org.opengis.style.ChannelSelection {
    /**
     * Set the RGB channels to be used
     *
     * @param red the red channel
     * @param green the green channel
     * @param blue the blue channel
     */
    void setRGBChannels(
            SelectedChannelType red, SelectedChannelType green, SelectedChannelType blue);

    /**
     * Set the RGB channels to be used
     *
     * @param channels array of channels in RGB order
     */
    void setRGBChannels(SelectedChannelType[] channels);

    /**
     * get the RGB channels to be used
     *
     * @return array of channels in RGB order
     */
    SelectedChannelType[] getRGBChannels();

    /**
     * Set the gray channel to be used
     *
     * @param gray the gray channel
     */
    void setGrayChannel(SelectedChannelType gray);

    /**
     * Get the gray channel to be used
     *
     * @return the gray channel
     */
    SelectedChannelType getGrayChannel();

    void accept(org.geotools.styling.StyleVisitor visitor);
}