| 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
TePDIKMeansClas Class Reference
Classification algorithms.

Kmeans classification algorithm. More...

`#include <TePDIKMeansClas.hpp>`

Inheritance diagram for TePDIKMeansClas:

List of all members.

## Public Types

typedef TeSharedPtr < TePDIKMeansClas > | pointer
typedef const TeSharedPtr < TePDIKMeansClas > | const_pointer

## Public Member Functions

| TePDIKMeansClas ()
| ~TePDIKMeansClas ()
bool | CheckParameters (const TePDIParameters &parameters) const

## Protected Member Functions

void | ResetState (const TePDIParameters &)
| Reset the internal state to the initial state.
bool | RunImplementation ()
| Runs the current algorithm implementation.

## Detailed Description

Kmeans classification algorithm.

Author:
  Eric Silva Abreu <eric@dpi.inpe.br>
  Emiliano F. Castejon <castejon@dpi.inpe.br>

Note:
  The required parameters are:

Parameters:

  input_raster | (TePDITypes::TePDIRasterPtrType) - Input raster.
  output_raster | (TePDITypes::TePDIRasterPtrType) - Output raster.
  bands | (vector<int>) - input bands.
  classes_number | (int) - number of classes.

Note:
  The optional parameters are:

Parameters:

  sample | (int) - ???? (default 1).
  iterations_number | (int) - number of iterations (default 10).
  line_begin | (int) - initial line to do classfication (default 0).
  line_end | (int) - end line to do classfication(default: the last raster line).
  column_begin | (int) - initial column to do classfication (default 0).
  column_end | (int) - end column to do classfication (default : the last raster column).

Examples:

  TePDIClassification_test.cpp.

## Member Typedef Documentation

typedef const TeSharedPtr< TePDIKMeansClas > TePDIKMeansClas::const_pointer

Type definition for a const algorithm instance pointer.

Reimplemented from TePDIAlgorithm.

typedef TeSharedPtr< TePDIKMeansClas > TePDIKMeansClas::pointer

Type definition for an algorithm instance pointer.

Reimplemented from TePDIAlgorithm.

## Constructor & Destructor Documentation

TePDIKMeansClas::TePDIKMeansClas | ( |  | ) |

Default constructor

Parameters:

  factoryName | Factory name.

TePDIKMeansClas::~TePDIKMeansClas | ( |  | ) |

Default Destructor

## Member Function Documentation

bool TePDIKMeansClas::CheckParameters | ( | const TePDIParameters & | parameters | ) | const`[virtual]`

Checks if the supplied parameters fits the requirements of each PDI strategy.

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

Reset the internal state to the initial state.

Parameters:

  params | The new parameters referent at initial state.

Implements TePDIAlgorithm.

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines