te::rp::Filter::InputParameters Class Reference

Filter input parameters. More...

#include <Filter.h>

Inheritance diagram for te::rp::Filter::InputParameters:
te::rp::AlgorithmInputParameters te::common::AbstractParameters

Public Types

enum  FilterType {
  InvalidFilterT = 0, SobelFilterT = 1, RobertsFilterT = 2, MeanFilterT = 3,
  ModeFilterT = 4, MedianFilterT = 5, DilationFilterT = 6, ErosionFilterT = 7,
  UserDefinedWindowT = 8
}
 

Public Member Functions

AbstractParametersclone () const
 Create a clone copy of this instance. More...
 
 InputParameters ()
 
 InputParameters (const InputParameters &)
 
const InputParametersoperator= (const InputParameters &params)
 
void reset () throw ( te::rp::Exception )
 Clear all internal allocated resources and reset the parameters instance to its initial state. More...
 
 ~InputParameters ()
 

Public Attributes

bool m_enableProgress
 Enable/Disable the progress interface (default:false). More...
 
FilterType m_filterType
 The edge filter type. More...
 
std::vector< unsigned int > m_inRasterBands
 Bands to be used from the input raster 1. More...
 
te::rst::Raster const * m_inRasterPtr
 Input raster. More...
 
unsigned int m_iterationsNumber
 The number of iterations to perform (default:1). More...
 
boost::numeric::ublas::matrix< double > m_window
 User defined convolution window. (The size must be equal to m_windowH x m_windowW. Default: an empty matrix) More...
 
unsigned int m_windowH
 The height of the convolution window. (commonly 3, with W=3 to make a 3x3 window, and so on) More...
 
unsigned int m_windowW
 The width of the convolution window. More...
 

Detailed Description

Filter input parameters.

Definition at line 55 of file Filter.h.

Member Enumeration Documentation

Enumerator
InvalidFilterT 

Invalid strategy.

SobelFilterT 

Sobel filter type.

RobertsFilterT 

Roberts filter type.

MeanFilterT 

The resultant pixel will be the mean of pixels in the convolution window.

ModeFilterT 

The resultant pixel will be the mode of pixels in the convolution window. When the window is multimodal, the first mode will be assumed.

MedianFilterT 

The resultant pixel will be the median of pixels in the convolution window.

DilationFilterT 

The resultant pixel will be the highest pixel value in the convolution window.

ErosionFilterT 

The resultant pixel will be the lowest pixel value in the convolution window.

UserDefinedWindowT 

The user will define the weights of a convolution window.

Definition at line 60 of file Filter.h.

Constructor & Destructor Documentation

te::rp::Filter::InputParameters::InputParameters ( )
te::rp::Filter::InputParameters::InputParameters ( const InputParameters )
te::rp::Filter::InputParameters::~InputParameters ( )

Member Function Documentation

AbstractParameters* te::rp::Filter::InputParameters::clone ( ) const
virtual

Create a clone copy of this instance.

Returns
A clone copy of this instance.
Note
The caller will take the ownership of the returned pointer.

Implements te::common::AbstractParameters.

const InputParameters& te::rp::Filter::InputParameters::operator= ( const InputParameters params)
void te::rp::Filter::InputParameters::reset ( )
throw (te::rp::Exception
)
virtual

Clear all internal allocated resources and reset the parameters instance to its initial state.

Implements te::common::AbstractParameters.

Member Data Documentation

bool te::rp::Filter::InputParameters::m_enableProgress

Enable/Disable the progress interface (default:false).

Definition at line 85 of file Filter.h.

FilterType te::rp::Filter::InputParameters::m_filterType

The edge filter type.

Definition at line 73 of file Filter.h.

std::vector< unsigned int > te::rp::Filter::InputParameters::m_inRasterBands

Bands to be used from the input raster 1.

Definition at line 77 of file Filter.h.

te::rst::Raster const* te::rp::Filter::InputParameters::m_inRasterPtr

Input raster.

Definition at line 75 of file Filter.h.

unsigned int te::rp::Filter::InputParameters::m_iterationsNumber

The number of iterations to perform (default:1).

Definition at line 79 of file Filter.h.

boost::numeric::ublas::matrix<double> te::rp::Filter::InputParameters::m_window

User defined convolution window. (The size must be equal to m_windowH x m_windowW. Default: an empty matrix)

Definition at line 87 of file Filter.h.

unsigned int te::rp::Filter::InputParameters::m_windowH

The height of the convolution window. (commonly 3, with W=3 to make a 3x3 window, and so on)

Definition at line 81 of file Filter.h.

unsigned int te::rp::Filter::InputParameters::m_windowW

The width of the convolution window.

Definition at line 83 of file Filter.h.


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