org.geotools.styling
Interface ChannelSelection

All Superinterfaces:
ChannelSelection

public interface ChannelSelection
extends ChannelSelection

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
Module:
modules/library/api (gt-api.jar)

Method Summary
 void accept(StyleVisitor visitor)
           
 SelectedChannelType getGrayChannel()
          Get the gray channel to be used
 SelectedChannelType[] getRGBChannels()
          get the RGB channels to be used
 SelectedChannelType[] getSelectedChannels()
          Deprecated. Please use getRGBChannels
 void setGrayChannel(SelectedChannelType gray)
          Set the gray channel to be used
 void setRGBChannels(SelectedChannelType[] channels)
          Set the RGB channels to be used
 void setRGBChannels(SelectedChannelType red, SelectedChannelType green, SelectedChannelType blue)
          Set the RGB channels to be used
 void setSelectedChannels(SelectedChannelType[] channels)
          Deprecated. Please use setRGBChannels
 
Methods inherited from interface ChannelSelection
accept
 

Method Detail

setRGBChannels

void setRGBChannels(SelectedChannelType red,
                    SelectedChannelType green,
                    SelectedChannelType blue)
Set the RGB channels to be used

Parameters:
red - the red channel
green - the green channel
blue - the blue channel

setRGBChannels

void setRGBChannels(SelectedChannelType[] channels)
Set the RGB channels to be used

Parameters:
channels - array of channels in RGB order

getRGBChannels

SelectedChannelType[] getRGBChannels()
get the RGB channels to be used

Specified by:
getRGBChannels in interface ChannelSelection
Returns:
array of channels in RGB order

setGrayChannel

void setGrayChannel(SelectedChannelType gray)
Set the gray channel to be used

Parameters:
gray - the gray channel

getGrayChannel

SelectedChannelType getGrayChannel()
Get the gray channel to be used

Specified by:
getGrayChannel in interface ChannelSelection
Returns:
the gray channel

setSelectedChannels

void setSelectedChannels(SelectedChannelType[] channels)
Deprecated. Please use setRGBChannels

set the channels to be used

Parameters:
channels - array of channels

getSelectedChannels

SelectedChannelType[] getSelectedChannels()
Deprecated. Please use getRGBChannels

get the channels to be used

Returns:
array of channels

accept

void accept(StyleVisitor visitor)


Copyright © 1996-2009 Geotools. All Rights Reserved.