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

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

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

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

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

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

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

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

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

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

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

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

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

virtual	~ClassifierStrategy ()
	Virtual destructor. More...

Protected Member Functions
	ClassifierStrategy ()
	Default constructor. More...

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

virtual void	reset ()
	Reset to an initial state. More...

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

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

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

bool	m_enableMultiThread
	Enable or disable the use multipe threads. More...

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

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

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

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

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

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

bool	m_progressInterfaceEnabled
	Progress interface status. More...

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

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

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

Private Attributes
std::string	m_errorMessage
	Current error message. More...

Detailed Description

Raster classifier strategy base class.

Definition at line 48 of file ClassifierStrategy.h.

Constructor & Destructor Documentation

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

virtualdefault

Virtual destructor.

Referenced by ClassifierStrategy().

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

protected

Default constructor.

Definition at line 31 of file ClassifierStrategy.cpp.

References reset(), and ~ClassifierStrategy().

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

private

Copy constructor.

Parameters

rhs	The right-hand side Raster.

Definition at line 38 of file ClassifierStrategy.cpp.

References operator=(), and reset().

Member Function Documentation

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.

Definition at line 105 of file ClassifierStrategy.cpp.

References te::rst::Raster::getBand(), te::rst::Raster::getGrid(), te::rst::Band::getProperty(), te::rst::GrayIdxCInt, te::sa::Grid, te::rst::BandProperty::m_colorInterp, m_inputRasterBands, m_inputRasterPtr, te::rst::BandProperty::m_noDataValue, m_outputRasterPtr, te::rst::BandProperty::m_type, te::rst::RasterFactory::make(), and TERP_TRUE_OR_THROW.

Referenced by te::rp::ClassifierDummyStrategy::execute(), te::rp::ClassifierKMeansStrategy::execute(), te::rp::ClassifierEDStrategy::execute(), te::rp::ClassifierEMStrategy::execute(), te::rp::ClassifierMAPStrategy::execute(), te::rp::ClassifierSAMStrategy::execute(), and te::rp::ClassifierISOSegStrategy::execute().

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.

Definition at line 80 of file ClassifierStrategy.cpp.

References m_enableMultiThread.

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.

Definition at line 90 of file ClassifierStrategy.cpp.

References m_createRasterPalette.

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

Enable / disable the progress interface.

Parameters

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

Definition at line 70 of file ClassifierStrategy.cpp.

References m_progressInterfaceEnabled.

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.

Definition at line 75 of file ClassifierStrategy.cpp.

References m_enableRasterCache.

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

pure virtual

Executes the classification strategy.

Returns: true if OK, false on errors.

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

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.

Definition at line 100 of file ClassifierStrategy.cpp.

References m_errorMessage.

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

Returns strategy-dependent metadata.

Parameters

metadata Strategy-dependent metadata.

Definition at line 85 of file ClassifierStrategy.cpp.

References m_metaData.

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::ClassifierISOSegStrategy, te::rp::ClassifierSAMStrategy, te::rp::ClassifierEMStrategy, te::rp::ClassifierMAPStrategy, te::rp::ClassifierEDStrategy, te::rp::ClassifierKMeansStrategy, and te::rp::ClassifierDummyStrategy.

const te::rp::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.

Definition at line 44 of file ClassifierStrategy.cpp.

References reset().

Referenced by ClassifierStrategy().

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.

Definition at line 60 of file ClassifierStrategy.cpp.

References m_outputRasterPtr.

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

protectedvirtual

Reset to an initial state.

Definition at line 185 of file ClassifierStrategy.cpp.

References m_createRasterPalette, m_enableMultiThread, m_enableRasterCache, m_errorMessage, m_inputPolygonsPtr, m_inputRasterBands, m_inputRasterPtr, m_metaData, m_outputRasterPtr, m_progressInterfaceEnabled, and m_userOutputPalette.

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

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

protected

Set the current error message.

Parameters

newErrorMessage New error message;

Definition at line 180 of file ClassifierStrategy.cpp.

References m_errorMessage.

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.

Definition at line 65 of file ClassifierStrategy.cpp.

References m_inputPolygonsPtr.

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

Set the input raster.

Parameters

raster Input raster.

Definition at line 50 of file ClassifierStrategy.cpp.

References m_inputRasterPtr.

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

Set the input raste bandsr.

Parameters

rasterBands Input raster bands.

Definition at line 55 of file ClassifierStrategy.cpp.

References m_inputRasterBands.

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.

Definition at line 145 of file ClassifierStrategy.cpp.

References te::rp::CreateFixedStepPalette(), m_createRasterPalette, m_outputRasterPtr, m_userOutputPalette, te::rst::PaletteIdxCInt, and te::rst::RGBPalInt.

Referenced by te::rp::ClassifierDummyStrategy::execute(), te::rp::ClassifierKMeansStrategy::execute(), te::rp::ClassifierEDStrategy::execute(), te::rp::ClassifierEMStrategy::execute(), te::rp::ClassifierMAPStrategy::execute(), te::rp::ClassifierSAMStrategy::execute(), and te::rp::ClassifierISOSegStrategy::execute().

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.

Definition at line 95 of file ClassifierStrategy.cpp.

References m_userOutputPalette.

Member Data Documentation

bool te::rp::ClassifierStrategy::m_createRasterPalette

protected

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

Definition at line 164 of file ClassifierStrategy.h.

Referenced by enableOutputPalette(), reset(), and setOutputRasterPalette().

bool te::rp::ClassifierStrategy::m_enableMultiThread

protected

Enable or disable the use multipe threads.

Definition at line 159 of file ClassifierStrategy.h.

Referenced by enableMultiThread(), te::rp::ClassifierISOSegStrategy::execute(), and reset().

bool te::rp::ClassifierStrategy::m_enableRasterCache

protected

Enable or disable the use a raster data cache.

Definition at line 154 of file ClassifierStrategy.h.

Referenced by enableRasterCache(), te::rp::ClassifierISOSegStrategy::execute(), and reset().

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

private

Current error message.

Definition at line 228 of file ClassifierStrategy.h.

Referenced by getErrorMessage(), reset(), and setErrorMessage().

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

protected

Input polygons.

Definition at line 179 of file ClassifierStrategy.h.

Referenced by te::rp::ClassifierDummyStrategy::execute(), te::rp::ClassifierISOSegStrategy::execute(), reset(), and setInputPolygons().

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

protected

Input raster bands.

Definition at line 174 of file ClassifierStrategy.h.

Referenced by createOutputRaster(), te::rp::ClassifierKMeansStrategy::execute(), te::rp::ClassifierEDStrategy::execute(), te::rp::ClassifierEMStrategy::execute(), te::rp::ClassifierMAPStrategy::execute(), te::rp::ClassifierSAMStrategy::execute(), te::rp::ClassifierISOSegStrategy::execute(), reset(), and setInputRasterBands().

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

protected

A pointer to the input raster.

Definition at line 144 of file ClassifierStrategy.h.

Referenced by createOutputRaster(), te::rp::ClassifierKMeansStrategy::execute(), te::rp::ClassifierEDStrategy::execute(), te::rp::ClassifierEMStrategy::execute(), te::rp::ClassifierMAPStrategy::execute(), te::rp::ClassifierSAMStrategy::execute(), te::rp::ClassifierISOSegStrategy::execute(), reset(), and setInputRaster().

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

protected

Strategy-dependent metadata.

Definition at line 184 of file ClassifierStrategy.h.

Referenced by getMetaData(), and reset().

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

protected

A pointer to the output raster.

Definition at line 169 of file ClassifierStrategy.h.

Referenced by createOutputRaster(), te::rp::ClassifierDummyStrategy::execute(), te::rp::ClassifierKMeansStrategy::execute(), te::rp::ClassifierEDStrategy::execute(), te::rp::ClassifierEMStrategy::execute(), te::rp::ClassifierMAPStrategy::execute(), te::rp::ClassifierSAMStrategy::execute(), te::rp::ClassifierISOSegStrategy::execute(), releaseOutputRaster(), reset(), and setOutputRasterPalette().

bool te::rp::ClassifierStrategy::m_progressInterfaceEnabled

protected

Progress interface status.

Definition at line 149 of file ClassifierStrategy.h.

Referenced by enableProgressInterface(), te::rp::ClassifierEDStrategy::execute(), te::rp::ClassifierMAPStrategy::execute(), te::rp::ClassifierSAMStrategy::execute(), te::rp::ClassifierISOSegStrategy::execute(), and reset().

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 189 of file ClassifierStrategy.h.

Referenced by reset(), setOutputRasterPalette(), and setUserOutputPalette().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation