| 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
TePDIWaveletAtrous Class Reference
Wavelets algorithms.

This is the class for principal components generation. More...

`#include <TePDIWaveletAtrous.hpp>`

Inheritance diagram for TePDIWaveletAtrous:

List of all members.

## Public Types

enum | TeWaveletAtrousDirection { DECOMPOSE, RECOMPOSE }
enum | FilterType { B3SplineFilter, TriangleFilter }

## Public Member Functions

| TePDIWaveletAtrous ()
| Default Constructor.
| ~TePDIWaveletAtrous ()
| 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 ()
| Decide the direction of the analysis based on the direction parameter.
bool | RunImplementation_decompose ()
| Decomposition.
bool | RunImplementation_recompose ()
| Recomposition.
void | ResetState (const TePDIParameters &)
| Reset the internal state to the initial state.
bool | filterBank (string filterFile, TeMatrix &filter)
bool | filterBank (FilterType filtertype, TeMatrix &filter)

## Detailed Description

This is the class for principal components generation.

Author:
  Felipe Castro da Silva <felipe@dpi.inpe.br>

Note:
  The general required parameters are:

Parameters:

  direction | (TeWaveletAtrousDirection) - Decompose or Recompose.

Note:
  The required parameters for the DECOMPOSE are:

Parameters:

  input_raster | (TePDITypes::TePDIRasterPtrType) - Raster to do wavelet analysis.
  band | (int) - Raster band.
  levels | (int) - Levels to decompose the raster.
  output_wavelets | (TePDITypes::TePDIRasterVectorType) - Raster vector to store de residual and coefficients planes - All output rasters must be pre-initiated with the same number of lines and columns of the input_raster and with the number of bands related to the desired wavelet planes.

Note:
  The DECOMPOSE optional parameters are:

Parameters:

  filter_file | (std::string) - Input filter file name (default: Use internal filter bank TriangleFilter).
  filter_type | (TePDIWaveletAtrous::FilterType) - Filter type (default:TriangleFilter).

Note:
  The required parameters for the RECOMPOSE are:

Parameters:

  input_rasters_wavelets | (std::vector<TePDITypes::TePDIRasterVectorType>) - Residual and coefficient planes for each band.
  rasters_levels | (int) - Number of decomposition in the input_rasters_wavelets.
  reference_raster_wavelets | (TePDITypes::TePDIRasterVectorType) - Residual and coefficient planes for the reference band.
  reference_levels | (int) - Number of decomposition in the reference_raster_wavelets.
  output_rasters | (TePDITypes::TePDIRasterVectorType) - Output raster after recomposing the wavelet analysis.

Examples:

  TePDIWavelets_test.cpp.

## Member Enumeration Documentation

enum TePDIWaveletAtrous::FilterType

Enumerator:

  B3SplineFilter |
  TriangleFilter |

enum TePDIWaveletAtrous::TeWaveletAtrousDirection

Decompose or Compose

Enumerator:

  DECOMPOSE |
  RECOMPOSE |

## Constructor & Destructor Documentation

TePDIWaveletAtrous::TePDIWaveletAtrous | ( |  | ) |

Default Constructor.

TePDIWaveletAtrous::~TePDIWaveletAtrous | ( |  | ) |

Default Destructor.

## Member Function Documentation

bool TePDIWaveletAtrous::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.

bool TePDIWaveletAtrous::filterBank | ( | FilterType | filtertype,
|  | TeMatrix & | filter
| ) |  | `[protected]`

bool TePDIWaveletAtrous::filterBank | ( | string | filterFile,
|  | TeMatrix & | filter
| ) |  | `[protected]`

void TePDIWaveletAtrous::ResetState | ( | const TePDIParameters & |  | ) | `[protected, virtual]`

Reset the internal state to the initial state.

Parameters:

  params | The new parameters referente at initial state.

Implements TePDIAlgorithm.

bool TePDIWaveletAtrous::RunImplementation | ( |  | ) | `[protected, virtual]`

Decide the direction of the analysis based on the direction parameter.

Returns:
  true if OK. false on error.

Implements TePDIAlgorithm.

bool TePDIWaveletAtrous::RunImplementation_decompose | ( |  | ) | `[protected]`

Decomposition.

Returns:
  true if OK. false on error.

bool TePDIWaveletAtrous::RunImplementation_recompose | ( |  | ) | `[protected]`

Recomposition.

Returns:
  true if OK. false on error.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIWaveletAtrous.hpp
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIWaveletAtrous.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines