te::rp::PostClassification Class Reference

Raster post classification. More...

#include <PostClassification.h>

Inheritance diagram for te::rp::PostClassification:

Classes
class	InputParameters
	Filter input parameters. More...
class	OutputParameters
	PostClassification output parameters. More...

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

Protected Member Functions
bool	runPostClassification (const te::rst::Raster &srcRaster, te::rst::Raster &dstRaster, unsigned int weight, unsigned int threshold)
	Apply the post classification.
void	setErrorMessage (const std::string &newErrorMessage)
	Set the current error message.

Protected Attributes
PostClassification::InputParameters	m_inputParameters
	Input parameters.
bool	m_isInitialized
	Is this instance already initialized?

Private Attributes
std::string	m_errorMessage
	Current error message.

Detailed Description

Raster post classification.

Definition at line 40 of file PostClassification.h.

Constructor & Destructor Documentation

PostClassification()

te::rp::PostClassification::PostClassification

(

)

References PostClassification().

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

~PostClassification()

te::rp::PostClassification::~PostClassification

(

)

References PostClassification().

Member Function Documentation

execute()

bool te::rp::PostClassification::execute ( AlgorithmOutputParameters & outputParams )

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.

References _NOEXCEPT_OP, and execute().

Referenced by execute().

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.

References getErrorMessage().

Referenced by getErrorMessage().

initialize()

bool te::rp::PostClassification::initialize ( const AlgorithmInputParameters & inputParams )

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.

References _NOEXCEPT_OP, and initialize().

Referenced by initialize().

isInitialized()

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

References isInitialized().

Referenced by isInitialized().

reset()

void te::rp::PostClassification::reset ( )

virtual

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

Reimplemented from te::rp::Algorithm.

References _NOEXCEPT_OP, and reset().

Referenced by reset().

runPostClassification()

bool te::rp::PostClassification::runPostClassification ( const te::rst::Raster & srcRaster, te::rst::Raster & dstRaster, unsigned int weight, unsigned int threshold )

protected

Apply the post classification.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
weight	Weight value.
threshold	Threshold value.
useProgress	if true, the progress interface must be used.

References runPostClassification().

Referenced by runPostClassification().

setErrorMessage()

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

protectedinherited

Set the current error message.

Parameters

newErrorMessage

New error message;

References setErrorMessage().

Referenced by setErrorMessage().

Member Data Documentation

m_errorMessage

std::string te::rp::Algorithm::m_errorMessage

privateinherited

Current error message.

Definition at line 104 of file Algorithm.h.

m_inputParameters

PostClassification::InputParameters te::rp::PostClassification::m_inputParameters

protected

Input parameters.

Definition at line 129 of file PostClassification.h.

m_isInitialized

bool te::rp::PostClassification::m_isInitialized

protected

Is this instance already initialized?

Definition at line 127 of file PostClassification.h.

---

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

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