| 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
TePDIPrincipalComponents Class Reference
General purpose algorithms.

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

`#include <TePDIPrincipalComponents.hpp>`

Inheritance diagram for TePDIPrincipalComponents:

List of all members.

## Public Types

enum | TePDIPCAType { TePDIPCADirect, TePDIPCAInverse }

## Public Member Functions

| TePDIPrincipalComponents ()
| Default Constructor.
| ~TePDIPrincipalComponents ()
| 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 analysis_type parameter.
bool | RunImplementation_direct ()
| Runs the direct algorithm.
bool | RunImplementation_inverse ()
| Runs the inverse algorithm.
void | ResetState (const TePDIParameters &params)
| Reset the internal state to the initial state.

## Detailed Description

This is the class for principal components generation.

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

Note:
  The required parameters are:

Parameters:

  analysis_type | ( TePDIPrincipalComponents::TePDIPCAType )
  input_rasters | ( TePDITypes::TePDIRasterVectorType )
  output_rasters | ( TePDITypes::TePDIRasterVectorType )
  bands | ( std::vector< int > ) - The bands from each input raster.
  covariance_matrix | ( TeSharedPtr<TeMatrix> ) - This is the output covariance matrix generated when TePDIPCADirect is used, or, this is the input covariance matrix when TePDIPCAInverse is used.

Examples:

  TePDIPrincipalComponents_test.cpp.

## Member Enumeration Documentation

enum TePDIPrincipalComponents::TePDIPCAType

Direction of the PCA analisys

Enumerator:

  TePDIPCADirect |
  TePDIPCAInverse |

## Constructor & Destructor Documentation

TePDIPrincipalComponents::TePDIPrincipalComponents | ( |  | ) |

Default Constructor.

TePDIPrincipalComponents::~TePDIPrincipalComponents | ( |  | ) |

Default Destructor.

## Member Function Documentation

bool TePDIPrincipalComponents::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 TePDIPrincipalComponents::ResetState | ( | const TePDIParameters & | params | ) | `[protected, virtual]`

Reset the internal state to the initial state.

Parameters:

  params | The new parameters referente at initial state.

Implements TePDIAlgorithm.

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

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

Returns:
  true if OK. false on error.

Implements TePDIAlgorithm.

bool TePDIPrincipalComponents::RunImplementation_direct | ( |  | ) | `[protected]`

Runs the direct algorithm.

Returns:
  true if OK. false on error.

bool TePDIPrincipalComponents::RunImplementation_inverse | ( |  | ) | `[protected]`

Runs the inverse algorithm.

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines