The base class for digital image processing algorithms. More...

#include <TePDIAlgorithm.hpp>

Inheritance diagram for TePDIAlgorithm:

Public Types
typedef TeSharedPtr < TePDIAlgorithm >	pointer
typedef const TeSharedPtr < TePDIAlgorithm >	const_pointer
Public Member Functions
virtual	~TePDIAlgorithm ()
	Default Destructor.
bool	Apply ()
	Applies the algorithm following the current state and internal stored parameters.
bool	Apply (const TePDIParameters &params)
	Applies the algorithm following the state defined by the supplied parameters.
bool	Reset (const TePDIParameters &params)
	Reset the internal state with new supplied parameters.
virtual bool	CheckParameters (const TePDIParameters &parameters) const =0
	Checks if the supplied parameters fits the requirements of each PDI algorithm implementation.
const TePDIParameters &	GetParameters () const
	Returns a reference to the current internal parameters.
void	ToggleProgInt (bool enabled)
	Enable / Disable the progress interface.
Static Public Member Functions
static TePDIAlgorithm *	DefaultObject (const TePDIParameters &params)
	Returns a default object.
Protected Member Functions
	TePDIAlgorithm ()
	Default Constructor.
virtual bool	RunImplementation ()=0
	Runs the current algorithm implementation.
virtual void	ResetState (const TePDIParameters &params)=0
	Reset the internal state to the initial state.
bool	CheckInternalParameters () const
	Checks if current internal parameters fits the requirements of each PDI algorithm implementation.
void	StartProgInt (const std::string &message, unsigned int steps)
	Start the progress interface.
bool	UpdateProgInt (unsigned int step)
	Update the current progress interface to the current step.
bool	IncProgInt ()
	Increments the the current progress by one step.
void	StopProgInt ()
	Stop the progress interface.
Protected Attributes
TePDIParameters	params_
	Internal parameters reference.
bool	progress_enabled_
	A flag to indicate when the algorithm should initiate a progress interface.
TePDIPIManager	pi_manager_
	The internal progress interface.

Detailed Description

The base class for digital image processing algorithms.

Author:: Emiliano F. Castejon <castejon@dpi.inpe.br>

Member Typedef Documentation

const TeSharedPtr< TePDIAlgorithm > TePDIAlgorithm::const_pointer

Type definition for a const algorithm instance pointer.

Reimplemented in TePDIBufferedFilter, TePDIEMClas, TePDIFusionIndexes, TePDIGeneralizedIHSFusion, TePDIIsosegClas, TePDIKMeansClas, TePDILevelRemap, TePDILinearFilter, TePDIRadarFilter, TePDIRadarFrostFilter, TePDIRadarGammaFilter, TePDIRadarKuanFilter, TePDIRadarLeeFilter, TePDIRaster2Vector, TePDISensorSimulator, and TePDIStatistic.

TeSharedPtr< TePDIAlgorithm > TePDIAlgorithm::pointer

Type definition for an algorithm instance pointer.

Reimplemented in TePDIBufferedFilter, TePDIEMClas, TePDIFusionIndexes, TePDIGeneralizedIHSFusion, TePDIIsosegClas, TePDIKMeansClas, TePDILevelRemap, TePDILinearFilter, TePDIRadarFilter, TePDIRadarFrostFilter, TePDIRadarGammaFilter, TePDIRadarKuanFilter, TePDIRadarLeeFilter, TePDIRaster2Vector, TePDISensorSimulator, and TePDIStatistic.

Constructor & Destructor Documentation

TePDIAlgorithm::~TePDIAlgorithm ( ) [virtual]

Default Destructor.

TePDIAlgorithm::TePDIAlgorithm ( ) [protected]

Default Constructor.

Member Function Documentation

bool TePDIAlgorithm::Apply ( )

Applies the algorithm following the current state and internal stored parameters.

Returns:: true if OK. false on error.

Examples:: TePDIArithmetic_test.cpp, TePDIBDFilter_test.cpp, TePDIClassification_test.cpp, TePDIColorTransform_test.cpp, TePDIContrast_test.cpp, TePDICorrelationMatching_test.cpp, TePDIDecorrelationEnhancement_test.cpp, TePDIFFT_test.cpp, TePDIFusion_test.cpp, TePDIHants_test.cpp, TePDILinearFilter_test.cpp, TePDIMIMatching_test.cpp, TePDIMixModel_test.cpp, TePDIMMIOMatching_test.cpp, TePDIMorfFilter_test.cpp, TePDIMosaic_test.cpp, TePDIParallelSegmenter_test.cpp, TePDIPrincipalComponents_test.cpp, TePDIRadarFilters_test.cpp, TePDIRaster2Vector_test.cpp, TePDIRegister_test.cpp, TePDISegmentation_test.cpp, TePDISensorSimulator_test.cpp, TePDISimplex_test.cpp, and TePDIWavelets_test.cpp.

