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

Template providing median volume filtering functions. More...

#include <mdsMedian.h>

Inheritance diagram for mds::img::CVolumeMedianFilter< 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 mds::base::CFunctor < bool, int, int >	tProgressFunc
	Progress observer (= functor).
typedef CProgressInitializer	tProgressInitializer
	Helper class which can be used to call methods beginProgress() and endProgress() automatically.
typedef base::tVolume	tVolume
	Volume type.
typedef base::tVoxel	tVoxel
	Volume voxel type.
Public Member Functions
void	beginProgress ()
	This function must be called by the class realizing an operation before it starts.
	CVolumeMedianFilter (tSize Size)
	Constructor that creates a new median filter.
void	deregisterProgressFunc ()
	Sets the default empty observer.
void	endProgress ()
	The function must be called by the class realizing an operation every time the operation finishes.
int	getProgressCount () const
	Returns current value of the internal progress value.
int	getProgressMax () const
	Returns the maximum allowed value of the internal progress counter.
tVoxel	getResponse (const tVolume &SrcVolume, tSize x, tSize y, tSize z)
	Returns filter response at specified volume position.
bool	operator() (const tVolume &SrcVolume, tVolume &DstVolume)
	Median volume filtering.
bool	progress (int iIncrement=1)
	Calls the registered observer.
void	registerProgressFunc (const tProgressFunc &Func)
	Sets observer/functor called to inform a calling process about the current state of the running operation.
void	setProgressMax (int iValue)
	Sets the maximal counter value.
void	setSize (tSize Size)
	Sets the windows size.
	~CVolumeMedianFilter ()
	Destructor.
Protected Attributes
mds::base::CData< tVoxel >	m_Data
	Internal data buffer.
tSize	m_MedianSize
	Median filter size.

---

Detailed Description

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

Template providing median volume filtering functions.

• Parameter V is a used volume type.

---

Member Typedef Documentation

template<class V >

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

Volume filter base.

typedef mds::base::CFunctor<bool, int, int> mds::mod::CProgress::tProgressFunc [inherited]

Progress observer (= functor).

• You may return false from the observer if you want to terminate the running operation.
• Parameters describe current and final state of the pending operation (counter and maximal value).
• If the second parameter is equal to -1, termination time cannot be determined, the current state is unknown.

typedef CProgressInitializer mds::mod::CProgress::tProgressInitializer [inherited]

Helper class which can be used to call methods beginProgress() and endProgress() automatically.

Create static object of this type at the begining of a method that realizes an operation.

template<class V >

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

Volume type.

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

template<class V >

typedef base::tVoxel mds::img::CVolumeMedianFilter< 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::CVolumeMedianFilter< V >::CVolumeMedianFilter

(

tSize

Size

)

Constructor that creates a new median filter.

• Parameter 'Size' is a window size and it must be an odd number.

template<class V >

mds::img::CVolumeMedianFilter< V >::~CVolumeMedianFilter

(

)

Destructor.

---

Member Function Documentation

void mds::mod::CProgress::beginProgress

(

)

[inherited]

This function must be called by the class realizing an operation before it starts.

void mds::mod::CProgress::deregisterProgressFunc

(

)

[inherited]

Sets the default empty observer.

void mds::mod::CProgress::endProgress

(

)

[inherited]

The function must be called by the class realizing an operation every time the operation finishes.

• Sets the default observer.

int mds::mod::CProgress::getProgressCount

(

)

const [inherited]

Returns current value of the internal progress value.

int mds::mod::CProgress::getProgressMax

(

)

const [inherited]

Returns the maximum allowed value of the internal progress counter.

template<class V >

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

Returns filter response at specified volume position.

• Value is not normalized!

template<class V >

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

Median volume filtering.

• Returns false on failure

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

bool mds::mod::CProgress::progress

(

int

iIncrement = 1

)

[inherited]

Calls the registered observer.

• Returns false if the running operation should be terminated as soon as possible.
• It must be called periodically by the class realizing the operation.

void mds::mod::CProgress::registerProgressFunc

(

const tProgressFunc &

Func

)

[inherited]

Sets observer/functor called to inform a calling process about the current state of the running operation.

• This function should be called before any operation starts.

void mds::mod::CProgress::setProgressMax

(

int

iValue

)

[inherited]

Sets the maximal counter value.

template<class V >

void mds::img::CVolumeMedianFilter< V >::setSize

(

tSize

Size

)

Sets the windows size.

---

Member Data Documentation

template<class V >

mds::base::CData<tVoxel> mds::img::CVolumeMedianFilter< V >::m_Data [protected]

Internal data buffer.

template<class V >

tSize mds::img::CVolumeMedianFilter< V >::m_MedianSize [protected]

Median filter size.

---

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

• VolumeFilters/mdsMedian.h
• VolumeFilters/mdsMedian.hxx