OpROIHandler.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/OpROIHandler.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 <ICLCore/ImgBase.h>

namespace icl {
  namespace filter{

    class ICLFilter_API OpROIHandler {
      public:
      virtual ~OpROIHandler(){}


      private:
        friend class UnaryOp;
        friend class BinaryOp;
      void setClipToROI (bool bClipToROI) {this->m_bClipToROI = bClipToROI;}
      void setCheckOnly (bool bCheckOnly) {this->m_bCheckOnly = bCheckOnly;}

      bool getClipToROI() const { return m_bClipToROI; }
      bool getCheckOnly() const { return m_bCheckOnly; }

      OpROIHandler() : m_bClipToROI (true), m_bCheckOnly (false) {}

      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);

      virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc) {
        // ensure that the checkOnly flag is set to TRUE, if source and destination images are the same pointers,
        // this can not lead to problems, because *ppoDst is reallocated only if its depth differs from
        // the source images depth (which is not true if poSrc==*ppoDst
        //ICLASSERT_RETURN_VAL( !(ppoDst && (*ppoDst==poSrc) && !getCheckOnly() ), false);
        return prepare (ppoDst, poSrc->getDepth(), chooseSize (poSrc),
                        poSrc->getFormat(), poSrc->getChannels (), chooseROI (poSrc),
                        poSrc->getTime());
      }

      virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc, core::depth eDepth) {
        // ensure that the checkOnly flag is set to TRUE, if source and destination images are the same pointers,
        // this can not lead to problems, because *ppoDst is reallocated only if its depth differs from
        // the source images depth (which is not true if poSrc==*ppoDst
        // ICLASSERT_RETURN_VAL( !(ppoDst && (*ppoDst==poSrc) && !getCheckOnly() ), false);
        return prepare (ppoDst, eDepth, chooseSize (poSrc),
                        poSrc->getFormat(), poSrc->getChannels (), chooseROI (poSrc),
                        poSrc->getTime());
      }
      const utils::Size chooseSize (const core::ImgBase *poSrc) {
        return m_bClipToROI ? poSrc->getROISize () : poSrc->getSize ();
      }
      const utils::Rect chooseROI (const core::ImgBase *poSrc) {
        return m_bClipToROI ? utils::Rect (utils::Point::null, poSrc->getROISize ())
          : poSrc->getROI();
      }

      bool m_bClipToROI, m_bCheckOnly;
    };
  } // namespace filter
}