Euclidean Distance Classifier strategy. More...

#include <ClassifierEDStrategy.h>

Inheritance diagram for te::rp::ClassifierEDStrategy:

Classes
class	Parameters
	Classifier Parameters. More...

Public Member Functions
	ClassifierEDStrategy ()

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.

bool	execute () _NOEXCEPT_OP(false)
	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.

unsigned int	getOutputNumberBands (void)

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

bool	initialize (ClassifierStrategyParameters const *const strategyParams) _NOEXCEPT_OP(false)
	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.

	~ClassifierEDStrategy ()

Protected Member Functions
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
std::vector< Parameters::ClassIDT >	m_classesIndex2ID
	An class index ordered vector of classes IDs;.

std::vector< std::vector< double > >	m_classesMeans
	Classes means;.

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.

Parameters::ClassIDT	m_highestTrainClassID
	The highest train class ID.

ClassifierEDStrategy::Parameters	m_initParams
	Initialization parameters.

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.

bool	m_isInitialized
	Is this instance initialized?

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 Attributes
std::string	m_errorMessage
	Current error message.

Detailed Description

Euclidean Distance Classifier strategy.

Definition at line 50 of file ClassifierEDStrategy.h.

Constructor & Destructor Documentation

◆ ClassifierEDStrategy()

te::rp::ClassifierEDStrategy::ClassifierEDStrategy ( )

References ClassifierEDStrategy().

Referenced by ClassifierEDStrategy(), and ~ClassifierEDStrategy().

◆ ~ClassifierEDStrategy()

te::rp::ClassifierEDStrategy::~ClassifierEDStrategy ( )

References ClassifierEDStrategy().

Member Function Documentation

◆ createOutputRaster()

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

protectedinherited

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 )

inherited

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 )

inherited

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 )

inherited

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 )

inherited

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()

bool te::rp::ClassifierEDStrategy::execute ( )

virtual

Executes the classification strategy.

Returns: true if OK, false on errors.

Implements te::rp::ClassifierStrategy.

References _NOEXCEPT_OP, and execute().

Referenced by execute().

◆ getErrorMessage()

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

inherited

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

inherited

Returns strategy-dependent metadata.

Parameters

metadata Strategy-dependent metadata.

References getMetaData().

Referenced by getMetaData().

◆ getOutputNumberBands()

unsigned int te::rp::ClassifierEDStrategy::getOutputNumberBands ( void )

References getOutputNumberBands().

Referenced by getOutputNumberBands().

◆ getOutputParameters()

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

virtualinherited

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()

bool te::rp::ClassifierEDStrategy::initialize ( ClassifierStrategyParameters const *const strategyParams )

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.

Implements te::rp::ClassifierStrategy.

References _NOEXCEPT_OP, and initialize().

Referenced by initialize().

◆ releaseOutputRaster()

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

inherited

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 ( )

protectedvirtualinherited

Reset to an initial state.

References reset().

Referenced by reset().

◆ setErrorMessage()

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

protectedinherited

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 )

inherited

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 )

inherited

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 )

inherited

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 )

protectedinherited

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 )

inherited

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_classesIndex2ID

std::vector< Parameters::ClassIDT > te::rp::ClassifierEDStrategy::m_classesIndex2ID

protected

An class index ordered vector of classes IDs;.

Definition at line 109 of file ClassifierEDStrategy.h.

◆ m_classesMeans

std::vector< std::vector< double > > te::rp::ClassifierEDStrategy::m_classesMeans

protected

Classes means;.

Definition at line 111 of file ClassifierEDStrategy.h.

◆ m_createRasterPalette

bool te::rp::ClassifierStrategy::m_createRasterPalette

protectedinherited

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

protectedinherited

Enable or disable the use multipe threads.

Definition at line 167 of file ClassifierStrategy.h.

◆ m_enableRasterCache

bool te::rp::ClassifierStrategy::m_enableRasterCache

protectedinherited

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

privateinherited

Current error message.

Definition at line 236 of file ClassifierStrategy.h.

◆ m_highestTrainClassID

Parameters::ClassIDT te::rp::ClassifierEDStrategy::m_highestTrainClassID

protected

The highest train class ID.

Definition at line 105 of file ClassifierEDStrategy.h.

◆ m_initParams

ClassifierEDStrategy::Parameters te::rp::ClassifierEDStrategy::m_initParams

protected

Initialization parameters.

Definition at line 107 of file ClassifierEDStrategy.h.

◆ m_inputPolygonsPtr

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

protectedinherited

Input polygons.

Definition at line 187 of file ClassifierStrategy.h.

◆ m_inputRasterBands

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

protectedinherited

Input raster bands.

Definition at line 182 of file ClassifierStrategy.h.

◆ m_inputRasterPtr

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

protectedinherited

A pointer to the input raster.

Definition at line 152 of file ClassifierStrategy.h.

◆ m_isInitialized

bool te::rp::ClassifierEDStrategy::m_isInitialized

protected

Is this instance initialized?

Definition at line 103 of file ClassifierEDStrategy.h.

◆ m_metaData

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

protectedinherited

Strategy-dependent metadata.

Definition at line 192 of file ClassifierStrategy.h.

◆ m_outputRasterPtr

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

protectedinherited

A pointer to the output raster.

Definition at line 177 of file ClassifierStrategy.h.

◆ m_progressInterfaceEnabled

bool te::rp::ClassifierStrategy::m_progressInterfaceEnabled

protectedinherited

Progress interface status.

Definition at line 157 of file ClassifierStrategy.h.

◆ m_userOutputPalette

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

protectedinherited

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/ClassifierEDStrategy.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ClassifierEDStrategy()

◆ ~ClassifierEDStrategy()

Member Function Documentation

◆ createOutputRaster()

◆ enableMultiThread()

◆ enableOutputPalette()

◆ enableProgressInterface()

◆ enableRasterCache()

◆ execute()

◆ getErrorMessage()

◆ getMetaData()

◆ getOutputNumberBands()

◆ getOutputParameters()

◆ initialize()

◆ releaseOutputRaster()

◆ reset()

◆ setErrorMessage()

◆ setInputPolygons()

◆ setInputRaster()

◆ setInputRasterBands()

◆ setOutputRasterPalette()

◆ setUserOutputPalette()

Member Data Documentation

◆ m_classesIndex2ID

◆ m_classesMeans

◆ m_createRasterPalette

◆ m_enableMultiThread

◆ m_enableRasterCache

◆ m_errorMessage

◆ m_highestTrainClassID

◆ m_initParams

◆ m_inputPolygonsPtr

◆ m_inputRasterBands

◆ m_inputRasterPtr

◆ m_isInitialized

◆ m_metaData

◆ m_outputRasterPtr

◆ m_progressInterfaceEnabled

◆ m_userOutputPalette