lti::thresholding::parameters Class Reference

the parameters for the class thresholding More...

#include <ltiThresholding.h>

Inheritance diagram for lti::thresholding::parameters:

[legend]

Collaboration diagram for lti::thresholding::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	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
bool	keepOutRegion
bool	keepInRegion
float	inRegionValue
float	outRegionValue
float	highThreshold
float	lowThreshold

---

Detailed Description

the parameters for the class thresholding

---

Constructor & Destructor Documentation

lti::thresholding::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

lti::thresholding::parameters::parameters

(

const parameters &

other

)

copy constructor

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

lti::thresholding::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::thresholding::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

parameters& lti::thresholding::parameters::copy

(

const parameters &

other

)

copy member

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

const char* lti::thresholding::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

virtual bool lti::thresholding::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::modifier::parameters.

Reimplemented in lti::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

virtual bool lti::thresholding::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::optimalThresholding::parameters, and lti::relativeThresholding::parameters.

---

Member Data Documentation

float lti::thresholding::parameters::highThreshold

The upper threshold value.

This value should be between 0 and 1.0. For channel8s any value greater than 1 will be interpreted as 1. (internally as 255) The closed interval to consider a pixel-value in the region will be [lowThreshold,highThreshold]. It must be hold highThreshold >= lowThreshold.

Default: maximum value of float

float lti::thresholding::parameters::inRegionValue

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

In case of keepInRegion=true (the default value), the values of the original image-pixels are acquired. For channel8s this value must be between 0 and 1.0. (it is internally scaled to ubyte. For channels this value should be between 0 and 1.0

Default: 1.0

bool lti::thresholding::parameters::keepInRegion

Specifies whether the pixel values in the inner threshold range should be retained instead of beeing replaced by inRegionValue.

Default: true

bool lti::thresholding::parameters::keepOutRegion

Specifies whheter the pixel values in the outer threshold range should be retained instead of beeing replaced by outRegionValue.

Default: false

float lti::thresholding::parameters::lowThreshold

The lower threshold value.

For channel8s this value must between 0 and 1.0. ( it is internally scaled to ubyte) The closed interval to consider a pixel-value in the region will be [lowThreshold,highThreshold]. It must be hold highThreshold >= lowThreshold

Default: 0.5

float lti::thresholding::parameters::outRegionValue

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

In case of keepOutRegion=true, the values of the original image-pixels are acquired. For channel8s this value must be between 0 and 1.0. ( it is internally scaled to ubyte). For channels this value should be between 0 and 1.0

Default: 0.0

---

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

• ltiThresholding.h