filteringfunction_element.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_ELEMENT_H
#define AIMS_SIGNALFILTER_FILTERINGFUNCTION_ELEMENT_H
 
//--- aims -------------------------------------------------------------------
#include <aims/signalfilter/filteringfunction.h>    // aims::FilteringFunction
//--- std --------------------------------------------------------------------
#include <set>
#include <string>
#include <map>
//--- forward declarations ---------------------------------------------------
namespace carto {
  template <typename T> class VolumeRef;
  template <typename T> class rc_ptr;
  class Object;
  Object none();
}
namespace aims {
  class StructuringElement;
}
//----------------------------------------------------------------------------
 
namespace aims {
 
  //==========================================================================
  // ELEMENT FILTERING FUNCTON
  //==========================================================================
  template <typename T>
  class ElementFilteringFunction: public FilteringFunctionInterface<T>
  {
    public:
      virtual ~ElementFilteringFunction() {};
      //----------------------------------------------------------------------
      // interface
      //----------------------------------------------------------------------
      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;
 
    protected:
      //----------------------------------------------------------------------
      //   magic 3
      //----------------------------------------------------------------------
      ElementFilteringFunction() {}
      ElementFilteringFunction( const ElementFilteringFunction<T> & );
      ElementFilteringFunction<T> & operator= ( const ElementFilteringFunction<T> & );
  };
 
  //==========================================================================
  // ELEMENT FILTERING FUNCTIONS: FACTORY
  //==========================================================================
  template <typename T>
  class ElementFilteringFunctionFactory
  {
    public:
      static ElementFilteringFunction<T> * create( const std::string & name,
                                                   carto::Object options = carto::none() );
      static void registerFunction( const std::string & name,
                                    const ElementFilteringFunction<T> & func );
      static std::set<std::string> names();
    protected:
      static void init();
      static std::map<std::string,carto::rc_ptr<ElementFilteringFunction<T> > > & _map();
  };
 
} // namespace aims
 
 
//============================================================================
// ELEMENT FILTERING FUNCTIONS: DERIVED CLASSES
//============================================================================
 
#define AIMS_DECLARE_ELEMENTFILTERFUNC_CUSTOMIZED( NAME )                    \
  template <typename T>                                                      \
  class NAME: public ElementFilteringFunction<T>                             \
  {                                                                          \
    public:                                                                  \
      NAME( carto::Object options = carto::none() )                          \
        { setOptions( options ); }                                           \
      NAME( const NAME<T> & other );                                         \
      virtual ~NAME();                                                       \
      NAME<T> & operator=( const NAME<T> & other );                          \
      virtual NAME<T> *clone() const { return new NAME<T>(*this); }          \
      virtual void setOptions( const carto::Object & options );              \
      virtual T execute( const carto::VolumeRef<T> & in ) const;             \
      virtual T execute( const carto::VolumeRef<T> & in,                     \
                         const carto::rc_ptr<StructuringElement> & se ) const;
 
#define AIMS_DEFINE_ELEMENTFILTERFUNC_BASIC( NAME )                          \
  template <typename T>                                                      \
  NAME<T>::NAME( const NAME<T> & /*other*/ ) : ElementFilteringFunction<T>() {} \
  template <typename T>                                                      \
  NAME<T>::~NAME() {}                                                        \
  template <typename T>                                                      \
  NAME<T> & NAME<T>::operator=( const NAME<T> & /*other*/ ) { return *this; } \
  template <typename T>                                                      \
  void NAME<T>::setOptions( const carto::Object & /*options*/ ) {}
 
#define AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC( NAME )                         \
  AIMS_DECLARE_ELEMENTFILTERFUNC_CUSTOMIZED(NAME)                            \
  };                                                                         \
  AIMS_DEFINE_ELEMENTFILTERFUNC_BASIC(NAME)
 
 
namespace aims {
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(MinFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(MaxFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(MajorityFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(ExtremaDifferenceFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(SumFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(VarFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(StDevFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(MedianFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(MeanFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(NotNullMeanFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(NotNullMedianFilterFunc)
  AIMS_DECLARE_ELEMENTFILTERFUNC_BASIC(NotNullMajorityFilterFunc)
} // namespace aims
 
#endif