te::se::ChannelSelection Class Reference

ChannelSelection specifies the false-color channel selection for a multi-spectral raster source (such as a multi-band satellite-imagery source). More...

#include <ChannelSelection.h>

Inheritance diagram for te::se::ChannelSelection:

Public Member Functions

ChannelSelectionclone () const
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 ChannelSelection ()
 It initializes a new ChannelSelection. More...
 
 ~ChannelSelection ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setRedChannel (SelectedChannel *c)
 
SelectedChannelgetRedChannel () const
 
void setGreenChannel (SelectedChannel *c)
 
SelectedChannelgetGreenChannel () const
 
void setBlueChannel (SelectedChannel *c)
 
SelectedChannelgetBlueChannel () const
 
void setGrayChannel (SelectedChannel *c)
 
SelectedChannelgetGrayChannel () const
 
void setColorCompositionType (ColorCompositionType cct)
 
ColorCompositionType getColorCompositionType () const
 

Private Attributes

SelectedChannelm_blueChannel
 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. (Mandatory if grayChannel_ is not informed) More...
 
ColorCompositionType m_colorCompType
 Define the color composition, this is not defined in SE spec. More...
 
SelectedChannelm_grayChannel
 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. (Mandatory if redChannel_, greenChannel_ and blueChannel_ is not informed) More...
 
SelectedChannelm_greenChannel
 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. (Mandatory if grayChannel_ is not informed) More...
 
SelectedChannelm_redChannel
 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. (Mandatory if grayChannel_ is not informed) More...
 

Detailed Description

ChannelSelection specifies the false-color channel selection for a multi-spectral raster source (such as a multi-band satellite-imagery source).

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.

See also
RasterSymbolizer, SelectedChannel

Definition at line 62 of file ChannelSelection.h.

Constructor & Destructor Documentation

te::se::ChannelSelection::ChannelSelection ( )

It initializes a new ChannelSelection.

te::se::ChannelSelection::~ChannelSelection ( )

Destructor.

Member Function Documentation

ChannelSelection* te::se::ChannelSelection::clone ( ) const

It creates a new copy of this object.

SelectedChannel* te::se::ChannelSelection::getBlueChannel ( ) const
inline

Definition at line 94 of file ChannelSelection.h.

ColorCompositionType te::se::ChannelSelection::getColorCompositionType ( ) const
inline

Definition at line 102 of file ChannelSelection.h.

SelectedChannel* te::se::ChannelSelection::getGrayChannel ( ) const
inline

Definition at line 98 of file ChannelSelection.h.

SelectedChannel* te::se::ChannelSelection::getGreenChannel ( ) const
inline

Definition at line 90 of file ChannelSelection.h.

SelectedChannel* te::se::ChannelSelection::getRedChannel ( ) const
inline

Definition at line 86 of file ChannelSelection.h.

void te::se::ChannelSelection::setBlueChannel ( SelectedChannel c)
void te::se::ChannelSelection::setColorCompositionType ( ColorCompositionType  cct)
void te::se::ChannelSelection::setGrayChannel ( SelectedChannel c)
void te::se::ChannelSelection::setGreenChannel ( SelectedChannel c)
void te::se::ChannelSelection::setRedChannel ( SelectedChannel c)

Member Data Documentation

SelectedChannel* te::se::ChannelSelection::m_blueChannel
private

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. (Mandatory if grayChannel_ is not informed)

Definition at line 113 of file ChannelSelection.h.

ColorCompositionType te::se::ChannelSelection::m_colorCompType
private

Define the color composition, this is not defined in SE spec.

Definition at line 116 of file ChannelSelection.h.

SelectedChannel* te::se::ChannelSelection::m_grayChannel
private

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. (Mandatory if redChannel_, greenChannel_ and blueChannel_ is not informed)

Definition at line 114 of file ChannelSelection.h.

SelectedChannel* te::se::ChannelSelection::m_greenChannel
private

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. (Mandatory if grayChannel_ is not informed)

Definition at line 112 of file ChannelSelection.h.

SelectedChannel* te::se::ChannelSelection::m_redChannel
private

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. (Mandatory if grayChannel_ is not informed)

Definition at line 111 of file ChannelSelection.h.


The documentation for this class was generated from the following file: