lti::chrominanceMapMasking::parameters Class Reference

The parameters for the class chrominanceMapMasking. More...

#include <ltiChrominanceMapMasking.h>

Inheritance diagram for lti::chrominanceMapMasking::parameters:

[legend]

Collaboration diagram for lti::chrominanceMapMasking::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
ubyte	blackLuminance
ubyte	whiteLuminance
int	achromaticLabel
int	whiteLabel
int	greyLabel
int	blackLabel
int	shrinkFactor

---

Detailed Description

The parameters for the class chrominanceMapMasking.

---

Constructor & Destructor Documentation

lti::chrominanceMapMasking::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::modifier::parameters.

lti::chrominanceMapMasking::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::chrominanceMapMasking::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::chrominanceMapMasking::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::modifier::parameters.

parameters& lti::chrominanceMapMasking::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.

const char* lti::chrominanceMapMasking::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::modifier::parameters.

parameters& lti::chrominanceMapMasking::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

virtual bool lti::chrominanceMapMasking::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.

virtual bool lti::chrominanceMapMasking::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.

---

Member Data Documentation

int lti::chrominanceMapMasking::parameters::achromaticLabel

The label of the achromatic region in the chrominance map.

int lti::chrominanceMapMasking::parameters::blackLabel

The label of black objects in the destination.

ubyte lti::chrominanceMapMasking::parameters::blackLuminance

Achromatic objects which a luminance below this value are interpreted as black.

int lti::chrominanceMapMasking::parameters::greyLabel

The label of grey objects in the destination.

int lti::chrominanceMapMasking::parameters::shrinkFactor

Each color band usually contains 8bit resulting in a 256x256 histogram.

For efficiency the histograms may be downsampled by 2 power shrinkFactor.

Default: 0.

int lti::chrominanceMapMasking::parameters::whiteLabel

The label of white objects in the destination.

ubyte lti::chrominanceMapMasking::parameters::whiteLuminance

Achromatic objects which a luminance above this value are interpreted as white.

---

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

• ltiChrominanceMapMasking.h