E:/dev/eLynx/include/elx/math/ConvolutionKernel.h

//============================================================================
//  ConvolutionKernel.h                                 Math.Component package
//============================================================================
//  Usage : definition of convolution kernel as a simple W x H 
//          float or double matrix.
//----------------------------------------------------------------------------
//  Copyright (C) 2006 by eLynx project
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Library General Public
//  License as published by the Free Software Foundation; either
//  version 2 of the License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//  See the GNU Library General Public License for more details.
//----------------------------------------------------------------------------
#ifndef __ConvolutionKernel_h__
#define __ConvolutionKernel_h__

#include <elx/core/CoreTypes.h>
#include <boost/shared_array.hpp>

namespace eLynx {
namespace Math {

enum ECompassDirection
{
  CD_North = 0,
  CD_NorthEast,
  CD_East,
  CD_SouthEast,
  CD_South,
  CD_SouthWest,
  CD_West,
  CD_NorthWest
};

template<typename T>
struct ConvolutionKernel
{
  ConvolutionKernel();

  ConvolutionKernel(uint32 iWidth, uint32 iHeight, T iV = T(1));
        
  ConvolutionKernel(uint32 iWidth, uint32 iHeight, const T * iprArray);
        
  ConvolutionKernel(const ConvolutionKernel& iOther);

  template<typename U>
  ConvolutionKernel(const ConvolutionKernel<U>& iOther);

  ConvolutionKernel& operator=(const ConvolutionKernel& iOther);

  template<typename U>
  ConvolutionKernel& operator=(const ConvolutionKernel<U>& iOther);

  uint32 GetSize() const;

  uint32 GetWidth() const;

  uint32 GetHeight() const;
  
  T GetSum() const;

  void Normalize();

  ConvolutionKernel Rotated(const ECompassDirection iDirection) const;

  bool IsValid() const;
  
  bool IsHorizontal() const;

  bool IsVertical() const;

  bool IsSquare() const;

  bool Is3x3() const;

  bool Is5x5() const;

private:
  uint32 _width, _height;
public:
  boost::shared_array<T> _spK; 
};

typedef ConvolutionKernel<int32>  ConvolutionKerneli;

typedef ConvolutionKernel<float>  ConvolutionKernelf;

typedef ConvolutionKernel<double> ConvolutionKerneld;


} // namespace Math
} // namespace eLynx

#include "inl/ConvolutionKernel.inl"

#endif // __ConvolutionKernel_h__