bool TePDIAlgorithm::Apply ( const TePDIParameters & params )

Applies the algorithm following the state defined by the supplied parameters.

Parameters:

params The new supplied parameters.

Returns:: true if OK. false on error.

bool TePDIAlgorithm::CheckInternalParameters ( ) const [protected]

Checks if current internal parameters fits the requirements of each PDI algorithm implementation.

Note:: Error log messages must be generated. No exceptions generated.

Returns:: true if the internal parameters are OK. false if not.

virtual bool TePDIAlgorithm::CheckParameters ( const TePDIParameters & parameters ) const [pure virtual]

Checks if the supplied parameters fits the requirements of each PDI algorithm implementation.

Note:: Error log messages must be generated. No exceptions generated.

Parameters:

parameters The parameters to be checked.

Returns:: true if the parameters are OK. false if not.

Implemented in TePDIArithmetic, TePDIBaatz, TePDIBatchGeoMosaic, TePDIBDFilter, TePDIColorTransform, TePDIContrast, TePDICorrelationMatching, TePDIDecorrelationEnhancement, TePDIEMClas, TePDIFFT, TePDIFusionIndexes, TePDIGarguetFusion, TePDIGeneralizedIHSFusion, TePDIGeoMosaic, TePDIHants, TePDIHaralick, TePDIIHSFusion, TePDIIHSWaveletFusion, TePDIIsosegClas, TePDIKMeansClas, TePDILinearFilter, TePDIMallatWavelets, TePDIMIMatching, TePDIMixModel, TePDIMMIOMatching, TePDIMorfFilter, TePDIOFMatching, TePDIParallelSegmenter, TePDIPCAWaveletFusion, TePDIPrincipalComponents, TePDIPrincipalComponentsFusion, TePDIRadarFrostFilter, TePDIRadarGammaFilter, TePDIRadarKuanFilter, TePDIRadarLeeFilter, TePDIRaster2Vector, TePDIRegGrowSeg, TePDIRegister, TePDISAMClassifier, TePDISensorSimulator, TePDISimplex, TePDIStatistic, TePDITPMosaic, TePDIVenturaFusion, TePDIWaveletAtrous, TePDIWaveletAtrousFusion, and TePDIWiSpeRFusion.

TePDIAlgorithm * TePDIAlgorithm::DefaultObject ( const TePDIParameters & params ) [static]

Returns a default object.

Returns:: A default object.

const TePDIParameters & TePDIAlgorithm::GetParameters ( ) const

Returns a reference to the current internal parameters.

Returns:: A reference to the current internal parameters.

bool TePDIAlgorithm::IncProgInt ( ) [protected]

Increments the the current progress by one step.

Returns:: true if the interface was canceled, false otherwise.

Deprecated:: DEPRECATED - This method will be removed in the future (each algorithm must check the variable TePDIAlgorithm::progress_enabled_ and instantiate its own TePDIPIManager when necessary).

bool TePDIAlgorithm::Reset ( const TePDIParameters & params )

Reset the internal state with new supplied parameters.

Parameters:

params The new supplied parameters.

Returns:: true if parameters OK, false on error.

Examples:: TePDIBDFilter_test.cpp, TePDIClassification_test.cpp, TePDIColorTransform_test.cpp, TePDIContrast_test.cpp, TePDICorrelationMatching_test.cpp, TePDIDecorrelationEnhancement_test.cpp, TePDIFFT_test.cpp, TePDIFusion_test.cpp, TePDIHants_test.cpp, TePDIHaralick_test.cpp, TePDILinearFilter_test.cpp, TePDIMIMatching_test.cpp, TePDIMixModel_test.cpp, TePDIMMIOMatching_test.cpp, TePDIMorfFilter_test.cpp, TePDIOFMatching_test.cpp, TePDIPrincipalComponents_test.cpp, TePDIRadarFilters_test.cpp, TePDIRaster2Vector_test.cpp, TePDIRegister_test.cpp, TePDISegmentation_test.cpp, TePDISensorSimulator_test.cpp, TePDISimplex_test.cpp, TePDIStatistic_test.cpp, and TePDIWavelets_test.cpp.

virtual void TePDIAlgorithm::ResetState ( const TePDIParameters & params ) [protected, pure virtual]

Reset the internal state to the initial state.

Parameters:

params The new parameters referente at initial state.

Implemented in TePDIArithmetic, TePDIBaatz, TePDIBatchGeoMosaic, TePDIBDFilter, TePDIBufferedFilter, TePDIColorTransform, TePDIContrast, TePDICorrelationMatching, TePDIDecorrelationEnhancement, TePDIEMClas, TePDIFFT, TePDIFusionIndexes, TePDIGarguetFusion, TePDIGeneralizedIHSFusion, TePDIGeoMosaic, TePDIHants, TePDIHaralick, TePDIIHSFusion, TePDIIHSWaveletFusion, TePDIIsosegClas, TePDIKMeansClas, TePDILevelRemap, TePDILinearFilter, TePDIMallatWavelets, TePDIMIMatching, TePDIMixModel, TePDIMMIOMatching, TePDIMorfFilter, TePDIOFMatching, TePDIParallelSegmenter, TePDIPCAWaveletFusion, TePDIPrincipalComponents, TePDIPrincipalComponentsFusion, TePDIRadarFilter, TePDIRadarFrostFilter, TePDIRadarGammaFilter, TePDIRadarKuanFilter, TePDIRadarLeeFilter, TePDIRaster2Vector, TePDIRegGrowSeg, TePDIRegister, TePDISAMClassifier, TePDISensorSimulator, TePDISimplex, TePDIStatistic, TePDITPMosaic, TePDIVenturaFusion, TePDIWaveletAtrous, TePDIWaveletAtrousFusion, and TePDIWiSpeRFusion.

virtual bool TePDIAlgorithm::RunImplementation ( ) [protected, pure virtual]

Runs the current algorithm implementation.

Returns:: true if OK. false on error.

Implemented in TePDIArithmetic, TePDIBaatz, TePDIBatchGeoMosaic, TePDIBDFilter, TePDIColorTransform, TePDIContrast, TePDICorrelationMatching, TePDIDecorrelationEnhancement, TePDIEMClas, TePDIFFT, TePDIFusionIndexes, TePDIGarguetFusion, TePDIGeneralizedIHSFusion, TePDIGeoMosaic, TePDIHants, TePDIHaralick, TePDIIHSFusion, TePDIIHSWaveletFusion, TePDIIsosegClas, TePDIKMeansClas, TePDILinearFilter, TePDIMallatWavelets, TePDIMIMatching, TePDIMixModel, TePDIMMIOMatching, TePDIMorfFilter, TePDIOFMatching, TePDIParallelSegmenter, TePDIPCAWaveletFusion, TePDIPrincipalComponents, TePDIPrincipalComponentsFusion, TePDIRadarFrostFilter, TePDIRadarGammaFilter, TePDIRadarKuanFilter, TePDIRadarLeeFilter, TePDIRaster2Vector, TePDIRegGrowSeg, TePDIRegister, TePDISAMClassifier, TePDISensorSimulator, TePDISimplex, TePDIStatistic, TePDITPMosaic, TePDIVenturaFusion, TePDIWaveletAtrous, TePDIWaveletAtrousFusion, and TePDIWiSpeRFusion.

void TePDIAlgorithm::StartProgInt	(	const std::string &	message,
		unsigned int	steps
	)		`[protected]`

Start the progress interface.

Parameters:

message	Progress window message.
steps	Progress window total steps.

Deprecated:: DEPRECATED - This method will be removed in the future (each algorithm must check the variable TePDIAlgorithm::progress_enabled_ and instantiate its own TePDIPIManager when necessary).

void TePDIAlgorithm::StopProgInt ( ) [protected]

Stop the progress interface.

Deprecated:: DEPRECATED - This method will be removed in the future (each algorithm must check the variable TePDIAlgorithm::progress_enabled_ and instantiate its own TePDIPIManager when necessary).

void TePDIAlgorithm::ToggleProgInt ( bool enabled )

Enable / Disable the progress interface.

Parameters:

enabled Flag to enable ( true ) or disable ( false ).

Examples:: TePDICorrelationMatching_test.cpp, TePDIMIMatching_test.cpp, and TePDIOFMatching_test.cpp.

bool TePDIAlgorithm::UpdateProgInt ( unsigned int step ) [protected]

Update the current progress interface to the current step.

Parameters:

step	Current step.

Returns:: true if the interface was canceled, false otherwise.

Deprecated:: DEPRECATED - This method will be removed in the future (each algorithm must check the variable TePDIAlgorithm::progress_enabled_ and instantiate its own TePDIPIManager when necessary).

Member Data Documentation

TePDIParameters TePDIAlgorithm::params_ [mutable, protected]

Internal parameters reference.

TePDIPIManager TePDIAlgorithm::pi_manager_ [protected]

The internal progress interface.

Deprecated:: DEPRECATED - This object will be removed in the future (each algorithm must check the variable TePDIAlgorithm::progress_enabled_ and instantiate its own TePDIPIManager when necessary).

bool TePDIAlgorithm::progress_enabled_ [protected]

A flag to indicate when the algorithm should initiate a progress interface.

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

E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIAlgorithm.hpp
E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIAlgorithm.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation