| 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 | Static Public Member Functions | Protected Attributes
TePDIFilterMask Class Reference
Image processing auxiliary classes/methods.

This is the class for image filtering mask. More...

`#include <TePDIFilterMask.hpp>`

List of all members.

## Public Types

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

## Public Member Functions

| TePDIFilterMask ()
| Default Constructor.
| TePDIFilterMask (unsigned int width, double gain=0)
| Alternative Constructor.
| ~TePDIFilterMask ()
| Default Destructor.
void | reset (unsigned int width, double gain=0)
| Resets the current mask.
unsigned int | columns () const
| The current mask coluns number.
unsigned int | lines () const
| The current mask lines number.
void | set (unsigned int line, unsigned int column, double value)
| Assingns a new value to the element.
double | get (unsigned int line, unsigned int column) const
| Returns the required element value.
double | getSum ()
| Returns the sum of the weights ( withour gain ).
void | operator= (const TePDIFilterMask &external)
| Operator = overload.
void | normalize ()
| Normalizes the current mask.
double ** | getWeightsMatrix () const
| Return a simple matrix[line][column] with the current weights.
bool | isMorfMask ()
| Verify if the mask is a morfological filter mask.

## Static Public Member Functions

static void | deleteWeightsMatrix (double **matrix, unsigned int lines)
| Frees the memory of a weights matrix.
static TePDIFilterMask::pointer | create_Dummy ()
| Creates an dummy average mask.
static TePDIFilterMask::pointer | create_Avg3x3 (bool no_norm=false)
| Creates an 3x3 average mask.
static TePDIFilterMask::pointer | create_Avg5x5 (bool no_norm=false)
| Creates an 5x5 average mask.
static TePDIFilterMask::pointer | create_Avg7x7 (bool no_norm=false)
| Creates an 7x7 average mask.
static TePDIFilterMask::pointer | create_S ()
| Creates an 3x3 South mask.
static TePDIFilterMask::pointer | create_N ()
| Creates an 3x3 North mask.
static TePDIFilterMask::pointer | create_E ()
| Creates an 3x3 East mask.
static TePDIFilterMask::pointer | create_W ()
| Creates an 3x3 West mask.
static TePDIFilterMask::pointer | create_NW ()
| Creates an 3x3 North-West mask.
static TePDIFilterMask::pointer | create_SW ()
| Creates an 3x3 South-West mask.
static TePDIFilterMask::pointer | create_NE ()
| Creates an 3x3 North-East mask.
static TePDIFilterMask::pointer | create_SE ()
| Creates an 3x3 South-East mask.
static TePDIFilterMask::pointer | create_NDLow ()
| Creates an non directional low frequencies pass filter mask.
static TePDIFilterMask::pointer | create_NDMed ()
| Creates an non directional medium frequencies pass filter mask.
static TePDIFilterMask::pointer | create_NDHigh ()
| Creates an non directional high frequencies pass filter mask.
static TePDIFilterMask::pointer | create_TMEnh (bool no_norm=false)
| Creates an filter mask for TM imagens enhancement.
static TePDIFilterMask::pointer | create_MorfD ()
| Creates an morfological (D) filter mask.
static TePDIFilterMask::pointer | create_MorfE ()
| Creates an morfological (E) filter mask.
static TePDIFilterMask::pointer | create_MorfM ()
| Creates an morfological (M) filter mask.
static TePDIFilterMask::pointer | create_MorfM_ ()
| Creates an morfological (M-) filter mask.
static TePDIFilterMask::pointer | create_MorfMPlus ()
| Creates an morfological (M+) filter mask.
static TePDIFilterMask::pointer | create_MorfMtot ()
| Creates an morfological (Mtot) filter mask.
static TePDIFilterMask::pointer | create_MorfMX ()
| Creates an morfological (MX) filter mask.

## Protected Attributes

TeMatrix | internal_matrix_
| Internal weights matrix reference.
double | weights_sum_
| Internal matrix weights sum.
double | weights_gain_
| Internal matrix weights gain.

## Detailed Description

This is the class for image filtering mask.

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

Examples:

  TePDIFilterMask_test.cpp.

## Member Typedef Documentation

const TeSharedPtr< TePDIFilterMask > TePDIFilterMask::const_pointer

Type definition for a const instance pointer

TeSharedPtr< TePDIFilterMask > TePDIFilterMask::pointer

Type definition for a instance pointer

## Constructor & Destructor Documentation

TePDIFilterMask::TePDIFilterMask | ( |  | ) |

Default Constructor.

TePDIFilterMask::TePDIFilterMask | ( | unsigned int | width,
|  | double | gain = `0`
| ) |  |

Alternative Constructor.

Parameters:

  width | Mask width ( odd values ).
  gain | Mask gain.

TePDIFilterMask::~TePDIFilterMask | ( |  | ) |

Default Destructor.

## Member Function Documentation

unsigned int TePDIFilterMask::columns | ( |  | ) | const

The current mask coluns number.

Returns:
  Mask columns number.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_Avg3x3 | ( | bool | no_norm = `false` | ) | `[static]`

Creates an 3x3 average mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp, and TePDILinearFilter_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_Avg5x5 | ( | bool | no_norm = `false` | ) | `[static]`

Creates an 5x5 average mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_Avg7x7 | ( | bool | no_norm = `false` | ) | `[static]`

Creates an 7x7 average mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp, and TePDILinearFilter_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_Dummy | ( |  | ) | `[static]`

Creates an dummy average mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp, and TePDILinearFilter_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_E | ( |  | ) | `[static]`

Creates an 3x3 East mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfD | ( |  | ) | `[static]`

Creates an morfological (D) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfE | ( |  | ) | `[static]`

Creates an morfological (E) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfM | ( |  | ) | `[static]`

Creates an morfological (M) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfM_ | ( |  | ) | `[static]`

Creates an morfological (M-) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfMPlus | ( |  | ) | `[static]`

Creates an morfological (M+) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfMtot | ( |  | ) | `[static]`

Creates an morfological (Mtot) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp, and TePDIMorfFilter_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_MorfMX | ( |  | ) | `[static]`

Creates an morfological (MX) filter mask.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_N | ( |  | ) | `[static]`

Creates an 3x3 North mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_NDHigh | ( |  | ) | `[static]`

Creates an non directional high frequencies pass filter mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp, and TePDILinearFilter_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_NDLow | ( |  | ) | `[static]`

Creates an non directional low frequencies pass filter mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_NDMed | ( |  | ) | `[static]`

Creates an non directional medium frequencies pass filter mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_NE | ( |  | ) | `[static]`

Creates an 3x3 North-East mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_NW | ( |  | ) | `[static]`

Creates an 3x3 North-West mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_S | ( |  | ) | `[static]`

Creates an 3x3 South mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp, and TePDILinearFilter_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_SE | ( |  | ) | `[static]`

Creates an 3x3 South-East mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_SW | ( |  | ) | `[static]`

Creates an 3x3 South-West mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_TMEnh | ( | bool | no_norm = `false` | ) | `[static]`

Creates an filter mask for TM imagens enhancement.

Parameters:

  no_norm | if true, no normalization will be performed.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

TePDIFilterMask::pointer TePDIFilterMask::create_W | ( |  | ) | `[static]`

Creates an 3x3 West mask.

Returns:
  The created mask.

Examples:
  TePDIFilterMask_test.cpp.

void TePDIFilterMask::deleteWeightsMatrix | ( | double ** | matrix,
|  | unsigned int | lines
| ) |  | `[static]`

Frees the memory of a weights matrix.

Parameters:

  matrix | The weights matrix.
  lines | The lines number.

Examples:
  TePDIFilterMask_test.cpp.

double TePDIFilterMask::get | ( | unsigned int | line,
|  | unsigned int | column
| ) |  | const

Returns the required element value.

Parameters:

  line | Element line.
  column | Element column.

Returns:
  The element value.

Examples:
  TePDIFilterMask_test.cpp.

double TePDIFilterMask::getSum | ( |  | ) |

Returns the sum of the weights ( withour gain ).

Returns:
  The sum of the weights ( withour gain ).

double ** TePDIFilterMask::getWeightsMatrix | ( |  | ) | const

Return a simple matrix[line][column] with the current weights.

Note:
  No automatic deletion will be performed for the returned matrix.

Returns:
  The weights matrix ( based on gain ).

bool TePDIFilterMask::isMorfMask | ( |  | ) |

Verify if the mask is a morfological filter mask.

Returns:
  true if the mask is a morfological filter mask, false if not.

unsigned int TePDIFilterMask::lines | ( |  | ) | const

The current mask lines number.

Returns:
  Mask columns number.

Examples:
  TePDIFilterMask_test.cpp.

void TePDIFilterMask::normalize | ( |  | ) |

Normalizes the current mask.

void TePDIFilterMask::operator= | ( | const TePDIFilterMask & | external | ) |

Operator = overload.

Parameters:

  external | External Mask reference.

void TePDIFilterMask::reset | ( | unsigned int | width,
|  | double | gain = `0`
| ) |  |

Resets the current mask.

Parameters:

  width | Mask width.
  gain | Mask gain.

void TePDIFilterMask::set | ( | unsigned int | line,
|  | unsigned int | column,
|  | double | value
| ) |  |

Assingns a new value to the element.

Parameters:

  line | Element line.
  column | Element column.
  value | Element velue.

## Member Data Documentation

TeMatrix TePDIFilterMask::internal_matrix_`[mutable, protected]`

Internal weights matrix reference.

double TePDIFilterMask::weights_gain_`[protected]`

Internal matrix weights gain.

double TePDIFilterMask::weights_sum_`[protected]`

Internal matrix weights sum.

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

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines