lti::borderSignature::parameters Class Reference

the parameters for the class borderSignature More...

#include <ltiBorderSignature.h>

Inheritance diagram for lti::borderSignature::parameters:

[legend]

Collaboration diagram for lti::borderSignature::parameters:

[legend]

List of all members.

Public Types
enum	eMethod { distance, area }
enum	eDistanceType { min, max, average }
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
tpoint< double >	center
int	numberOfSegments
double	orientation
eMethod	method
eDistanceType	distanceType

---

Detailed Description

the parameters for the class borderSignature

---

Member Enumeration Documentation

enum lti::borderSignature::parameters::eDistanceType

distance type.

This are the sub-modes for the "distance" method

Enumerator:

min	search the minimum distance within each segment
max	search the maximum distance
average	calculate the average distance

enum lti::borderSignature::parameters::eMethod

method type.

This are the two modes of operation

Enumerator:

distance	the distance to the border within each segment
area	the area inside the border region within each segment

---

Constructor & Destructor Documentation

lti::borderSignature::parameters::parameters

(

)

default constructor

Reimplemented from lti::featureExtractor::parameters.

lti::borderSignature::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::featureExtractor::parameters.

lti::borderSignature::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::featureExtractor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::borderSignature::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::featureExtractor::parameters.

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

const char* lti::borderSignature::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::featureExtractor::parameters.

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

virtual bool lti::borderSignature::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::functor::parameters.

---

Member Data Documentation

tpoint<double> lti::borderSignature::parameters::center

The origin of the segments, can be e.g.

the center of gravity of a 2D-shape the borderpoints (see lti::geometricFeatures). The default value is (0.0 , 0.0).

eDistanceType lti::borderSignature::parameters::distanceType

This specifies the sub-method of the "distance" method (see eDistanceType).

eMethod lti::borderSignature::parameters::method

The mode of operation (see eMethod).

int lti::borderSignature::parameters::numberOfSegments

The number of segments that the 2D-space is divided into.

Note: If you want to use FFT later set the value to pow(2,x). The default value is 32.

double lti::borderSignature::parameters::orientation

This parameter specifies the orientation of the first segment.

The segments are ordered clockwise cyclic around "center". An angle in radient between -2Pi and 2Pi is required. The default value is 0.0 (Horizontal orientation).

---

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

• ltiBorderSignature.h