te::rp::Classifier Class Reference

Raster classification. More...

#include <Classifier.h>

Inheritance diagram for te::rp::Classifier:

Classes
class	InputParameters
	Classifier input parameters. More...
class	OutputParameters
	Classifier output parameters. More...

Public Member Functions
	Classifier ()
bool	execute (AlgorithmOutputParameters &outputParams) throw (te::rp::Exception)
	Executes the algorithm using the supplied parameters. More...
const std::string &	getErrorMessage () const
	Return the current error message if there is any. More...
bool	initialize (const AlgorithmInputParameters &inputParams) throw (te::rp::Exception)
	Initialize the algorithm instance making it ready for execution. More...
bool	isInitialized () const
	Returns true if the algorithm instance is initialized and ready for execution. More...
void	reset () throw (te::rp::Exception)
	Clear all internal allocated objects and reset the algorithm to its initial state. More...
	~Classifier ()

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

Protected Attributes
Classifier::InputParameters	m_inputParameters
	Classifier execution parameters. More...
bool	m_instanceInitialized
	Is this instance already initialized? More...

Detailed Description

Raster classification.

Raster classification following the choosed strategy.

Note

The created label image will be written to the raster instance pointed by m_outRasterPtr (in this case the output band must also be passed by m_outRasterBand).

Definition at line 65 of file Classifier.h.

Constructor & Destructor Documentation

Classifier()

te::rp::Classifier::Classifier

(

)

~Classifier()

te::rp::Classifier::~Classifier

(

)

Member Function Documentation

execute()

bool te::rp::Classifier::execute ( AlgorithmOutputParameters &  outputParams ) throw ( te::rp::Exception )

virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams

Output parameters.

Returns

true if OK, false on errors.

Note

A return error string can be obtained via Algorithm::getErrorMessage()

Implements te::rp::Algorithm.

getErrorMessage()

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

inherited

Return the current error message if there is any.

Returns

Return the current error message if there is any.

initialize()

bool te::rp::Classifier::initialize ( const AlgorithmInputParameters &  inputParams ) throw ( te::rp::Exception )

virtual

Initialize the algorithm instance making it ready for execution.

Parameters

inputParams

Input parameters.

Returns

true if OK, false on errors.

Note

A return error string can be obtained via Algorithm::getErrorMessage()

Implements te::rp::Algorithm.

isInitialized()

bool te::rp::Classifier::isInitialized ( ) const

virtual

Returns true if the algorithm instance is initialized and ready for execution.

Returns

true if the algorithm instance is initialized and ready for execution.

Implements te::rp::Algorithm.

reset()

void te::rp::Classifier::reset ( ) throw ( te::rp::Exception )

virtual

Clear all internal allocated objects and reset the algorithm to its initial state.

Reimplemented from te::rp::Algorithm.

setErrorMessage()

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

protectedinherited

Set the current error message.

Parameters

newErrorMessage

New error message;

Member Data Documentation

m_inputParameters

Classifier::InputParameters te::rp::Classifier::m_inputParameters

protected

Classifier execution parameters.

Definition at line 184 of file Classifier.h.

m_instanceInitialized

bool te::rp::Classifier::m_instanceInitialized

protected

Is this instance already initialized?

Definition at line 183 of file Classifier.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/rp/Classifier.h