filteringfunction_linear.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */


#ifndef AIMS_SIGNALFILTER_FILTERINGFUNCTION_LINEAR_H
#define AIMS_SIGNALFILTER_FILTERINGFUNCTION_LINEAR_H

//--- aims -------------------------------------------------------------------
#include <aims/signalfilter/filteringfunction.h>    // aims::FilteringFunction
//--- cartodata --------------------------------------------------------------
#include <cartodata/volume/volume.h>
//--- std --------------------------------------------------------------------
#include <set>
#include <string>
#include <map>
#include <vector>
//--- forward declarations ---------------------------------------------------
namespace carto {
  class Object;
  Object none();
}
namespace aims {
  class StructuringElementRef;
  namespace strel {
    StructuringElementRef none();
  }
}
//----------------------------------------------------------------------------

namespace aims {

  //==========================================================================
  // LINEAR FILTERING FUNCTON
  //==========================================================================
  template <typename T>
  class LinearFilteringFunction: public FilteringFunctionInterface<T>
  {
    public:
      virtual ~LinearFilteringFunction() {};
      //----------------------------------------------------------------------
      // interface
      //----------------------------------------------------------------------
      virtual T execute( const carto::VolumeRef<T> & in ) const = 0;
      virtual const std::vector<int> & getAmplitude() const = 0;
      virtual LinearFilteringFunction<T> *clone() const = 0;

    protected:
      //----------------------------------------------------------------------
      //   magic 3
      //----------------------------------------------------------------------
      LinearFilteringFunction() {}
      LinearFilteringFunction( const LinearFilteringFunction<T> & );
      LinearFilteringFunction<T> & operator= ( const LinearFilteringFunction<T> & );
  };

  //==========================================================================
  // LINEAR FILTERING FUNCTIONS: FACTORY
  //==========================================================================
  template <typename T>
  class LinearFilteringFunctionFactory
  {
    public:
      static LinearFilteringFunction<T> * create( const std::string & name,
                                     carto::Object options = carto::none() );
      static void registerFunction( const std::string & name,
                                    const LinearFilteringFunction<T> & func );
      static std::set<std::string> names();
    protected:
      static void init();
      static std::map<std::string,carto::rc_ptr<LinearFilteringFunction<T> > > & _map();
  };

} // namespace aims


//============================================================================
// LINEAR FILTERING FUNCTIONS: DERIVED CLASSES
//============================================================================
#define AIMS_DECLARE_LINFILTERUNC_CUSTOMIZED( NAME )                         \
  template <typename T>                                                      \
  class NAME: public LinearFilteringFunction<T>                              \
  {                                                                          \
    public:                                                                  \
      NAME( carto::Object options = carto::none() )                          \
        { setOptions( options ); }                                           \
      NAME( const NAME<T> & other );                                         \
      NAME<T> & operator=( const NAME<T> & );                                \
      virtual ~NAME();                                                       \
      virtual NAME<T> *clone() const { return new NAME<T>(*this); }          \
      virtual void setOptions( const carto::Object & options );              \
      virtual void updateOptions( const carto::Object & options );           \
      const std::vector<int> & getAmplitude() const;                         \
      virtual T execute( const carto::VolumeRef<T> & in ) const;

#define AIMS_DECLARE_LINFILTERFUNC_BASIC( NAME )                             \
  AIMS_DECLARE_LINFILTERUNC_CUSTOMIZED(NAME)                                 \
  };                                                                         \
  template <typename T>                                                      \
  NAME<T>::NAME( const NAME<T> & other ) {}                                  \
  template <typename T>                                                      \
  NAME<T>::~NAME() {}                                                        \
  template <typename T>                                                      \
  NAME<T> & NAME<T>::operator=( const NAME<T> & other ) {}


namespace aims
{
  AIMS_DECLARE_LINFILTERUNC_CUSTOMIZED(GaborFilterFunc)
    protected:
      void setKernel();
      double _sigma;
      double _theta;
      double _lambda;
      double _psi;
      double _gamma;
      bool   _real;
      int    _nstd;
      bool   _init;
      std::vector<int>          _amplitude;
      std::vector<float>        _voxelsize;
      carto::VolumeRef<double>  _kernel;
  };
} // namespace aims

#endif