mds::img::CVolumeAvg3Filter< V > Class Template Reference

Averaging image filter (3x3 version). More...

#include <mdsAveraging.h>

Inheritance diagram for mds::img::CVolumeAvg3Filter< V >:

List of all members.

Public Types
enum	{ TEMPLATE_PARAMETER_IS_NOT_VOLUME = V::CLASS_VOLUME }
	Check that type V is a volume. More...
typedef CVolumeFilter< V >	base
	Volume filter base.
typedef base::tVolume	tVolume
	Volume type.
typedef base::tVoxel	tVoxel
	Volume voxel type.
Public Member Functions
	CVolumeAvg3Filter ()
	Default constructor.
tVoxel	getResponse (const tVolume &SrcVolume, tSize x, tSize y, tSize z)
	Returns filter response at specified volume position.
tSize	getSize () const
	Returns filter standard deviation.
bool	operator() (const tVolume &SrcVolume, tVolume &DstVolume)
	Filtering of input/source volume.
	~CVolumeAvg3Filter ()
	Destructor.
Static Public Attributes
static const int	DENOM = 36
	Number used to divide filter response.
static const CKernel3D::tData	KERNEL []
	Filter kernel.

---

Detailed Description

template<class V>
class mds::img::CVolumeAvg3Filter< V >

Averaging image filter (3x3 version).

• Parameter V is a used image type.
• Kernel definition:
  [ 1 1 1 ]
  [ 1 2 1 ]
  [ 1 1 1 ]
  1 [ 1 2 1 ]
  -- [ 2 4 2 ]
  36 [ 1 2 1 ]
  [ 1 1 1 ]
  [ 1 2 1 ]
  [ 1 1 1 ]
  

---

Member Typedef Documentation

template<class V >

typedef CVolumeFilter<V> mds::img::CVolumeAvg3Filter< V >::base

Volume filter base.

template<class V >

typedef base::tVolume mds::img::CVolumeAvg3Filter< V >::tVolume

Volume type.

Reimplemented from mds::img::CVolumeFilter< V >.

template<class V >

typedef base::tVoxel mds::img::CVolumeAvg3Filter< V >::tVoxel

Volume voxel type.

Reimplemented from mds::img::CVolumeFilter< V >.

---

Member Enumeration Documentation

template<class V>

anonymous enum [inherited]

Check that type V is a volume.

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

Enumerator:

TEMPLATE_PARAMETER_IS_NOT_VOLUME

---

Constructor & Destructor Documentation

template<class V >

mds::img::CVolumeAvg3Filter< V >::CVolumeAvg3Filter

(

)

Default constructor.

template<class V >

mds::img::CVolumeAvg3Filter< V >::~CVolumeAvg3Filter

(

)

Destructor.

---

Member Function Documentation

template<class V >

CVolumeAvg3Filter< V >::tVoxel CVolumeAvg3Filter::getResponse	(	const tVolume &	SrcVolume,
		tSize	x,
		tSize	y,
		tSize	z
	)

Returns filter response at specified volume position.

• Value is not normalized!

template<class V >

tSize mds::img::CVolumeAvg3Filter< V >::getSize

(

)

const

Returns filter standard deviation.

template<class V >

bool CVolumeAvg3Filter::operator()	(	const tVolume &	SrcVolume,
		tVolume &	DstVolume
	)		[virtual]

Filtering of input/source volume.

Point filter responses are written to the destination volume.

• Returns false on failure

Implements mds::img::CVolumeFilter< V >.

---

Member Data Documentation

template<class V >

const int mds::img::CVolumeAvg3Filter< V >::DENOM = 36 [static]

Number used to divide filter response.

template<class V >

const CKernel3D::tData CVolumeAvg3Filter::KERNEL [static]

Initial value:

{
    1.0f,  1.0f,  1.0f,
    1.0f,  2.0f,  1.0f,
    1.0f,  1.0f,  1.0f,

    1.0f,  2.0f,  1.0f,
    2.0f,  4.0f,  2.0f,
    1.0f,  2.0f,  1.0f,

    1.0f,  1.0f,  1.0f,
    1.0f,  2.0f,  1.0f,
    1.0f,  1.0f,  1.0f
}

Filter kernel.

Volume filter kernel.

---

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

• VolumeFilters/mdsAveraging.h
• VolumeFilters/mdsAveraging.hxx