aimsalgo  5.1.2
Neuroimaging image processing
aims::ElementFilteringFunction< T > Class Template Referenceabstract

Base class for filtering functions applied in a structuring element. More...

#include <aims/signalfilter/filteringfunction_element.h>

Inheritance diagram for aims::ElementFilteringFunction< T >:
Collaboration diagram for aims::ElementFilteringFunction< T >:

Public Member Functions

virtual ~ElementFilteringFunction ()
 
virtual T execute (const carto::VolumeRef< T > &in, const carto::rc_ptr< StructuringElement > &se) const =0
 
virtual T execute (const carto::VolumeRef< T > &in) const =0
 
virtual ElementFilteringFunction< 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

 ElementFilteringFunction ()
 
 ElementFilteringFunction (const ElementFilteringFunction< T > &)
 
ElementFilteringFunction< T > & operator= (const ElementFilteringFunction< 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::ElementFilteringFunction< T >

Base class for filtering functions applied in a structuring element.

See also
MedianFilterFunc, MeanFilterFunc

Definition at line 65 of file filteringfunction_element.h.

Constructor & Destructor Documentation

◆ ~ElementFilteringFunction()

template<typename T >
virtual aims::ElementFilteringFunction< T >::~ElementFilteringFunction ( )
inlinevirtual

Definition at line 68 of file filteringfunction_element.h.

◆ ElementFilteringFunction() [1/2]

template<typename T >
aims::ElementFilteringFunction< T >::ElementFilteringFunction ( )
inlineprotected

Definition at line 86 of file filteringfunction_element.h.

◆ ElementFilteringFunction() [2/2]

template<typename T >
aims::ElementFilteringFunction< T >::ElementFilteringFunction ( const ElementFilteringFunction< T > &  )
protected

Member Function Documentation

◆ clone()

◆ execute() [1/2]

template<typename T >
virtual T aims::ElementFilteringFunction< T >::execute ( const carto::VolumeRef< T > &  in) const
pure virtual
Parameters
inwindow volume of any given size. It is used as a cubic structuring element.

Implements aims::FilteringFunctionInterface< T >.

◆ execute() [2/2]

template<typename T >
virtual T aims::ElementFilteringFunction< T >::execute ( const carto::VolumeRef< T > &  in,
const carto::rc_ptr< StructuringElement > &  se 
) const
pure virtual
Parameters
inwindow volume of size 1 voxel with enough border so that the structuring element can be used.

Referenced by aims::multichannelfiltervalues_nonlin().

◆ operator=()

template<typename T >
ElementFilteringFunction<T>& aims::ElementFilteringFunction< T >::operator= ( const ElementFilteringFunction< T > &  )
protected

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