The transformation of continuous values to a number of values (Interpolate function). More...

#include <Interpolate.h>

Inheritance diagram for te::se::Interpolate:

Public Types
enum	MethodType { NUMERIC, COLOR }
	It controls the ... More...

enum	ModeType { LINEAR, COSINE, CUBIC }
	It controls the ... 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...

const std::string &	getFallbackValue () const

void	setFallbackValue (const std::string &v)

Initializer Methods
Methods related to instantiation and destruction.
	Interpolate ()
	It initializes a new Interpolate. More...

	Interpolate (const Interpolate &rhs)
	Copy constructor. More...

	~Interpolate ()
	Destructor. More...

virtual Interpolate *	clone () const
	It returns a clone of this object. More...

Accessor methods
Methods used to get or set properties.
void	setLookupValue (ParameterValue *v)

ParameterValue *	getLookupValue () const

void	add (InterpolationPoint *i)

void	setModeType (ModeType t)

const ModeType &	getModeType () const

void	setMethodType (MethodType t)

const MethodType &	geMethodType () const

const std::vector< InterpolationPoint * > &	getInterpolationPoints () const

Protected Attributes
std::string	m_fallbackValue
	The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function. If the implementation supports the function, then the result value is determined by executing the function. (Mandatory) More...

Private Attributes
std::vector< InterpolationPoint * >	m_interpolationPoints
	Mandatory. More...

ParameterValue *	m_lookupValue
	Mandatory. More...

MethodType	m_method
	Mandatory. More...

ModeType	m_mode
	Mandatory. More...

Detailed Description

The transformation of continuous values to a number of values (Interpolate function).

The Symbology encoding specification defines three pre-defined functions for transforming raw data:

Categorization: The transformation of continuous values to distinct values. This is for example needed to generate choropleth maps from continuous attributes. Another example would be the stepwise selection of different text heights or line widths in dependence from such an attribute;
Interpolation: Transformation of continuous values by a function defined on a number of nodes. This is used to adjust the value distribution of an attribute to the desired distribution of a continuous symbolization control variable (like size, width, color, etc);
Recoding: Transformation of discrete values to any other values. This is needed when integers have to be translated into text or, reversely, text contents into other texts or numeric values or colors.

The Interpolation points have to be specified in ascending order of Data. They define a graph of points. LookupValues less than the Data value of the first InterpolationPoint are mapped to its corresponding Value. Accordingly, LookupValues greater than the Data value of the last InterpolationPoint are mapped to the Value of this one. LookupValues between two InterpolationPoints are interpolated between the corresponding Values.
Only numeric quantities are allowed for LookupValue and Data. Values are usually numeric as well. The interpolation of color-values requires the attribute mode="color" at the Interpolate element.

See also: Function, ParameterValue, InterpolationPoint

Definition at line 88 of file Interpolate.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

enum te::se::Interpolate::MethodType

It controls the ...

Enumerator
NUMERIC
COLOR

Definition at line 109 of file Interpolate.h.

enum te::se::Interpolate::ModeType

It controls the ...

Enumerator
LINEAR
COSINE
CUBIC

Definition at line 97 of file Interpolate.h.

Constructor & Destructor Documentation

te::se::Interpolate::Interpolate ( )

It initializes a new Interpolate.

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

Copy constructor.

Parameters

rhs	The other Interpolate.

te::se::Interpolate::~Interpolate ( )

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

guest The guest or visitor.

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

void te::se::Interpolate::add ( InterpolationPoint * i )

virtual Interpolate* te::se::Interpolate::clone ( ) const

virtual

It returns a clone of this object.

Returns: A clone of this object.

Implements te::fe::Expression.

const MethodType& te::se::Interpolate::geMethodType ( ) const

inline

Definition at line 159 of file Interpolate.h.

const std::string& te::se::Function::getFallbackValue ( ) const

inherited

const std::vector<InterpolationPoint*>& te::se::Interpolate::getInterpolationPoints ( ) const

ParameterValue* te::se::Interpolate::getLookupValue ( ) const

inline

Definition at line 149 of file Interpolate.h.

const ModeType& te::se::Interpolate::getModeType ( ) const

inline

Definition at line 155 of file Interpolate.h.

void te::se::Function::setFallbackValue ( const std::string & v )

inherited

void te::se::Interpolate::setLookupValue ( ParameterValue * v )

void te::se::Interpolate::setMethodType ( MethodType t )

void te::se::Interpolate::setModeType ( ModeType t )

Member Data Documentation

std::string te::se::Function::m_fallbackValue

protectedinherited

The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function. If the implementation supports the function, then the result value is determined by executing the function. (Mandatory)

Definition at line 88 of file Function.h.

std::vector<InterpolationPoint*> te::se::Interpolate::m_interpolationPoints

private

Mandatory.

Definition at line 168 of file Interpolate.h.

ParameterValue* te::se::Interpolate::m_lookupValue

private

Mandatory.

Definition at line 167 of file Interpolate.h.

MethodType te::se::Interpolate::m_method

private

Mandatory.

Definition at line 170 of file Interpolate.h.

ModeType te::se::Interpolate::m_mode

private

Mandatory.

Definition at line 169 of file Interpolate.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/se/Interpolate.h

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation