TePDIRadarFrostFilter Class Reference

This is the class for radar Frost filter. More...

#include <TePDIRadarFrostFilter.hpp>

Inheritance diagram for TePDIRadarFrostFilter:

List of all members.

Public Types
enum	TePDIFrostDetType { TePDIFrostDTLinear = 1, TePDIFrostDTQuadratic = 2 }
typedef TeSharedPtr < TePDIRadarFrostFilter >	pointer
typedef const TeSharedPtr < TePDIRadarFrostFilter >	const_pointer
Public Member Functions
	TePDIRadarFrostFilter ()
	Default Constructor.
	~TePDIRadarFrostFilter ()
	Default Destructor.
bool	CheckParameters (const TePDIParameters &parameters) const
	Checks if the supplied parameters fits the requirements of each PDI algorithm implementation.
Protected Member Functions
bool	RunImplementation ()
	Runs the current algorithm implementation.
void	ResetState (const TePDIParameters &params)
	Reset the internal state to the initial state.

---

Detailed Description

This is the class for radar Frost filter.

Author:

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

Note:

The general required parameters are:

Parameters:

input_image	(TePDITypes::TePDIRasterPtrType),
output_image	(TePDITypes::TePDIRasterPtrType),
channels	(std::vector<int>) - Band(s) to process. For
iterations	(int) - Iterations number,
det_type	(TePDIFrostDetType) - Detection type,
look_number	(double) - Image look number,
corr_coef	(double ) - The correlation coeficient for each convolution.

Examples:

TePDIRadarFilters_test.cpp.

---

Member Typedef Documentation

typedef const TeSharedPtr< TePDIRadarFrostFilter > TePDIRadarFrostFilter::const_pointer

Type definition for a const algorithm instance pointer.

Reimplemented from TePDIRadarFilter.

typedef TeSharedPtr< TePDIRadarFrostFilter > TePDIRadarFrostFilter::pointer

Type definition for an algorithm instance pointer.

Reimplemented from TePDIRadarFilter.

---

Member Enumeration Documentation

enum TePDIRadarFrostFilter::TePDIFrostDetType

Enumerator:

TePDIFrostDTLinear	Linear type
TePDIFrostDTQuadratic	Quadratic type

---

Constructor & Destructor Documentation

TePDIRadarFrostFilter::TePDIRadarFrostFilter

(

)

Default Constructor.

TePDIRadarFrostFilter::~TePDIRadarFrostFilter

(

)

Default Destructor.

---

Member Function Documentation

bool TePDIRadarFrostFilter::CheckParameters

(

const TePDIParameters &

parameters

)

const [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.

Implements TePDIAlgorithm.

void TePDIRadarFrostFilter::ResetState

(

const TePDIParameters &

params

)

[protected, virtual]

Reset the internal state to the initial state.

Parameters:

params

The new parameters referente at initial state.

Reimplemented from TePDIRadarFilter.

bool TePDIRadarFrostFilter::RunImplementation

(

)

[protected, virtual]

Runs the current algorithm implementation.

Returns:

true if OK. false on error.

Implements TePDIAlgorithm.

---

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

• E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIRadarFrostFilter.hpp
• E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIRadarFrostFilter.cpp