DataSegmentBase.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   : ICLGeom/src/ICLCore/DataSegmentBase.h                  **
** Module : ICLGeom                                                **
** Authors: Christof Elbrechter, Patrick Nobou                     **
**                                                                 **
**                                                                 **
** 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/BasicTypes.h>
#include <ICLUtils/Exception.h>
#include <algorithm>

namespace icl{
  //forward declare PointCloudObjectBase to friend later
  namespace geom {
  class PointCloudObjectBase;
  }
  namespace core{
    
    template<class T,int N> struct DataSegment;


    struct ICLGeom_API DataSegmentBase{
      friend class geom::PointCloudObjectBase;

    protected:
      static inline int getSizeOf(core::depth d){
        static const int lens[] = { 1, 2, 4, 4, 8 };
        return lens[(int)d];
      }
  
      icl8u *data;
      

      size_t stride;   
      
      size_t numElements;
      
      icl32s organizedWidth; // -1 if unorganized 
  
      core::depth dataDepth;
      
      size_t elemDim;     // number of elements (in Type units)
  
    public:
      inline bool isOrganized() const {
        return organizedWidth > 0;
      }
      
      inline utils::Size getSize() const {
        if(!isOrganized()) return utils::Size::null;
        else return utils::Size(organizedWidth, numElements/organizedWidth);
      }
      
      inline int getStride() const { 
        return stride;
      }
      

      inline int getDim() const{
        return numElements;
      }    
      
      inline core::depth getDepth() const{
        return dataDepth;
      }
      
      inline int getElemDim() const{
        return elemDim;
      }
      

      icl8u *getDataPointer() { return data; }


      const icl8u *getDataPointer() const { return data; }
  
      inline DataSegmentBase(void *data=0, size_t stride=0, 
                             size_t numElements=0, icl32s organizedWidth=-1, 
                             core::depth dataDepth=core::depth8u, size_t elemDim=0):
        data((icl8u*)data),stride(stride),numElements(numElements),
        organizedWidth(organizedWidth),dataDepth(dataDepth),elemDim(elemDim){}
      

      template<class T, int N>
      const DataSegment<T,N> &as() const;
      
      class ICLGeom_API Bytes{
        icl8u *data; 
        int len;     

        Bytes(icl8u *data=0, int len=0):data(data),len(len){}
        Bytes(const Bytes &other){} 
        friend struct DataSegmentBase; 
        public:
        
        inline int getDim() const{ return len; }
        
        icl8u &operator[](int idx) { return data[idx]; }
  
        const icl8u operator[](int idx) const { return data[idx]; }
        

        inline Bytes &operator=(const Bytes &other) throw (utils::ICLException){
          if(len != other.len){
            throw utils::ICLException("unable to assign DataSegmentBase::Bytes: lengths differ!");
          }
          std::copy(other.data,other.data+len,data);
          return *this;
        }
        
        icl8u *begin() { return data; }
  
        icl8u *end() { return data+len; }
  
        const icl8u *begin() const { return data; }
  
        const icl8u *end() const { return data+len; }
  
      };
      
      inline Bytes operator[](int idx) {
        return Bytes(data+idx*stride*getSizeOf(dataDepth), elemDim*getSizeOf(dataDepth));
      }
  
      inline const Bytes operator[](int idx) const{
        return const_cast<DataSegmentBase*>(this)->operator[](idx); 
      }
  
      inline Bytes operator()(int x, int y) {
       return operator[](x + organizedWidth * y );
      }
      
      inline const Bytes operator()(int x, int y) const{
        return operator[](x + organizedWidth * y );
      }
    };
  
  } // namespace core
}