aims::FilteringFunctionInterface< T > Class Template Reference

Pure virtual class: interface for filtering functions called by aims::FilteringImageAlgorithm and aims::SubSamplingImageAlgorithm. More...

#include <aims/signalfilter/filteringfunction.h>

Inheritance diagram for aims::FilteringFunctionInterface< T >:

Public Member Functions
virtual	~FilteringFunctionInterface ()
virtual T	execute (const carto::VolumeRef< T > &in) const =0
	Basic execute method that all derived class must implement (in the case where more parameters are needed, this methods runs with their default value) More...
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...
virtual FilteringFunctionInterface *	clone () const =0
	clone method. It is better to implement it using a copy constructor. More...

Protected Member Functions
	FilteringFunctionInterface ()
	FilteringFunctionInterface (const FilteringFunctionInterface< T > &)
FilteringFunctionInterface< T > &	operator= (const FilteringFunctionInterface< T > &)

Detailed Description

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

Pure virtual class: interface for filtering functions called by aims::FilteringImageAlgorithm and aims::SubSamplingImageAlgorithm.

Definition at line 56 of file filteringfunction.h.

Constructor & Destructor Documentation

~FilteringFunctionInterface()

template<typename T >

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

inlinevirtual

Definition at line 59 of file filteringfunction.h.

FilteringFunctionInterface() [1/2]

template<typename T >

aims::FilteringFunctionInterface< T >::FilteringFunctionInterface ( )

inlineprotected

Definition at line 84 of file filteringfunction.h.

FilteringFunctionInterface() [2/2]

template<typename T >

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

protected

Member Function Documentation

clone()

template<typename T >

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

pure virtual

clone method. It is better to implement it using a copy constructor.

Implemented in aims::LinearFilteringFunction< T >, and aims::ElementFilteringFunction< T >.

execute()

template<typename T >

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

pure virtual

Basic execute method that all derived class must implement (in the case where more parameters are needed, this methods runs with their default value)

Implemented in aims::LinearFilteringFunction< T >, and aims::ElementFilteringFunction< T >.

operator=()

template<typename T >

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

protected

setOptions()

template<typename T >

virtual void aims::FilteringFunctionInterface< T >::setOptions ( const carto::Object &  )

inlinevirtual

Set the parameters of the filters If a parameter value is not set in the options object, a default value must be assigned.

This method may do nothing if no options are available.

Definition at line 71 of file filteringfunction.h.

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

updateOptions()

template<typename T >

virtual void aims::FilteringFunctionInterface< T >::updateOptions ( const carto::Object &  )

inlinevirtual

Update the parameters of the filters If a parameter value is not set in the options object, the current value must be kept.

This method may do nothing if no options are available.

Definition at line 76 of file filteringfunction.h.

---

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

• aims/signalfilter/filteringfunction.h