lti::boundingBox< T >::parameters Class Reference

the parameters for the class boundingBox More...

#include <ltiBoundingBox.h>

Inheritance diagram for lti::boundingBox< T >::parameters:

[legend]

Collaboration diagram for lti::boundingBox< T >::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
int	borderSize
bool	centerOfGravity
T	backgroundColor
bool	justSuppressBackground
bool	optimalBox
bool	useLengths

---

Detailed Description

template<class T>
class lti::boundingBox< T >::parameters

the parameters for the class boundingBox

---

Constructor & Destructor Documentation

template<class T>

lti::boundingBox< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::segmentation::parameters.

References lti::boundingBox< T >::parameters::backgroundColor, lti::boundingBox< T >::parameters::borderSize, lti::boundingBox< T >::parameters::centerOfGravity, lti::boundingBox< T >::parameters::justSuppressBackground, lti::boundingBox< T >::parameters::optimalBox, and lti::boundingBox< T >::parameters::useLengths.

Referenced by lti::boundingBox< T >::parameters::clone().

template<class T>

lti::boundingBox< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::segmentation::parameters.

References lti::boundingBox< T >::parameters::copy().

template<class T>

lti::boundingBox< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::segmentation::parameters.

---

Member Function Documentation

template<class T>

virtual functor::parameters* lti::boundingBox< T >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::segmentation::parameters.

References lti::boundingBox< T >::parameters::parameters().

template<class T>

parameters& lti::boundingBox< T >::parameters::copy

(

const parameters &

other

)

[inline]

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::segmentation::parameters.

References lti::boundingBox< T >::parameters::backgroundColor, lti::boundingBox< T >::parameters::borderSize, lti::boundingBox< T >::parameters::centerOfGravity, lti::segmentation::parameters::copy(), lti::boundingBox< T >::parameters::justSuppressBackground, lti::boundingBox< T >::parameters::optimalBox, and lti::boundingBox< T >::parameters::useLengths.

Referenced by lti::boundingBox< T >::parameters::parameters().

template<class T>

const char* lti::boundingBox< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::segmentation::parameters.

template<class T>

virtual bool lti::boundingBox< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[inline, 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 read, otherwise only the data block will be read.

Returns:

true if write was successful

Reimplemented from lti::segmentation::parameters.

References lti::boundingBox< T >::parameters::backgroundColor, lti::boundingBox< T >::parameters::borderSize, lti::boundingBox< T >::parameters::centerOfGravity, lti::boundingBox< T >::parameters::justSuppressBackground, lti::boundingBox< T >::parameters::optimalBox, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::boundingBox< T >::parameters::useLengths.

template<class T>

virtual bool lti::boundingBox< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [inline, 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.

References lti::boundingBox< T >::parameters::backgroundColor, lti::boundingBox< T >::parameters::borderSize, lti::boundingBox< T >::parameters::centerOfGravity, lti::boundingBox< T >::parameters::justSuppressBackground, lti::boundingBox< T >::parameters::optimalBox, lti::boundingBox< T >::parameters::useLengths, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T>

T lti::boundingBox< T >::parameters::backgroundColor

Background color.

Default value: T(0) (i.e. Black for images or 0 for channels)

Referenced by lti::boundingBox< T >::parameters::copy(), lti::boundingBox< T >::parameters::parameters(), lti::boundingBox< T >::parameters::read(), and lti::boundingBox< T >::parameters::write().

template<class T>

int lti::boundingBox< T >::parameters::borderSize

The extracted image will have at each side a border of (at least) the specified number of pixels.

If "centerOfGravity" is false, the border will have exactly "borderSize" pixels.

Default value: 1

Referenced by lti::boundingBox< T >::parameters::copy(), lti::boundingBox< T >::parameters::parameters(), lti::boundingBox< T >::parameters::read(), and lti::boundingBox< T >::parameters::write().

template<class T>

bool lti::boundingBox< T >::parameters::centerOfGravity

If "true", the center of gravity of the object will be forced to be at the center of the new image.

If false, only the borders of the object will be considered in the calculations.

Default value: false;

Referenced by lti::boundingBox< T >::parameters::copy(), lti::boundingBox< T >::parameters::parameters(), lti::boundingBox< T >::parameters::read(), and lti::boundingBox< T >::parameters::write().

template<class T>

bool lti::boundingBox< T >::parameters::justSuppressBackground

Suppress background only.

If true, the borderSize and centerOfGravity parameters will be ignored, and the resulting image will have exactly the same dimensions than the input image. If false, the size of the resulting image will be determined by the other parameters.

Default value: false.

Referenced by lti::boundingBox< T >::parameters::copy(), lti::boundingBox< T >::parameters::parameters(), lti::boundingBox< T >::parameters::read(), and lti::boundingBox< T >::parameters::write().

template<class T>

bool lti::boundingBox< T >::parameters::optimalBox

If false, just the principal components of the convex hull will be used to determine the rectLocation's angle.

If true, an optimal angle will be determined, that minimizes the area of the rectLocation.

This attribute takes effect only in the apply methods related to the computation of the rectLocation instances.

Default value: false

Referenced by lti::boundingBox< T >::parameters::copy(), lti::boundingBox< T >::parameters::parameters(), lti::boundingBox< T >::parameters::read(), and lti::boundingBox< T >::parameters::write().

template<class T>

bool lti::boundingBox< T >::parameters::useLengths

If true, the bounding box length is used for determining which axis represents is the main axis.

If false, this is determined by a PCA of the contour points.

Default value: false

Referenced by lti::boundingBox< T >::parameters::copy(), lti::boundingBox< T >::parameters::parameters(), lti::boundingBox< T >::parameters::read(), and lti::boundingBox< T >::parameters::write().

---

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

• ltiBoundingBox.h