ConvolutionKernel.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/ConvolutionKernel.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/Size.h>
#include <ICLUtils/Exception.h>


namespace icl{
  namespace filter{

    struct ICLFilter_API ConvolutionKernel{
  

      enum fixedType { 
        gauss3x3=0,   
        gauss5x5=10,  
        sobelX3x3=1,  
        sobelX5x5=11, 
        sobelY3x3=2,  
        sobelY5x5=12, 
        laplace3x3=3, 
        laplace5x5=13,
        custom,
      };
      
      ConvolutionKernel();
      

      ConvolutionKernel(const ConvolutionKernel &other);  
      

      ConvolutionKernel(int *data, const utils::Size &size,int factor=1, bool deepCopy=true) throw (utils::InvalidSizeException);
      
      ConvolutionKernel(float *data, const utils::Size &size, bool deepCopy=true) throw (utils::InvalidSizeException);
      
      ConvolutionKernel(fixedType t, bool useFloats=false);
      
      ~ConvolutionKernel();
      

      ConvolutionKernel &operator=(const ConvolutionKernel &other);
  
      void toFloat();
      

      void toInt(bool force=false);
      
      inline int getDim() const { return size.getDim(); }
      
      inline const utils::Size &getSize() const { return size; }
      
      inline int getWidth() const { return size.width; }
      
      inline int getHeight() const { return size.height; }
      
      inline bool isFloat() const { return !!fdata; }
      
      inline const float *getFloatData() const { return fdata; }
  
      inline float *getFloatData() { return fdata; }
  
      inline const int *getIntData() const { return idata; }
  
      inline int *getIntData() { return idata; }
      
      inline int getFactor() const { return factor; }
      
      inline bool isNull() const { return isnull; }
      
      inline fixedType getFixedType() const { return ft; }
      
      void detach();
      
    private:
      utils::Size size;    
      float *fdata; 
      int *idata;   
      int factor;   
      bool isnull;  
      bool owned;   
      fixedType ft; 
    };
  } // namespace filter
}