lti::erosion::parameters Class Reference

the parameters for the class erosion More...

#include <ltiErosion.h>

Inheritance diagram for lti::erosion::parameters:

[legend]

Collaboration diagram for lti::erosion::parameters:

[legend]

List of all members.

Public Types
enum	eMode { Binary, Gray }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
void	setKernel (const mathObject &aKernel)
const mathObject &	getKernel () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eMode	mode
Protected Attributes
mathObject *	kernel

---

Detailed Description

the parameters for the class erosion

---

Member Enumeration Documentation

enum lti::erosion::parameters::eMode

type to specify what kind of erosion should be applied.

See lti::erosion for details.

Enumerator:

Binary	Binary erosion
Gray	Gray valued erosion

---

Constructor & Destructor Documentation

lti::erosion::parameters::parameters

(

)

default constructor

Reimplemented from lti::morphology::parameters.

lti::erosion::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::morphology::parameters.

lti::erosion::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::morphology::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::erosion::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::morphology::parameters.

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

const mathObject& lti::erosion::parameters::getKernel

(

)

const

returns the kernel in use.

If it is not set yet, an lti::invalidParameters exception will be thrown

Returns:

a const reference to the filter kernel.

const char* lti::erosion::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::morphology::parameters.

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

void lti::erosion::parameters::setKernel

(

const mathObject &

aKernel

)

sets the filter kernel to be used.

A copy of the given parameter will be made!

Parameters:

aKernel

the filter kernel to be used

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

mathObject* lti::erosion::parameters::kernel [protected]

The kernel to be used.

This parameter can only be set through the setKernel member.

eMode lti::erosion::parameters::mode

Erosion mode.

The erosion is defined for "Binary" images (only two values per pixel) and for gray scaled images (channels or channel8). In "Binary" modus, the channels and channel8s will be interpreted as binary with 0 as "0" and everything else as "1" The default value is "Binary"

---

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

• ltiErosion.h