lti::fastRelabeling::parameters Class Reference

the parameters for the class fastRelabeling More...

#include <ltiFastRelabeling.h>

Inheritance diagram for lti::fastRelabeling::parameters:

[legend]

Collaboration diagram for lti::fastRelabeling::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
General Options
int	minThreshold
int	maxThreshold
bool	assumeLabeledMask
bool	fourNeighborhood
Filter objects
bool	sortSize
int	minimumObjectSize

---

Detailed Description

the parameters for the class fastRelabeling

---

Constructor & Destructor Documentation

lti::fastRelabeling::parameters::parameters

(

)

default constructor

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

lti::fastRelabeling::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

lti::fastRelabeling::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::fastRelabeling::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

parameters& lti::fastRelabeling::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

const char* lti::fastRelabeling::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

parameters& lti::fastRelabeling::parameters::operator=

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

virtual bool lti::fastRelabeling::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

virtual bool lti::fastRelabeling::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::geometricFeaturesFromMask::parameters, and lti::multiGeometricFeaturesFromMask::parameters.

---

Member Data Documentation

bool lti::fastRelabeling::parameters::assumeLabeledMask

If true, each integer value in the original image will be considered as a new region label.

If false, only two "values" will be taken: within the threshold interval or outside it.

Default value: true

bool lti::fastRelabeling::parameters::fourNeighborhood

If true, a 4-neighborhood will be used to detect the adjacent pixels, otherwise an 8-neighborhood will be used.

Due to the lesser number of required comparisons, the 4-neighborhood allows a faster relabeling. Sometimes however the 8-neighborhood is required.

Default value: true (i.e. 4-neighborhood)

int lti::fastRelabeling::parameters::maxThreshold

All values in the original mask below or equal this maximum threshold will be considered as candidates to relabeling.

Default value: std::numeric_limits<int>::max()

int lti::fastRelabeling::parameters::minimumObjectSize

If the number of pixels of an object is less than the minimumObjectSize, it will be assigned to the background label (0).

Default value: 1 (i.e. consider all objects)

int lti::fastRelabeling::parameters::minThreshold

All values in the original mask above or equal this minimum threshold will be considered as candidates to relabeling.

Default value: 1

bool lti::fastRelabeling::parameters::sortSize

If sortSize is true, the object labels will be assigned according to the number of pixels of each object.

Warning:

There is an exception. The label 0 has a special meaning and it will always be assigned to the background (everything outside the given interval between minThreshold and maxThreshold) independently of its size. This means the regions will be sorted decreasingly but begining with the second element. The first one is always the background. If you set minThreshold to zero, the first element is always empty.

Defalut value: false

---

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

• ltiFastRelabeling.h