| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Protected Member Functions
TePDIRadarLeeFilter Class Reference
Filtering algorithms.

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

`#include <TePDIRadarLeeFilter.hpp>`

Inheritance diagram for TePDIRadarLeeFilter:

List of all members.

## Public Types

enum | TePDILeeFType { TePDILeeFixedType = 1, TePDILeeAdaptType = 2 }
enum | TePDILeeDetType { TePDILeeDTLinear = 1, TePDILeeDTQuadratic = 2 }
typedef TeSharedPtr < TePDIRadarLeeFilter > | pointer
typedef const TeSharedPtr < TePDIRadarLeeFilter > | const_pointer

## Public Member Functions

| TePDIRadarLeeFilter ()
| Default Constructor.
| ~TePDIRadarLeeFilter ()
| 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.
bool | RunFixedImplementation ()
| Runs the fixed window algorithm implementation.
bool | RunAdaptImplementation ()
| Runs the adaptative window algorithm implementation.
void | ResetState (const TePDIParameters &params)
| Reset the internal state to the initial state.

## Detailed Description

This is the class for radar Lee filter.

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

Note:
  The general required parameters are:

Parameters:

  filter_type | ( TePDILeeFType ),
  input_image | (TePDITypes::TePDIRasterPtrType),
  output_image | (TePDITypes::TePDIRasterPtrType),
  channels | (std::vector<int>) - Band(s) to process. For
  iterations | (int) - Iterations number,
  det_type | (TePDILeeDetType) - Detection type,
  look_number | (double) - Image look number,
  mask_width | (int) - Mask width,
  variance_threshold | (double - optional ) - The noise variance threshold for each convolution.

Examples:

  TePDIRadarFilters_test.cpp.

## Member Typedef Documentation

typedef const TeSharedPtr< TePDIRadarLeeFilter > TePDIRadarLeeFilter::const_pointer

Type definition for a const algorithm instance pointer.

Reimplemented from TePDIRadarFilter.

typedef TeSharedPtr< TePDIRadarLeeFilter > TePDIRadarLeeFilter::pointer

Type definition for an algorithm instance pointer.

Reimplemented from TePDIRadarFilter.

## Member Enumeration Documentation

enum TePDIRadarLeeFilter::TePDILeeDetType

Enumerator:

  TePDILeeDTLinear | Linear detection
  TePDILeeDTQuadratic | Quadratic detection

enum TePDIRadarLeeFilter::TePDILeeFType

Enumerator:

  TePDILeeFixedType | Fixed type
  TePDILeeAdaptType | Adaptative type

## Constructor & Destructor Documentation

TePDIRadarLeeFilter::TePDIRadarLeeFilter | ( |  | ) |

Default Constructor.

TePDIRadarLeeFilter::~TePDIRadarLeeFilter | ( |  | ) |

Default Destructor.

## Member Function Documentation

bool TePDIRadarLeeFilter::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 TePDIRadarLeeFilter::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 TePDIRadarLeeFilter::RunAdaptImplementation | ( |  | ) | `[protected]`

Runs the adaptative window algorithm implementation.

Returns:
  true if OK. false on error.

bool TePDIRadarLeeFilter::RunFixedImplementation | ( |  | ) | `[protected]`

Runs the fixed window algorithm implementation.

Returns:
  true if OK. false on error.

bool TePDIRadarLeeFilter::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/TePDIRadarLeeFilter.hpp
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIRadarLeeFilter.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines