te::rp::Algorithm Class Reference

Raster Processing algorithm base interface. More...

#include <Algorithm.h>

Inheritance diagram for te::rp::Algorithm:

Public Member Functions
virtual bool	execute (AlgorithmOutputParameters &outputParams)=0 throw ( te::rp::Exception )
	Executes the algorithm using the supplied parameters. More...
virtual bool	initialize (const AlgorithmInputParameters &inputParams)=0 throw ( te::rp::Exception )
	Initialize the algorithm instance making it ready for execution. More...
virtual bool	isInitialized () const =0
	Returns true if the algorithm instance is initialized and ready for execution. More...
virtual void	reset ()=0 throw ( te::rp::Exception )
	Clear all internal allocated objects and reset the algorithm to its initial state. More...
virtual	~Algorithm ()

Protected Member Functions
	Algorithm ()

Private Member Functions
	Algorithm (const Algorithm &)
const Algorithm &	operator= (const Algorithm &)

Detailed Description

Raster Processing algorithm base interface.

Definition at line 41 of file Algorithm.h.

Constructor & Destructor Documentation

virtual te::rp::Algorithm::~Algorithm ( )

virtual

te::rp::Algorithm::Algorithm ( )

protected

te::rp::Algorithm::Algorithm ( const Algorithm &  )

private

Member Function Documentation

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

pure virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams

Output parameters.

Returns

true if OK, false on errors.

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::ArithmeticOperations, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

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

pure 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 te::rp::Module::getLastLogStr()

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::ArithmeticOperations, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

virtual bool te::rp::Algorithm::isInitialized ( ) const

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

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::ArithmeticOperations, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

const Algorithm& te::rp::Algorithm::operator= ( const Algorithm &  )

private

virtual void te::rp::Algorithm::reset ( ) throw ( te::rp::Exception )

pure virtual

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

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::ArithmeticOperations, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

---

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

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