UnaryOp.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLFilter/src/ICLFilter/UnaryOp.h                      **
** Module : ICLFilter                                              **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Configurable.h>
#include <ICLFilter/OpROIHandler.h>

namespace icl{
  namespace utils{
    class MultiThreader;
  }
  namespace filter{
    
    

    class ICLFilter_API UnaryOp : public utils::Configurable{
      void initConfigurable();
      
      public:
  
      UnaryOp();
  
      UnaryOp(const UnaryOp &other);
  
      UnaryOp &operator=(const UnaryOp &other);
  
      
      virtual ~UnaryOp();
        
      virtual void apply(const core::ImgBase *operand1, core::ImgBase **dst)=0;
  
      virtual ICL_DEPRECATED void applyMT(const core::ImgBase *operand1, 
                                          core::ImgBase **dst, unsigned int nThreads);
  

      virtual const core::ImgBase *apply(const core::ImgBase *src);
      
      inline void operator()(const core::ImgBase *src, core::ImgBase **dst){
        apply(src,dst);
      }

      inline const core::ImgBase *operator()(const core::ImgBase *src){
        return apply(src);
      }

      inline const core::ImgBase &operator()(const core::ImgBase &src){
        return *apply(&src);
      }

      

      void setClipToROI (bool bClipToROI) { 
        m_oROIHandler.setClipToROI(bClipToROI); 
        prop("UnaryOp.clip to ROI").value = bClipToROI ? "on" : "off";
        call_callbacks("UnaryOp.clip to ROI",this);
      }
      

      void setCheckOnly (bool bCheckOnly) { 
        m_oROIHandler.setCheckOnly(bCheckOnly); 
        prop("UnaryOp.check only").value = bCheckOnly ? "on" : "off";
        call_callbacks("UnaryOp.check only",this);
      }
      

      bool getClipToROI() const { return m_oROIHandler.getClipToROI(); }
      

      bool getCheckOnly() const { return m_oROIHandler.getCheckOnly(); }
      
      
      virtual void setPropertyValue(const std::string &propertyName, const utils::Any &value) throw (utils::ICLException);
  

      static UnaryOp *fromString(const std::string &definition) throw (utils::ICLException);
  

      static std::string getFromStringSyntax(const std::string &opSpecifier) throw (utils::ICLException);
  
      static std::vector<std::string> listFromStringOps();
  
      static void applyFromString(const std::string &definition, 
                                  const core::ImgBase *src, 
                                  core::ImgBase **dst) throw (utils::ICLException);
      
      protected:
      bool prepare (core::ImgBase **ppoDst, core::depth eDepth, const utils::Size &imgSize, 
                    core::format eFormat, int nChannels, const utils::Rect& roi, 
                    utils::Time timestamp=utils::Time::null){
        return m_oROIHandler.prepare(ppoDst, eDepth,imgSize,eFormat, nChannels, roi, timestamp);
      }
      
      virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc) {
        return m_oROIHandler.prepare(ppoDst, poSrc);
      }
      
      virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc, core::depth eDepth) {
        return m_oROIHandler.prepare(ppoDst, poSrc, eDepth);
      }
  
      utils::MultiThreader *m_poMT;
      
      private:
    
      OpROIHandler m_oROIHandler;
      
      core::ImgBase *m_buf;
    };    
  
  
  #define DYNAMIC_UNARY_OP_CREATION_FUNCTION(NAME)       \
    extern "C" {                                         \
      UnaryOp *create_##NAME(const std::string &s){      \
        return NAME(s);                                  \
      }                                                  \
    }
    
  } // namespace filter
}