lti::thresholdSegmentation::parameters Class Reference

the parameters for the class thresholdSegmentation More...

#include <ltiThresholdSegmentation.h>

Inheritance diagram for lti::thresholdSegmentation::parameters:

[legend]

Collaboration diagram for lti::thresholdSegmentation::parameters:

[legend]

List of all members.

Public Member Functions
	parameters (const bool &useChannel8=true)
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (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
float	inRegionValue
float	outRegionValue
float	highThreshold
float	lowThreshold
Static Public Attributes
static const float	Original

---

Detailed Description

the parameters for the class thresholdSegmentation

---

Constructor & Destructor Documentation

lti::thresholdSegmentation::parameters::parameters

(

const bool &

useChannel8 = true

)

default constructor Per default, the threshold values will be defined in the value range of channel8 (0 to 255).

If you want to work with channels than specify in the constructor of the parameters (false), this way the value range of the thresholds will lay between 0 and 1.0

lti::thresholdSegmentation::parameters::parameters

(

const parameters &

other

)

copy constructor

Reimplemented from lti::segmentation::parameters.

lti::thresholdSegmentation::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::segmentation::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::thresholdSegmentation::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::segmentation::parameters.

parameters& lti::thresholdSegmentation::parameters::copy

(

const parameters &

other

)

copy member

Reimplemented from lti::segmentation::parameters.

const char* lti::thresholdSegmentation::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::segmentation::parameters.

virtual bool lti::thresholdSegmentation::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[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::segmentation::parameters.

virtual bool lti::thresholdSegmentation::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::segmentation::parameters.

---

Member Data Documentation

float lti::thresholdSegmentation::parameters::highThreshold

The upper threshold value.

Default value: 255 for channel8 or 1.0 for channels (see constructor parameters(const bool)). Note that this value will be interpreted "as is" by the apply methods, i.e., if you say the highThreshold is 0.8 (default value for channels) and you apply the functor to a channel8, than eevery pixel will be considered to lay out of the region! The closed interval to consider a pixel-value in the region will be [lowThreshold,highThreshold]. It must be hold highThreshold >= lowThreshold

float lti::thresholdSegmentation::parameters::inRegionValue

The value assigned to the pixels with values between the upper and the lower threshold (inclusive) or "Original".

In case of Original (the default value), the values of the original image-pixels are acquired. For channel8s this value must be between 0 and 255. For channels this value should be between 0 and 1.0

float lti::thresholdSegmentation::parameters::lowThreshold

The lower threshold value.

Default value: 0 Note that this value will be interpreted "as is" by the apply methods, i.e., if you say the lowThreshold is 127, then for a "standard" channel, which usually contains values <= 1.0, everything will lay out of the region! The closed interval to consider a pixel-value in the region will be [lowThreshold,highThreshold]. It must be hold highThreshold >= lowThreshold

const float lti::thresholdSegmentation::parameters::Original [static]

Constant value used to specify that the channel pixel values should be retained in the segmented image, instead of generating a mask, with only two values.

float lti::thresholdSegmentation::parameters::outRegionValue

The value assigned to the pixels with values outside the upper and the lower threshold (inclusive) or "Original".

In case of Original, the values of the original image-pixels are acquired. (Default: 0.0) For channel8s this value must be between 0 and 255. For channels this value should be between 0 and 1.0

---

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

• ltiThresholdSegmentation.h