All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
te::rp::Algorithm Class Referenceabstract

Raster Processing algorithm base interface. More...

#include <Algorithm.h>

Inheritance diagram for te::rp::Algorithm:
te::rp::ArithmeticOperations te::rp::Classifier te::rp::Contrast te::rp::Filter te::rp::GeometricRefining te::rp::GeoMosaic te::rp::IHSFusion te::rp::MixtureModel te::rp::PCAFusion te::rp::RasterAttributes te::rp::Register te::rp::Segmenter te::rp::SequenceMosaic te::rp::Skeleton te::rp::TiePointsLocator te::rp::TiePointsMosaic

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

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

Definition at line 35 of file Algorithm.cpp.

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

Definition at line 31 of file Algorithm.cpp.

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

Definition at line 39 of file Algorithm.cpp.

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
outputParamsOutput parameters.
Returns
true if OK, false on errors.

Implemented in te::rp::GeometricRefining, te::rp::TiePointsLocator, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Contrast, te::rp::Skeleton, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::ArithmeticOperations, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, 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
inputParamsInput 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::GeometricRefining, te::rp::TiePointsLocator, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Contrast, te::rp::Skeleton, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::ArithmeticOperations, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, 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::GeometricRefining, te::rp::TiePointsLocator, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Contrast, te::rp::Skeleton, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::ArithmeticOperations, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, and te::rp::RasterAttributes.

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

Definition at line 43 of file Algorithm.cpp.

Referenced by te::rp::PCAFusion::InputParameters::InputParameters(), te::rp::GeoMosaic::InputParameters::InputParameters(), te::rp::Register::InputParameters::InputParameters(), te::rp::ArithmeticOperations::InputParameters::InputParameters(), te::rp::IHSFusion::InputParameters::InputParameters(), te::rp::Filter::InputParameters::InputParameters(), te::rp::SequenceMosaic::InputParameters::InputParameters(), te::rp::TiePointsMosaic::InputParameters::InputParameters(), te::rp::Skeleton::InputParameters::InputParameters(), te::rp::Segmenter::InputParameters::InputParameters(), te::rp::GeometricRefining::InputParameters::InputParameters(), te::rp::TiePointsLocator::InputParameters::InputParameters(), te::rp::PCAFusion::OutputParameters::OutputParameters(), te::rp::GeoMosaic::OutputParameters::OutputParameters(), te::rp::Register::OutputParameters::OutputParameters(), te::rp::ArithmeticOperations::OutputParameters::OutputParameters(), te::rp::IHSFusion::OutputParameters::OutputParameters(), te::rp::Filter::OutputParameters::OutputParameters(), te::rp::TiePointsMosaic::OutputParameters::OutputParameters(), te::rp::Skeleton::OutputParameters::OutputParameters(), te::rp::Contrast::OutputParameters::OutputParameters(), te::rp::MixtureModel::OutputParameters::OutputParameters(), te::rp::Classifier::OutputParameters::OutputParameters(), te::rp::SequenceMosaic::OutputParameters::OutputParameters(), te::rp::Segmenter::OutputParameters::OutputParameters(), te::rp::TiePointsLocator::OutputParameters::OutputParameters(), and te::rp::GeometricRefining::OutputParameters::OutputParameters().

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::GeometricRefining, te::rp::TiePointsLocator, te::rp::Segmenter, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::MixtureModel, te::rp::Contrast, te::rp::Skeleton, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::ArithmeticOperations, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, and te::rp::RasterAttributes.

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