mds::img::CAvg5Filter< I > Class Template Reference

Averaging image filter (5x5 version). More...

#include <mdsAveraging.h>

Inheritance diagram for mds::img::CAvg5Filter< I >:

List of all members.

Public Types
enum	{ TEMPLATE_PARAMETER_IS_NOT_IMAGE = I::CLASS_IMAGE }
	Check that I is an image. More...
typedef CImageFilter< I >	base
	Image filter base.
typedef base::tImage	tImage
	Image type.
typedef base::tPixel	tPixel
	Image pixel type.
Public Member Functions
	CAvg5Filter ()
	Default constructor.
tPixel	getResponse (const tImage &SrcImage, tSize x, tSize y)
	Returns filter response at specified image point.
tSize	getSize () const
	Returns filter standard deviation.
bool	operator() (const tImage &SrcImage, tImage &DstImage)
	Filtering of input/source image.
	~CAvg5Filter ()
	Destructor.
Static Public Attributes
static const int	DENOM = 81
	Number used to divide filter response.
static const CKernel2D::tData	KERNEL []
	Filter kernel.

---

Detailed Description

template<class I>
class mds::img::CAvg5Filter< I >

Averaging image filter (5x5 version).

• Parameter I is a used image type.
• Policy N is used for filter response normalization.
• Kernel definition:
  [ 1 2 3 2 1 ]
  1 [ 2 4 6 4 2 ]
  -- [ 3 6 9 6 3 ]
  81 [ 2 4 6 4 2 ]
  [ 1 2 3 2 1 ]
  

---

Member Typedef Documentation

template<class I >

typedef CImageFilter<I> mds::img::CAvg5Filter< I >::base

Image filter base.

template<class I >

typedef base::tImage mds::img::CAvg5Filter< I >::tImage

Image type.

Reimplemented from mds::img::CImageFilter< I >.

template<class I >

typedef base::tPixel mds::img::CAvg5Filter< I >::tPixel

Image pixel type.

Reimplemented from mds::img::CImageFilter< I >.

---

Member Enumeration Documentation

template<class I>

anonymous enum [inherited]

Check that I is an image.

You will see name of this enum somewhere in compiler error message if the type I is not image.

Enumerator:

TEMPLATE_PARAMETER_IS_NOT_IMAGE

---

Constructor & Destructor Documentation

template<class I >

mds::img::CAvg5Filter< I >::CAvg5Filter

(

)

Default constructor.

template<class I >

mds::img::CAvg5Filter< I >::~CAvg5Filter

(

)

Destructor.

---

Member Function Documentation

template<class I >

CAvg5Filter< I >::tPixel CAvg5Filter::getResponse	(	const tImage &	SrcImage,
		tSize	x,
		tSize	y
	)

Returns filter response at specified image point.

• Value is not normalized!

template<class I >

tSize mds::img::CAvg5Filter< I >::getSize

(

)

const

Returns filter standard deviation.

template<class I >

bool CAvg5Filter::operator()	(	const tImage &	SrcImage,
		tImage &	DstImage
	)		[virtual]

Filtering of input/source image.

• Returns false on failure.

Implements mds::img::CImageFilter< I >.

---

Member Data Documentation

template<class I >

const int mds::img::CAvg5Filter< I >::DENOM = 81 [static]

Number used to divide filter response.

template<class I >

const CKernel2D::tData CAvg5Filter::KERNEL [static]

Initial value:

{
    1.0f,  2.0f,  3.0f,  2.0f,  1.0f,
    2.0f,  4.0f,  6.0f,  4.0f,  2.0f,
    3.0f,  6.0f,  9.0f,  6.0f,  3.0f,
    2.0f,  4.0f,  6.0f,  4.0f,  2.0f,
    1.0f,  2.0f,  3.0f,  2.0f,  1.0f
}

Filter kernel.

---

The documentation for this class was generated from the following files:

• Filters/mdsAveraging.h
• Filters/mdsAveraging.hxx