aims::LinearFilteringFunction< T > Class Template Reference

Base class for linear filtering functions. More...

#include <aims/signalfilter/filteringfunction_linear.h>

Inheritance diagram for aims::LinearFilteringFunction< T >:

Collaboration diagram for aims::LinearFilteringFunction< T >:

Public Member Functions
virtual	~LinearFilteringFunction ()
virtual T	execute (const carto::VolumeRef< T > &in) const =0
virtual const std::vector< int > &	getAmplitude () const =0
	Return a vector fo size 6 describing the border needed in each direction (x-, x+, y-, y+, z-, z+). More...
virtual LinearFilteringFunction< T > *	clone () const =0
	clone More...
Public Member Functions inherited from aims::FilteringFunctionInterface< T >
virtual	~FilteringFunctionInterface ()
virtual void	setOptions (const carto::Object &)
	Set the parameters of the filters If a parameter value is not set in the options object, a default value must be assigned. More...
virtual void	updateOptions (const carto::Object &)
	Update the parameters of the filters If a parameter value is not set in the options object, the current value must be kept. More...

Protected Member Functions
	LinearFilteringFunction ()
	LinearFilteringFunction (const LinearFilteringFunction< T > &)
LinearFilteringFunction< T > &	operator= (const LinearFilteringFunction< T > &)
Protected Member Functions inherited from aims::FilteringFunctionInterface< T >
	FilteringFunctionInterface ()
	FilteringFunctionInterface (const FilteringFunctionInterface< T > &)
FilteringFunctionInterface< T > &	operator= (const FilteringFunctionInterface< T > &)

Detailed Description

template<typename T>
class aims::LinearFilteringFunction< T >

Base class for linear filtering functions.

They are executed on a window (unallocated carto::Volume with an allocated parent volume) of size 1 voxel with enough border so that the linear kernel may be applied.

Definition at line 70 of file filteringfunction_linear.h.

Constructor & Destructor Documentation

~LinearFilteringFunction()

template<typename T >

virtual aims::LinearFilteringFunction< T >::~LinearFilteringFunction ( )

inlinevirtual

Definition at line 73 of file filteringfunction_linear.h.

LinearFilteringFunction() [1/2]

template<typename T >

aims::LinearFilteringFunction< T >::LinearFilteringFunction ( )

inlineprotected

Definition at line 91 of file filteringfunction_linear.h.

LinearFilteringFunction() [2/2]

template<typename T >

aims::LinearFilteringFunction< T >::LinearFilteringFunction ( const LinearFilteringFunction< T > &  )

protected

Member Function Documentation

clone()

template<typename T >

virtual LinearFilteringFunction<T>* aims::LinearFilteringFunction< T >::clone ( ) const

pure virtual

clone

Implements aims::FilteringFunctionInterface< T >.

Referenced by aims::LinearFilteringFunctionFactory< T >::create(), and aims::LinearFilteringFunctionFactory< T >::registerFunction().

execute()

template<typename T >

virtual T aims::LinearFilteringFunction< T >::execute ( const carto::VolumeRef< T > &  in ) const

pure virtual

Parameters

in	window volume with the same size as the kernel. Use getAmplitude to know the needed dimensions

Implements aims::FilteringFunctionInterface< T >.

Referenced by aims::multichannelfiltervalues_lin().

getAmplitude()

template<typename T >

virtual const std::vector<int>& aims::LinearFilteringFunction< T >::getAmplitude ( ) const

pure virtual

Return a vector fo size 6 describing the border needed in each direction (x-, x+, y-, y+, z-, z+).

The kernel size is then of dimension: ( v[0] + v[1] + 1, v[2] + v[3] + 1, v[4] + v[5] + 1 )

operator=()

template<typename T >

LinearFilteringFunction<T>& aims::LinearFilteringFunction< T >::operator= ( const LinearFilteringFunction< T > &  )

protected

---

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

• aims/signalfilter/filteringfunction_linear.h