te::se::RasterSymbolizer Class Referenceabstract

The RasterSymbolizer describes how to render raster/matrix-coverage data (e.g., satellite photos, DEMs). More...

#include <RasterSymbolizer.h>

Inheritance diagram for te::se::RasterSymbolizer:
te::se::Symbolizer te::common::BaseVisitable< Visitor >

Public Types

enum  OverlapBehavior {
  LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM,
  NO_BEHAVIOR
}
 OverlapBehavior tells a system how to behave when multiple raster images in a layer overlap each other, for example with satellite-image scenes. More...
 
typedef void ReturnType
 
typedef Visitor VisitorType
 

Public Member Functions

virtual ReturnType accept (VisitorType &guest) const =0
 It call the visit method from the guest object. More...
 
Symbolizerclone () const
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 RasterSymbolizer ()
 It initializes a new RasterSymbolizer. More...
 
 RasterSymbolizer (const RasterSymbolizer &rhs)
 Copy constructor. More...
 
 ~RasterSymbolizer ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setGeometry (te::fe::PropertyName *g)
 
void setOpacity (ParameterValue *p)
 
void setGain (ParameterValue *p)
 
void setOffset (ParameterValue *p)
 
ParameterValuegetOpacity () const
 
ParameterValuegetGain () const
 
ParameterValuegetOffset () const
 
void setChannelSelection (ChannelSelection *c)
 
te::se::ChannelSelectiongetChannelSelection () const
 
void setOverlapBehavior (OverlapBehavior b)
 
OverlapBehavior getOverlapBehavior () const
 
void setColorMap (ColorMap *c)
 
te::se::ColorMapgetColorMap () const
 
void setContrastEnhancement (ContrastEnhancement *c)
 
te::se::ContrastEnhancementgetContrastEnhancement () const
 
void setShadedRelief (ShadedRelief *s)
 
ShadedReliefgetShadedRelief () const
 
void setImageOutline (ImageOutline *i)
 
te::se::ImageOutlinegetImageOutline () const
 
const std::string & getType () const
 It returns the symbolizer type. More...
 
Accessor methods

Methods used to get or set properties.

void setName (const std::string &name)
 
const std::string & getName () const
 
void setDescription (Description *d)
 
const DescriptiongetDescription () const
 
void setBaseSymbolizer (te::xl::SimpleLink *baseSymbolizer)
 
const te::xl::SimpleLinkgetBaseSymbolizer () const
 
void setVersion (const std::string &version)
 
const std::string & getVersion () const
 
void setUom (const te::common::BaseUnitOfMeasure *uom)
 It sets the unit-of-measure. More...
 
const te::common::BaseUnitOfMeasure * getUom () const
 

Private Attributes

ChannelSelectionm_channelSelection
 It specifies the false-color channel selection for a multi-spectral raster source (such as a multi-band satellite-imagery source). (Optional) More...
 
ColorMapm_colorMap
 It defines either the colors of a pallette-type raster source or the mapping of numeric pixel values to colors. (Optional) More...
 
ContrastEnhancementm_contrastEnhancement
 It defines contrast enhancement for a channel of a false-color image or for a color image. (Optional) More...
 
ParameterValuem_gain
 It defines the gain value used to renderer the main raster pixels, a initial value could be 1.0. (Optional) More...
 
te::fe::PropertyNamem_geometry
 The interpretation of Geometry is system-dependent, as raster data may be organized differently from feature data, though omitting this element selects the default raster-data source. (Optional) More...
 
ImageOutlinem_imageOutline
 It specifies how individual source rasters in a multi-raster set (such as a set of satellite-image scenes) should be outlined to make the individual-image locations visible. (Optional) More...
 
ParameterValuem_offset
 It defines the offset value used to renderer the main raster pixels, a initial value could be 0.0. (Optional) More...
 
ParameterValuem_opacity
 An Opacity of 0.0 can be selected for the main raster to avoid rendering the main-raster pixels, or an opacity can be used for a PolygonSymbolizer Fill to allow the main-raster data be visible through the fill. (Optional) More...
 
OverlapBehavior m_overlapBehavior
 It tells a system how to behave when multiple raster images in a layer overlap each other, for example with satellite-image scenes. (Optional) More...
 
ShadedReliefm_shadedRelief
 It selects the application of relief shading (or "hill shading") to an image for a three-dimensional visual effect. (Optional) More...
 

Static Private Attributes

static const std::string sm_type
 A static data member used in the implementation of getType method. More...
 

Detailed Description

The RasterSymbolizer describes how to render raster/matrix-coverage data (e.g., satellite photos, DEMs).

A RasterSymbolizer is used to specify the rendering of raster/matrix-coverage data (e.g., satellite images, DEMs).
Geometry-type transformations are also system-dependent and it is assumed that this capability will be little used.

See also
Symbolizer, te::fe::PropertyName, ParameterValue, ChannelSelection, ColorMap, ContrastEnhancement, ShadedRelief, ImageOutline

Definition at line 61 of file RasterSymbolizer.h.

Member Typedef Documentation

typedef void te::common::BaseVisitable< Visitor , void >::ReturnType
inherited

Definition at line 58 of file BaseVisitable.h.

typedef Visitor te::common::BaseVisitable< Visitor , void >::VisitorType
inherited

Definition at line 57 of file BaseVisitable.h.

Member Enumeration Documentation

OverlapBehavior tells a system how to behave when multiple raster images in a layer overlap each other, for example with satellite-image scenes.

Enumerator
LATEST_ON_TOP 

It refers to the time the scene was captured.

EARLIEST_ON_TOP 

It refers to the time the scene was captured.

AVERAGE 

It means to average multiple scenes together. This can produce blurry results if the source images are not perfectly aligned in their geo-referencing.

RANDOM 

It means to select an image (or piece thereof) randomly and place it on top.

NO_BEHAVIOR 

Definition at line 74 of file RasterSymbolizer.h.

Constructor & Destructor Documentation

te::se::RasterSymbolizer::RasterSymbolizer ( )

It initializes a new RasterSymbolizer.

te::se::RasterSymbolizer::RasterSymbolizer ( const RasterSymbolizer rhs)

Copy constructor.

Parameters
rhsThe other raster symbolizer.
te::se::RasterSymbolizer::~RasterSymbolizer ( )

Destructor.

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< Visitor , void >::accept ( VisitorType guest) const
pure virtualinherited

It call the visit method from the guest object.

Parameters
guestThe guest or visitor.
Returns
Any valid value define by the template type R.
Symbolizer* te::se::RasterSymbolizer::clone ( ) const
virtual

It creates a new copy of this object.

Implements te::se::Symbolizer.

const te::xl::SimpleLink* te::se::Symbolizer::getBaseSymbolizer ( ) const
inherited
te::se::ChannelSelection* te::se::RasterSymbolizer::getChannelSelection ( ) const
inline

Definition at line 127 of file RasterSymbolizer.h.

te::se::ColorMap* te::se::RasterSymbolizer::getColorMap ( ) const
inline

Definition at line 135 of file RasterSymbolizer.h.

te::se::ContrastEnhancement* te::se::RasterSymbolizer::getContrastEnhancement ( ) const
inline

Definition at line 139 of file RasterSymbolizer.h.

const Description* te::se::Symbolizer::getDescription ( ) const
inherited
ParameterValue* te::se::RasterSymbolizer::getGain ( ) const
inline

Definition at line 121 of file RasterSymbolizer.h.

te::se::ImageOutline* te::se::RasterSymbolizer::getImageOutline ( ) const
inline

Definition at line 147 of file RasterSymbolizer.h.

const std::string& te::se::Symbolizer::getName ( ) const
inherited
ParameterValue* te::se::RasterSymbolizer::getOffset ( ) const
inline

Definition at line 123 of file RasterSymbolizer.h.

ParameterValue* te::se::RasterSymbolizer::getOpacity ( ) const
inline

Definition at line 119 of file RasterSymbolizer.h.

OverlapBehavior te::se::RasterSymbolizer::getOverlapBehavior ( ) const
inline

Definition at line 131 of file RasterSymbolizer.h.

ShadedRelief* te::se::RasterSymbolizer::getShadedRelief ( ) const
inline

Definition at line 143 of file RasterSymbolizer.h.

const std::string& te::se::RasterSymbolizer::getType ( ) const
virtual

It returns the symbolizer type.

Returns
The symbolizer type.

Implements te::se::Symbolizer.

