ConvolutionKernel.hpp

#ifndef OPALS_CONVOLUTION_KERNEL_HPP_INCLUDED
#define OPALS_CONVOLUTION_KERNEL_HPP_INCLUDED

#pragma once


//OPALS
#include "opals/config.hpp"
#include "opals/Array.hpp"
#include "opals/Path.hpp"
#include "opals/Vector.hpp"

//boost
//#include <boost/numeric/ublas/matrix.hpp>

namespace opals {

  /// Class describing different kernels for convolution filtering
  class OPALS_API ConvolutionKernel
  {
  public:
    typedef Array<unsigned,2>    ArrayU2;         ///< size array
    //typedef boost::numeric::ublas::matrix<float> KMatrix; ///< kernel matrix
    typedef Vector<float> KMatrix;                  ///< kernel matrix as vector of floats
    enum KernelType{
      average = 0,
      gaussian,
      fromFile,
      userDefined };

  public:
    
    ConvolutionKernel();
    
    virtual ~ConvolutionKernel();

    void setType( const unsigned& type ) { _type = (KernelType) type; };
    unsigned getType() const { return _type; };

    void setSize( const ArrayU2& size ) { _size = size; };
    ArrayU2 getSize() const { return _size; };

    void setKernelMatrix( const KMatrix& kmat ) { _kmatrix = kmat; };
    KMatrix getKernelMatrix() const;
    
    void setImageFilename( const Path& imgfile );
    opals::Path getImageFilename() const { return _imgfile;};

    void setParam( const Vector<float>& pars ) { _pars = pars; };
    Vector<float> getParam() const { return _pars; };

  protected: 
    KernelType _type;
    ArrayU2    _size;
    KMatrix    _kmatrix;
    Path _imgfile;
    Vector<float> _pars;
  };
}

#endif //OPALS_CONVOLUTION_KERNEL_HPP_INCLUDED