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:

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...

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.
te::fe::PropertyName *	m_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...

ParameterValue *	m_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...

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

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

ParameterValue *	m_noDataValue
	It defines the no data value used to renderer the main raster pixels, a initial value is infinite value. (Optional) More...

ParameterValue *	m_channelDomain
	It defines The channel domain (real, imaginary, i.e.) to use as source (see te::map::RasterTransform::ChannelDomain for reference). More...

ChannelSelection *	m_channelSelection
	It specifies the false-color channel selection for a multi-spectral raster source (such as a multi-band satellite-imagery source). (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...

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

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

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

ImageOutline *	m_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...

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

void	setGeometry (te::fe::PropertyName *g)

void	setOpacity (ParameterValue *p)

void	setGain (ParameterValue *p)

void	setOffset (ParameterValue *p)

void	setNoDataValue (ParameterValue *p)

void	setChannelDomain (ParameterValue *p)

ParameterValue *	getOpacity () const

ParameterValue *	getGain () const

ParameterValue *	getOffset () const

ParameterValue *	getNoDataValue () const

ParameterValue *	getChannelDomain () const

void	setChannelSelection (ChannelSelection *c)

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

void	setOverlapBehavior (OverlapBehavior b)

OverlapBehavior	getOverlapBehavior () const

void	setColorMap (ColorMap *c)

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

void	setContrastEnhancement (ContrastEnhancement *c)

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

void	setShadedRelief (ShadedRelief *s)

ShadedRelief *	getShadedRelief () const

void	setImageOutline (ImageOutline *i)

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

const std::string &	getType () const
	It returns the symbolizer type. More...

Symbolizer *	clone () const
	It creates a new copy of this object. More...

Accessor methods
Methods used to get or set properties.
std::string	m_name
	It allows the symbolizer to be referenced externally, which is needed in some methods of SE usage. (Optional) More...

Description *	m_description
	It gives the familiar short title for display lists and longer description for the symbolizer. (Optional) More...

te::xl::SimpleLink *	m_baseSymbolizer
	A BaseSymbolizer (an OnlineResource) defines the default properties of a Symbolizer to be those of an external Symbolizer, which will frequently be inside of an OGC Symbolizer repository. The Symbolizer properties given in-line override the base-Symbolizer properties. (Optional) More...

std::string	m_version
	The version is an optional attribute on the FeatureType Style element that identifies the SE version number that the FeatureTypeStyle corresponds to. For now, the only allowed value is 1.1.0. (Mandatory) More...

const te::common::BaseUnitOfMeasure *	m_uom
	Unit of measurement. If no uom is set inside of Symbolizer, all units are measured in pixel. (Mandatory) More...

void	setName (const std::string &name)

const std::string &	getName () const

void	setDescription (Description *d)

const Description *	getDescription () const

void	setBaseSymbolizer (te::xl::SimpleLink *baseSymbolizer)

const te::xl::SimpleLink *	getBaseSymbolizer () 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

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

◆ ReturnType

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

inherited

Definition at line 58 of file BaseVisitable.h.

◆ VisitorType

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

inherited

Definition at line 57 of file BaseVisitable.h.

Member Enumeration Documentation

◆ OverlapBehavior

enum te::se::RasterSymbolizer::OverlapBehavior

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

◆ RasterSymbolizer() [1/2]

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

It initializes a new RasterSymbolizer.

◆ RasterSymbolizer() [2/2]

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

Copy constructor.

Parameters

rhs	The other raster symbolizer.

◆ ~RasterSymbolizer()

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

Destructor.

Member Function Documentation

◆ accept()

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

pure virtualinherited

It call the visit method from the guest object.

Parameters

guest The guest or visitor.

Returns: Any valid value define by the template type R.

◆ clone()

Symbolizer * te::se::RasterSymbolizer::clone ( ) const

virtual

It creates a new copy of this object.

Implements te::se::Symbolizer.

◆ getBaseSymbolizer()

const te::xl::SimpleLink * te::se::Symbolizer::getBaseSymbolizer ( ) const

inherited

◆ getChannelDomain()

ParameterValue * te::se::RasterSymbolizer::getChannelDomain ( ) const

inline

Definition at line 131 of file RasterSymbolizer.h.

◆ getChannelSelection()

te::se::ChannelSelection * te::se::RasterSymbolizer::getChannelSelection ( ) const

inline

Definition at line 135 of file RasterSymbolizer.h.

◆ getColorMap()

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

inline

Definition at line 143 of file RasterSymbolizer.h.

◆ getContrastEnhancement()

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

inline

Definition at line 147 of file RasterSymbolizer.h.

◆ getDescription()

const Description * te::se::Symbolizer::getDescription ( ) const

inherited

◆ getGain()

ParameterValue * te::se::RasterSymbolizer::getGain ( ) const

inline

Definition at line 125 of file RasterSymbolizer.h.

◆ getImageOutline()

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

inline

Definition at line 155 of file RasterSymbolizer.h.

◆ getName()

const std::string & te::se::Symbolizer::getName ( ) const

inherited

◆ getNoDataValue()

ParameterValue * te::se::RasterSymbolizer::getNoDataValue ( ) const

inline

Definition at line 129 of file RasterSymbolizer.h.

◆ getOffset()

ParameterValue * te::se::RasterSymbolizer::getOffset ( ) const

inline

Definition at line 127 of file RasterSymbolizer.h.

◆ getOpacity()

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

inline

Definition at line 123 of file RasterSymbolizer.h.

◆ getOverlapBehavior()

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

inline

Definition at line 139 of file RasterSymbolizer.h.

◆ getShadedRelief()

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

inline

Definition at line 151 of file RasterSymbolizer.h.

◆ getType()

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

virtual

It returns the symbolizer type.

Returns: The symbolizer type.

Implements te::se::Symbolizer.

◆ getUom()

const te::common::BaseUnitOfMeasure * te::se::Symbolizer::getUom ( ) const

inherited

◆ getVersion()

const std::string & te::se::Symbolizer::getVersion ( ) const

inherited

◆ setBaseSymbolizer()

void te::se::Symbolizer::setBaseSymbolizer ( te::xl::SimpleLink * baseSymbolizer )

inherited

◆ setChannelDomain()

void te::se::RasterSymbolizer::setChannelDomain ( ParameterValue * p )

◆ setChannelSelection()

void te::se::RasterSymbolizer::setChannelSelection ( ChannelSelection * c )

◆ setColorMap()

void te::se::RasterSymbolizer::setColorMap ( ColorMap * c )

◆ setContrastEnhancement()

void te::se::RasterSymbolizer::setContrastEnhancement ( ContrastEnhancement * c )

◆ setDescription()

void te::se::Symbolizer::setDescription ( Description * d )

inherited

◆ setGain()

void te::se::RasterSymbolizer::setGain ( ParameterValue * p )

◆ setGeometry()

void te::se::RasterSymbolizer::setGeometry ( te::fe::PropertyName * g )

◆ setImageOutline()

void te::se::RasterSymbolizer::setImageOutline ( ImageOutline * i )

◆ setName()

void te::se::Symbolizer::setName ( const std::string & name )

inherited

◆ setNoDataValue()

void te::se::RasterSymbolizer::setNoDataValue ( ParameterValue * p )

◆ setOffset()

void te::se::RasterSymbolizer::setOffset ( ParameterValue * p )

◆ setOpacity()

void te::se::RasterSymbolizer::setOpacity ( ParameterValue * p )

◆ setOverlapBehavior()

void te::se::RasterSymbolizer::setOverlapBehavior ( OverlapBehavior b )

◆ setShadedRelief()

void te::se::RasterSymbolizer::setShadedRelief ( ShadedRelief * s )

◆ setUom()

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:

◆ setVersion()

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

inherited

Member Data Documentation

◆ m_baseSymbolizer

te::xl::SimpleLink* te::se::Symbolizer::m_baseSymbolizer

privateinherited

A BaseSymbolizer (an OnlineResource) defines the default properties of a Symbolizer to be those of an external Symbolizer, which will frequently be inside of an OGC Symbolizer repository. The Symbolizer properties given in-line override the base-Symbolizer properties. (Optional)

Definition at line 164 of file Symbolizer.h.

◆ m_channelDomain

ParameterValue* te::se::RasterSymbolizer::m_channelDomain

private

It defines The channel domain (real, imaginary, i.e.) to use as source (see te::map::RasterTransform::ChannelDomain for reference).

Definition at line 171 of file RasterSymbolizer.h.

◆ m_channelSelection

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 172 of file RasterSymbolizer.h.

◆ m_colorMap

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 174 of file RasterSymbolizer.h.

◆ m_contrastEnhancement

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 175 of file RasterSymbolizer.h.

◆ m_description

Description* te::se::Symbolizer::m_description

privateinherited

It gives the familiar short title for display lists and longer description for the symbolizer. (Optional)

Definition at line 163 of file Symbolizer.h.

◆ m_gain

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 168 of file RasterSymbolizer.h.

◆ m_geometry

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 166 of file RasterSymbolizer.h.

◆ m_imageOutline

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 177 of file RasterSymbolizer.h.

◆ m_name

std::string te::se::Symbolizer::m_name

privateinherited

It allows the symbolizer to be referenced externally, which is needed in some methods of SE usage. (Optional)

Definition at line 162 of file Symbolizer.h.

◆ m_noDataValue

ParameterValue* te::se::RasterSymbolizer::m_noDataValue

private

It defines the no data value used to renderer the main raster pixels, a initial value is infinite value. (Optional)

Definition at line 170 of file RasterSymbolizer.h.

◆ m_offset

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 169 of file RasterSymbolizer.h.

◆ m_opacity

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 167 of file RasterSymbolizer.h.

◆ m_overlapBehavior

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 173 of file RasterSymbolizer.h.

◆ m_shadedRelief

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 176 of file RasterSymbolizer.h.

◆ m_uom

const te::common::BaseUnitOfMeasure* te::se::Symbolizer::m_uom

privateinherited

Unit of measurement. If no uom is set inside of Symbolizer, all units are measured in pixel. (Mandatory)

Definition at line 166 of file Symbolizer.h.

◆ m_version

std::string te::se::Symbolizer::m_version

privateinherited

The version is an optional attribute on the FeatureType Style element that identifies the SE version number that the FeatureTypeStyle corresponds to. For now, the only allowed value is 1.1.0. (Mandatory)

Definition at line 165 of file Symbolizer.h.

◆ sm_type

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

staticprivate

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

Definition at line 179 of file RasterSymbolizer.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/se/RasterSymbolizer.h

Public Types

Public Member Functions

Accessor methods

Accessor methods

Detailed Description

Member Typedef Documentation

◆ ReturnType

◆ VisitorType

Member Enumeration Documentation

◆ OverlapBehavior

Constructor & Destructor Documentation

◆ RasterSymbolizer() [1/2]

◆ RasterSymbolizer() [2/2]

◆ ~RasterSymbolizer()

Member Function Documentation

◆ accept()

◆ clone()

◆ getBaseSymbolizer()

◆ getChannelDomain()

◆ getChannelSelection()

◆ getColorMap()

◆ getContrastEnhancement()

◆ getDescription()

◆ getGain()

◆ getImageOutline()

◆ getName()

◆ getNoDataValue()

◆ getOffset()

◆ getOpacity()

◆ getOverlapBehavior()

◆ getShadedRelief()

◆ getType()

◆ getUom()

◆ getVersion()

◆ setBaseSymbolizer()

◆ setChannelDomain()

◆ setChannelSelection()

◆ setColorMap()

◆ setContrastEnhancement()

◆ setDescription()

◆ setGain()

◆ setGeometry()

◆ setImageOutline()

◆ setName()

◆ setNoDataValue()

◆ setOffset()

◆ setOpacity()

◆ setOverlapBehavior()

◆ setShadedRelief()

◆ setUom()

◆ setVersion()

Member Data Documentation

◆ m_baseSymbolizer

◆ m_channelDomain

◆ m_channelSelection

◆ m_colorMap

◆ m_contrastEnhancement

◆ m_description

◆ m_gain

◆ m_geometry

◆ m_imageOutline

◆ m_name

◆ m_noDataValue

◆ m_offset

◆ m_opacity

◆ m_overlapBehavior

◆ m_shadedRelief

◆ m_uom

◆ m_version

◆ sm_type