A series of well-known filtering algorithms for images, linear and non-linear.. More...

#include <Filter.h>

Inheritance diagram for te::rp::Filter:

Classes
class	InputParameters
	Filter input parameters. More...

class	OutputParameters
	Filter output parameters. More...

Public Member Functions
bool	execute (AlgorithmOutputParameters &outputParams) throw ( te::rp::Exception )
	Executes the algorithm using the supplied parameters. More...

	Filter ()

bool	initialize (const AlgorithmInputParameters &inputParams) throw ( te::rp::Exception )
	Initialize the algorithm instance making it ready for execution. More...

bool	isInitialized () const
	Returns true if the algorithm instance is initialized and ready for execution. More...

void	reset () throw ( te::rp::Exception )
	Clear all internal allocated objects and reset the algorithm to its initial state. More...

	~Filter ()

Protected Types
typedef bool(Filter::*	FilterMethodPointerT) (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Type definition for a filter method pointer. More...

Protected Member Functions
bool	DilationFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the dilation filter over the source raster band. More...

bool	ErosionFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the erosion filter over the source raster band. More...

bool	MeanFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the mean filter over the source raster band. More...

bool	MedianFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the median filter over the source raster band. More...

bool	ModeFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the mode filter over the source raster band. More...

bool	RobertsFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the Roberts filter over the source raster band. More...

bool	SobelFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the Sobel filter over the source raster band. More...

bool	UserDefinedFilter (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)
	Applay the user defined filter over the source raster band. More...

Static Protected Member Functions
static bool	OrderFunction (double i, double j)
	Returns true if i < j. More...

Protected Attributes
Filter::InputParameters	m_inputParameters
	Input parameters. More...

bool	m_isInitialized
	Is this instance already initialized? More...

Detailed Description

A series of well-known filtering algorithms for images, linear and non-linear..

Definition at line 47 of file Filter.h.

Member Typedef Documentation

typedef bool(Filter::* te::rp::Filter::FilterMethodPointerT) (const te::rst::Raster &srcRaster, const unsigned int srcBandIdx, te::rst::Raster &dstRaster, const unsigned int dstBandIdx, const bool useProgress)

protected

Type definition for a filter method pointer.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

Returns: true if ok, false on errors.

Definition at line 162 of file Filter.h.

Constructor & Destructor Documentation

te::rp::Filter::Filter ( )

te::rp::Filter::~Filter ( )

Member Function Documentation

bool te::rp::Filter::DilationFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the dilation filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

bool te::rp::Filter::ErosionFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the erosion filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

bool te::rp::Filter::execute	(	AlgorithmOutputParameters &	outputParams	)
throw	(	te::rp::Exception
	)

virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams Output parameters.

Returns: true if OK, false on errors.

Implements te::rp::Algorithm.

bool te::rp::Filter::initialize	(	const AlgorithmInputParameters &	inputParams	)
throw	(	te::rp::Exception
	)

virtual

Initialize the algorithm instance making it ready for execution.

Parameters

inputParams Input parameters.

Returns: true if OK, false on errors.

Note: A return error string can be obtained via te::rp::Module::getLastLogStr()

Implements te::rp::Algorithm.

bool te::rp::Filter::isInitialized ( ) const

virtual

Returns true if the algorithm instance is initialized and ready for execution.

Returns: true if the algorithm instance is initialized and ready for execution.

Implements te::rp::Algorithm.

bool te::rp::Filter::MeanFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the mean filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

bool te::rp::Filter::MedianFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the median filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

bool te::rp::Filter::ModeFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the mode filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

static bool te::rp::Filter::OrderFunction	(	double	i,
		double	j
	)

staticprotected

Returns true if i < j.

Returns: Returns true if i < j.

void te::rp::Filter::reset	(		)
throw	(	te::rp::Exception
	)

virtual

Clear all internal allocated objects and reset the algorithm to its initial state.

Implements te::rp::Algorithm.

bool te::rp::Filter::RobertsFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the Roberts filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

bool te::rp::Filter::SobelFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the Sobel filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

bool te::rp::Filter::UserDefinedFilter	(	const te::rst::Raster &	srcRaster,
		const unsigned int	srcBandIdx,
		te::rst::Raster &	dstRaster,
		const unsigned int	dstBandIdx,
		const bool	useProgress
	)

protected

Applay the user defined filter over the source raster band.

Parameters

srcRaster	Source raster.
srcBandIdx	Source raster band index.
dstRaster	Destination raster.
dstBandIdx	Destination raster band index.
useProgress	if true, the progress interface must be used.

Member Data Documentation

Filter::InputParameters te::rp::Filter::m_inputParameters

protected

Input parameters.

Definition at line 168 of file Filter.h.

bool te::rp::Filter::m_isInitialized

protected

Is this instance already initialized?

Definition at line 166 of file Filter.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/rp/Filter.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation