Raster classifier strategy base class. More...

#include <ClassifierStrategy.h>

Inheritance diagram for te::rp::ClassifierStrategy:

Public Member Functions
void	enableMultiThread (const bool &enable)
	Enable / disable the use of multiple threads.

void	enableOutputPalette (const bool enabled)
	Enable (true) or disable (false) the creation of a paletted output raster.

void	enableProgressInterface (const bool &enable)
	Enable / disable the progress interface.

void	enableRasterCache (const bool &enable)
	Enable / disable the use of raster data cache.

virtual bool	execute () _NOEXCEPT_OP(false)=0
	Executes the classification strategy.

const std::string &	getErrorMessage () const
	Return the current error message if there is any.

void	getMetaData (std::map< std::string, std::string > &metadata) const
	Returns strategy-dependent metadata.

virtual ClassifierStrategyOutParameters const *	getOutputParameters () const
	Returns a pointer to the strategy output execution parameters or a null pointer if there are none.

virtual bool	initialize (ClassifierStrategyParameters const *const strategyParams) _NOEXCEPT_OP(false)=0
	Initialize the classification strategy.

std::unique_ptr< te::rst::Raster >	releaseOutputRaster ()
	Returns a pointer to the output raster or a void pointer if there is none.

void	setInputPolygons (const std::vector< te::gm::Polygon * > &polygonsPtrs)
	Set the input polygons.

void	setInputRaster (const te::rst::Raster &raster)
	Set the input raster.

void	setInputRasterBands (const std::vector< unsigned int > &rasterBands)
	Set the input raste bandsr.

void	setUserOutputPalette (std::vector< te::rst::BandProperty::ColorEntry > &userPalette)
	Set the output user palette.

virtual	~ClassifierStrategy ()
	Virtual destructor.

Protected Member Functions
	ClassifierStrategy ()
	Default constructor.

bool	createOutputRaster (const std::vector< int > &bandsDataTypes, const std::vector< double > &noDataValues)
	Create the output raster using the EXPANSIBLE driver.

virtual void	reset ()
	Reset to an initial state.

void	setErrorMessage (const std::string &newErrorMessage)
	Set the current error message.

bool	setOutputRasterPalette (const unsigned int size)
	Create and set the output raster palette folowing the current internal settings.

Protected Attributes
bool	m_createRasterPalette
	Enable (true) or disable (false) the creation of a paletted output raster.

bool	m_enableMultiThread
	Enable or disable the use multipe threads.

bool	m_enableRasterCache
	Enable or disable the use a raster data cache.

std::vector< te::gm::Polygon * > const *	m_inputPolygonsPtr
	Input polygons.

std::vector< unsigned int >	m_inputRasterBands
	Input raster bands.

te::rst::Raster const *	m_inputRasterPtr
	A pointer to the input raster.

std::map< std::string, std::string >	m_metaData
	Strategy-dependent metadata.

std::unique_ptr< te::rst::Raster >	m_outputRasterPtr
	A pointer to the output raster.

bool	m_progressInterfaceEnabled
	Progress interface status.

std::vector< te::rst::BandProperty::ColorEntry >	m_userOutputPalette
	User output raster palette (it must be large enough to accomodate all classifyier generated classes or an empty vector to automatically generate an random palette.

Private Member Functions
	ClassifierStrategy (const ClassifierStrategy &rhs)
	Copy constructor.

const ClassifierStrategy &	operator= (const ClassifierStrategy &rhs)
	Assignment operator.

Private Attributes
std::string	m_errorMessage
	Current error message.

Detailed Description

Raster classifier strategy base class.

Definition at line 49 of file ClassifierStrategy.h.

Constructor & Destructor Documentation

◆ ~ClassifierStrategy()

virtual te::rp::ClassifierStrategy::~ClassifierStrategy ( )

virtual

Virtual destructor.

◆ ClassifierStrategy() [1/2]

te::rp::ClassifierStrategy::ClassifierStrategy ( )

protected

Default constructor.

References ClassifierStrategy().

Referenced by ClassifierStrategy(), ClassifierStrategy(), and operator=().

◆ ClassifierStrategy() [2/2]

te::rp::ClassifierStrategy::ClassifierStrategy ( const ClassifierStrategy & rhs )

private

Copy constructor.

Parameters

rhs	The right-hand side Raster.

References ClassifierStrategy().

Member Function Documentation

◆ createOutputRaster()

bool te::rp::ClassifierStrategy::createOutputRaster	(	const std::vector< int > &	bandsDataTypes,
		const std::vector< double > &	noDataValues )

protected

Create the output raster using the EXPANSIBLE driver.

Parameters

bandsDataTypes	Bands data types.
noDataValues	A vector of no-data values for each band.

Returns: true if ok,false on errors.

Note: A pointer to the created raster will be handled by m_outputRasterPtr.

References createOutputRaster().

Referenced by createOutputRaster().

◆ enableMultiThread()

void te::rp::ClassifierStrategy::enableMultiThread ( const bool & enable )

Enable / disable the use of multiple threads.

Parameters

enable Enable (true) or disable (false) the use of multiple threads.

References enableMultiThread().

Referenced by enableMultiThread().

◆ enableOutputPalette()

void te::rp::ClassifierStrategy::enableOutputPalette ( const bool enabled )

Enable (true) or disable (false) the creation of a paletted output raster.

Parameters

enabled Enable (true) or disable (false) the creation of a paletted output raster.

References enableOutputPalette().

Referenced by enableOutputPalette().

◆ enableProgressInterface()

void te::rp::ClassifierStrategy::enableProgressInterface ( const bool & enable )

Enable / disable the progress interface.

Parameters

enable Enable (true) or disable (false) the progress interface.

References enableProgressInterface().

Referenced by enableProgressInterface().

◆ enableRasterCache()

void te::rp::ClassifierStrategy::enableRasterCache ( const bool & enable )

Enable / disable the use of raster data cache.

Parameters

enable Enable (true) or disable (false) the use of raster cache.

References enableRasterCache().

Referenced by enableRasterCache().

◆ execute()

virtual bool te::rp::ClassifierStrategy::execute ( )

pure virtual

Executes the classification strategy.

Returns: true if OK, false on errors.

Implemented in te::rp::ClassifierDummyStrategy, te::rp::ClassifierEDStrategy, te::rp::ClassifierEMStrategy, te::rp::ClassifierISODataStrategy, te::rp::ClassifierISOSegStrategy, te::rp::ClassifierKMeansStrategy, te::rp::ClassifierMAPStrategy, te::rp::ClassifierMaxLikelihoodStrategy, and te::rp::ClassifierSAMStrategy.

References _NOEXCEPT_OP.

◆ getErrorMessage()

const std::string & te::rp::ClassifierStrategy::getErrorMessage ( ) const

Return the current error message if there is any.

Returns: Return the current error message if there is any.

References getErrorMessage().

Referenced by getErrorMessage().

◆ getMetaData()

void te::rp::ClassifierStrategy::getMetaData ( std::map< std::string, std::string > & metadata ) const

Returns strategy-dependent metadata.

Parameters

metadata Strategy-dependent metadata.

References getMetaData().

Referenced by getMetaData().

◆ getOutputParameters()

virtual ClassifierStrategyOutParameters const * te::rp::ClassifierStrategy::getOutputParameters ( ) const

virtual

Returns a pointer to the strategy output execution parameters or a null pointer if there are none.

Returns: Returns a pointer to the strategy output execution parameters or a null pointer if there are none.

Reimplemented in te::rp::ClassifierMAPStrategy.

References getOutputParameters().

Referenced by getOutputParameters().

◆ initialize()

virtual bool te::rp::ClassifierStrategy::initialize ( ClassifierStrategyParameters const *const strategyParams )

pure virtual

Initialize the classification strategy.

Parameters

strategyParams A pointer to the user given specific classification strategy parameters ou NULL if no parameters are present.

Returns: true if OK, false on errors.

Implemented in te::rp::ClassifierDummyStrategy, te::rp::ClassifierEDStrategy, te::rp::ClassifierEMStrategy, te::rp::ClassifierISODataStrategy, te::rp::ClassifierISOSegStrategy, te::rp::ClassifierKMeansStrategy, te::rp::ClassifierMAPStrategy, te::rp::ClassifierMaxLikelihoodStrategy, and te::rp::ClassifierSAMStrategy.

◆ operator=()

const ClassifierStrategy & te::rp::ClassifierStrategy::operator= ( const ClassifierStrategy & rhs )

private

Assignment operator.

Parameters

rhs	The right-hand-side copy that would be used to copy from.

Returns: A reference to this object.

References ClassifierStrategy().

◆ releaseOutputRaster()

std::unique_ptr< te::rst::Raster > te::rp::ClassifierStrategy::releaseOutputRaster ( )

Returns a pointer to the output raster or a void pointer if there is none.

Returns: Returns a pointer to the output raster or a void pointer if there is none.

Note: The caller of this method must take the ownership of the returned object.

References releaseOutputRaster().

Referenced by releaseOutputRaster().

◆ reset()

virtual void te::rp::ClassifierStrategy::reset ( )

protectedvirtual

Reset to an initial state.

References reset().

Referenced by reset().

◆ setErrorMessage()

void te::rp::ClassifierStrategy::setErrorMessage ( const std::string & newErrorMessage )

protected

Set the current error message.

Parameters

newErrorMessage New error message;

References setErrorMessage().

Referenced by setErrorMessage().

◆ setInputPolygons()

void te::rp::ClassifierStrategy::setInputPolygons ( const std::vector< te::gm::Polygon * > & polygonsPtrs )

Set the input polygons.

Parameters

polygonsPtrs Input polygons pointers.

Note: The caller of this method must keep the ownership of the objects.

References setInputPolygons().

Referenced by setInputPolygons().

◆ setInputRaster()

void te::rp::ClassifierStrategy::setInputRaster ( const te::rst::Raster & raster )

Set the input raster.

Parameters

raster Input raster.

References setInputRaster().

Referenced by setInputRaster().

◆ setInputRasterBands()

void te::rp::ClassifierStrategy::setInputRasterBands ( const std::vector< unsigned int > & rasterBands )

Set the input raste bandsr.

Parameters

rasterBands Input raster bands.

References setInputRasterBands().

Referenced by setInputRasterBands().

◆ setOutputRasterPalette()

bool te::rp::ClassifierStrategy::setOutputRasterPalette ( const unsigned int size )

protected

Create and set the output raster palette folowing the current internal settings.

Parameters

size	Palette size.

Returns: true if ok,false on errors.

References setOutputRasterPalette().

Referenced by setOutputRasterPalette().

◆ setUserOutputPalette()

void te::rp::ClassifierStrategy::setUserOutputPalette ( std::vector< te::rst::BandProperty::ColorEntry > & userPalette )

Set the output user palette.

Parameters

userPalette User output raster palette (it must be large enough to accomodate all classifyier generated classes or an empty vector to automatically generate an random palette.

References setUserOutputPalette().

Referenced by setUserOutputPalette().

Member Data Documentation

◆ m_createRasterPalette

bool te::rp::ClassifierStrategy::m_createRasterPalette

protected

Enable (true) or disable (false) the creation of a paletted output raster.

Definition at line 172 of file ClassifierStrategy.h.

◆ m_enableMultiThread

bool te::rp::ClassifierStrategy::m_enableMultiThread

protected

Enable or disable the use multipe threads.

Definition at line 167 of file ClassifierStrategy.h.

◆ m_enableRasterCache

bool te::rp::ClassifierStrategy::m_enableRasterCache

protected

Enable or disable the use a raster data cache.

Definition at line 162 of file ClassifierStrategy.h.

◆ m_errorMessage

std::string te::rp::ClassifierStrategy::m_errorMessage

private

Current error message.

Definition at line 236 of file ClassifierStrategy.h.

◆ m_inputPolygonsPtr

std::vector<te::gm::Polygon*> const* te::rp::ClassifierStrategy::m_inputPolygonsPtr

protected

Input polygons.

Definition at line 187 of file ClassifierStrategy.h.

◆ m_inputRasterBands

std::vector<unsigned int> te::rp::ClassifierStrategy::m_inputRasterBands

protected

Input raster bands.

Definition at line 182 of file ClassifierStrategy.h.

◆ m_inputRasterPtr

te::rst::Raster const* te::rp::ClassifierStrategy::m_inputRasterPtr

protected

A pointer to the input raster.

Definition at line 152 of file ClassifierStrategy.h.

◆ m_metaData

std::map< std::string, std::string > te::rp::ClassifierStrategy::m_metaData

protected

Strategy-dependent metadata.

Definition at line 192 of file ClassifierStrategy.h.

◆ m_outputRasterPtr

std::unique_ptr< te::rst::Raster > te::rp::ClassifierStrategy::m_outputRasterPtr

protected

A pointer to the output raster.

Definition at line 177 of file ClassifierStrategy.h.

◆ m_progressInterfaceEnabled

bool te::rp::ClassifierStrategy::m_progressInterfaceEnabled

protected

Progress interface status.

Definition at line 157 of file ClassifierStrategy.h.

◆ m_userOutputPalette

std::vector< te::rst::BandProperty::ColorEntry > te::rp::ClassifierStrategy::m_userOutputPalette

protected

User output raster palette (it must be large enough to accomodate all classifyier generated classes or an empty vector to automatically generate an random palette.

Definition at line 197 of file ClassifierStrategy.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/rp/ClassifierStrategy.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ClassifierStrategy()

◆ ClassifierStrategy() [1/2]

◆ ClassifierStrategy() [2/2]

Member Function Documentation

◆ createOutputRaster()

◆ enableMultiThread()

◆ enableOutputPalette()

◆ enableProgressInterface()

◆ enableRasterCache()

◆ execute()

◆ getErrorMessage()

◆ getMetaData()

◆ getOutputParameters()

◆ initialize()

◆ operator=()

◆ releaseOutputRaster()

◆ reset()

◆ setErrorMessage()

◆ setInputPolygons()

◆ setInputRaster()

◆ setInputRasterBands()

◆ setOutputRasterPalette()

◆ setUserOutputPalette()

Member Data Documentation

◆ m_createRasterPalette

◆ m_enableMultiThread

◆ m_enableRasterCache

◆ m_errorMessage

◆ m_inputPolygonsPtr

◆ m_inputRasterBands

◆ m_inputRasterPtr

◆ m_metaData

◆ m_outputRasterPtr

◆ m_progressInterfaceEnabled

◆ m_userOutputPalette