A.I.M.S algorithms


filteringfunction.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 #ifndef AIMS_SIGNALFILTER_FILTERFUNCTION_H
35 #define AIMS_SIGNALFILTER_FILTERFUNCTION_H
36 
37 //--- cartobase --------------------------------------------------------------
38 #include <cartobase/object/object.h> // carto::Object
39 //--- std --------------------------------------------------------------------
40 #include <vector>
41 //--- forward declarations ---------------------------------------------------
42 namespace carto {
43  template <typename T> class VolumeRef;
44 }
45 template <typename T> class AimsData;
46 //----------------------------------------------------------------------------
47 
48 namespace aims {
49 
50  //==========================================================================
51  // FILTERING FUNCTON INTERFACE
52  //==========================================================================
56  template <typename T>
58  {
59  public:
61  //----------------------------------------------------------------------
62  // interface
63  //----------------------------------------------------------------------
67  virtual T execute( const carto::VolumeRef<T> & in ) const = 0;
72  virtual void setOptions( const carto::Object & options ) {}
77  virtual void updateOptions( const carto::Object & options ) {}
79  virtual FilteringFunctionInterface *clone() const = 0;
80 
81  //----------------------------------------------------------------------
82  // backward compability
83  //----------------------------------------------------------------------
85  T doit( const AimsData<T> & in ) __attribute__((__deprecated__))
86  {
87  return execute( in.volume() );
88  }
89 
90  protected:
91  //----------------------------------------------------------------------
92  // magic 3
93  //----------------------------------------------------------------------
97  };
98 
99 } // namespace aims
100 
101 #endif
virtual FilteringFunctionInterface * clone() const =0
clone method. It is better to implement it using a copy constructor.
virtual void setOptions(const carto::Object &options)
Set the parameters of the filters If a parameter value is not set in the options object, a default value must be assigned.
T doit(const AimsData< T > &in) __attribute__((__deprecated__))
virtual void updateOptions(const carto::Object &options)
Update the parameters of the filters If a parameter value is not set in the options object...
Pure virtual class: interface for filtering functions called by aims::FilteringImageAlgorithm and aim...
FilteringFunctionInterface< T > & operator=(const FilteringFunctionInterface< T > &)
#define __attribute__(a)
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 nee...