const te::common::BaseUnitOfMeasure* te::se::Symbolizer::getUom ( ) const
inherited
const std::string& te::se::Symbolizer::getVersion ( ) const
inherited
void te::se::Symbolizer::setBaseSymbolizer ( te::xl::SimpleLink baseSymbolizer)
inherited
void te::se::RasterSymbolizer::setChannelSelection ( ChannelSelection c)
void te::se::RasterSymbolizer::setColorMap ( ColorMap c)
void te::se::RasterSymbolizer::setContrastEnhancement ( ContrastEnhancement c)
void te::se::Symbolizer::setDescription ( Description d)
inherited
void te::se::RasterSymbolizer::setGain ( ParameterValue p)
void te::se::RasterSymbolizer::setGeometry ( te::fe::PropertyName g)
void te::se::RasterSymbolizer::setImageOutline ( ImageOutline i)
void te::se::Symbolizer::setName ( const std::string &  name)
inherited
void te::se::RasterSymbolizer::setOffset ( ParameterValue p)
void te::se::RasterSymbolizer::setOpacity ( ParameterValue p)
void te::se::RasterSymbolizer::setOverlapBehavior ( OverlapBehavior  b)
void te::se::RasterSymbolizer::setShadedRelief ( ShadedRelief s)
void te::se::Symbolizer::setUom ( const te::common::BaseUnitOfMeasure *  uom)
inherited

It sets the unit-of-measure.

All Symbolizers include an optional gml:uom-attribute as used by GML (this is set inside the abstract SymbolizerType and therefore inherited by all Symbolizers). This applies to all elements included inside a Symbolizer such as stroke-width, size, font-size, Gap, InitialGap, Displacement and PerpendicularOffset. If no uom is set inside of Symbolizer, all units are measured in pixel, the behaviour used by SLD 1.0.0. The following uom definitions are recommended to be used:

void te::se::Symbolizer::setVersion ( const std::string &  version)
inherited

Member Data Documentation

ChannelSelection* te::se::RasterSymbolizer::m_channelSelection
private

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

Definition at line 162 of file RasterSymbolizer.h.

ColorMap* te::se::RasterSymbolizer::m_colorMap
private

It defines either the colors of a pallette-type raster source or the mapping of numeric pixel values to colors. (Optional)

Definition at line 164 of file RasterSymbolizer.h.

ContrastEnhancement* te::se::RasterSymbolizer::m_contrastEnhancement
private

It defines contrast enhancement for a channel of a false-color image or for a color image. (Optional)

Definition at line 165 of file RasterSymbolizer.h.

ParameterValue* te::se::RasterSymbolizer::m_gain
private

It defines the gain value used to renderer the main raster pixels, a initial value could be 1.0. (Optional)

Definition at line 160 of file RasterSymbolizer.h.

te::fe::PropertyName* te::se::RasterSymbolizer::m_geometry
private

The interpretation of Geometry is system-dependent, as raster data may be organized differently from feature data, though omitting this element selects the default raster-data source. (Optional)

Definition at line 158 of file RasterSymbolizer.h.

ImageOutline* te::se::RasterSymbolizer::m_imageOutline
private

It specifies how individual source rasters in a multi-raster set (such as a set of satellite-image scenes) should be outlined to make the individual-image locations visible. (Optional)

Definition at line 167 of file RasterSymbolizer.h.

ParameterValue* te::se::RasterSymbolizer::m_offset
private

It defines the offset value used to renderer the main raster pixels, a initial value could be 0.0. (Optional)

Definition at line 161 of file RasterSymbolizer.h.

ParameterValue* te::se::RasterSymbolizer::m_opacity
private

An Opacity of 0.0 can be selected for the main raster to avoid rendering the main-raster pixels, or an opacity can be used for a PolygonSymbolizer Fill to allow the main-raster data be visible through the fill. (Optional)

Definition at line 159 of file RasterSymbolizer.h.

OverlapBehavior te::se::RasterSymbolizer::m_overlapBehavior
private

It tells a system how to behave when multiple raster images in a layer overlap each other, for example with satellite-image scenes. (Optional)

Definition at line 163 of file RasterSymbolizer.h.

ShadedRelief* te::se::RasterSymbolizer::m_shadedRelief
private

It selects the application of relief shading (or "hill shading") to an image for a three-dimensional visual effect. (Optional)

Definition at line 166 of file RasterSymbolizer.h.

const std::string te::se::RasterSymbolizer::sm_type
staticprivate

A static data member used in the implementation of getType method.

Definition at line 169 of file RasterSymbolizer.h.


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