Channel.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   : ICLCore/src/ICLCore/Channel.h                          **
** Module : ICLCore                                                **
** 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/Types.h>
#include <ICLCore/CoreFunctions.h>
#include <ICLUtils/Size.h>
#include <ICLUtils/Point.h>
#include <ICLUtils/Rect.h>
#include <ICLCore/ImgIterator.h>

namespace icl{
  namespace core{



    template<class T>
    class Channel{
      mutable T *m_data;
      mutable utils::Size m_size;
      mutable utils::Rect m_roi;

      public:

      Channel():m_data(0){}

      inline Channel(const Channel &other){
        *this = other;
      }

      Channel<T> &operator=(Channel<T> &other){
        m_data = other.m_data;
        m_size = other.m_size;
        m_roi = other.m_roi;
        return *this;
      }


      const Channel<T> &operator=(const Channel<T> &other) const{
        return *const_cast<Channel*>(this) = const_cast<Channel<T>&>(other);
      }


      inline T &operator()(int x, int y){
        return m_data[x+m_size.width*y];
      }


      inline T &operator()(const utils::Point &p){
        return operator()(p.x,p.y);
      }


      inline const T &operator()(const utils::Point &p) const{
        return operator()(p.x,p.y);
      }


      inline const T &operator()(int x, int y) const{
        return m_data[x+m_size.width*y];
      }


      inline T &operator[](int idx) {
        return m_data[idx];
      }


      inline const T &operator[](int idx) const {
        return m_data[idx];
      }


      template<class Vec2D>
      inline T operator()(const Vec2D &p) const{
        float fX0 = p[0] - floor(p[0]), fX1 = 1.0 - fX0;
        float fY0 = p[1] - floor(p[1]), fY1 = 1.0 - fY0;
        const T* pLL = &operator()((int)p[0],(int)p[1]);
        float a = *pLL;        //  a b
        float b = *(++pLL);    //  c d
        pLL += getWidth();
        float d = *pLL;
        float c = *(--pLL);
        return fX1 * (fY1*a + fY0*c) + fX0 * (fY1*b + fY0*d);
      }

      typedef T* iterator;

      typedef const T* const_iterator;

      typedef ImgIterator<T> roi_iterator;

      typedef const ImgIterator<T> const_roi_iterator;

      iterator begin(){
        return m_data;
      }

      const_iterator begin() const{
        return m_data;
      }

      iterator end(){
        return m_data+getDim();
      }

      const_iterator end() const{
        return m_data+getDim();
      }

      inline roi_iterator beginROI(){
        return roi_iterator(m_data,getWidth(),getROI());
      }

      inline const_roi_iterator beginROI() const{
        return const_cast<Channel<T>*>(this)->beginROI();
      }


      inline roi_iterator endROI() {
        return roi_iterator::create_end_roi_iterator(m_data,getWidth(),getROI());
      }

      inline const_roi_iterator endROI() const{
        return const_roi_iterator::create_end_roi_iterator(m_data,getWidth(),getROI());
      }

      bool isNull() const { return !m_data; }


      inline int getWidth() const { return m_size.width; }


      inline int getHeight() const { return m_size.height; }

      inline const utils::Size& getSize() const { return m_size; }


      inline int getDim() const { return m_size.getDim(); }

      inline const utils::Rect &getROI() const { return m_roi; }

      inline utils::Point getROIOffset() const { return m_roi.ul(); }

      inline utils::Size getROISize() const { return m_roi.getSize(); }

      inline int getROIWidth() const { return m_roi.width; }

      inline int getROIHeight() const { return m_roi.height; }

      inline int getROIXOffset() const { return m_roi.x; }

      inline int getROIYOffset() const { return m_roi.y; }


      void redefineROI(const utils::Rect &newROI) const{
        m_roi = newROI;
      }

      void deepCopy(Channel<T> &other) const {
        if(m_size != other.m_size){
          throw utils::ICLException("Channel::deepCopy: sizes differ!");
        }
        icl::core::copy(m_data,m_data+m_size.getDim(), other.m_data);
      }

      template<class OtherT>
      void convert(Channel<OtherT> &other) const {
        if(m_size != other.m_size){
          throw utils::ICLException("Channel::convert: sizes differ!");
        }
        icl::core::convert(m_data,m_data+m_size.getDim(), other.m_data);
      }


      friend class Img<T>;

      private:

      inline Channel(const T *data, const utils::Size &size, const utils::Rect &roi):
      m_data(data),m_size(size),m_roi(roi){}

      inline Channel(T *data, const utils::Size &size, const utils::Rect &roi):
      m_data(data),m_size(size),m_roi(roi){}

    };

  #define ICL_INSTANTIATE_DEPTH(D) typedef Channel<icl##D> Channel##D;
    ICL_INSTANTIATE_ALL_DEPTHS
  #undef ICL_INSTANTIATE_DEPTH

  } // namespace core
}