cvr::boundaryExpansion::boundaryExpansion::parameters Class Reference

The parameters for the class boundaryExpansion. More...

#include <cvrBoundaryExpansion.h>

Inheritance diagram for cvr::boundaryExpansion::boundaryExpansion::parameters:

[legend]

Collaboration diagram for cvr::boundaryExpansion::boundaryExpansion::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
int	bottomBorder
int	leftBorder
int	rightBorder
int	topBorder
eBoundaryType	boundaryType
bool	normalize

---

Detailed Description

The parameters for the class boundaryExpansion.

---

Constructor & Destructor Documentation

cvr::boundaryExpansion::boundaryExpansion::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::functor::functor::parameters.

cvr::boundaryExpansion::boundaryExpansion::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

cvr::boundaryExpansion::boundaryExpansion::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::functor::functor::parameters.

---

Member Function Documentation

virtual parameters* cvr::boundaryExpansion::boundaryExpansion::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

parameters& cvr::boundaryExpansion::boundaryExpansion::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

virtual const std::string& cvr::boundaryExpansion::boundaryExpansion::parameters::name

(

)

const [virtual]

Returns the complete name of the parameters class.

Implements cvr::functor::functor::parameters.

virtual parameters* cvr::boundaryExpansion::boundaryExpansion::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::functor::functor::parameters.

parameters& cvr::boundaryExpansion::boundaryExpansion::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 cvr::boundaryExpansion::boundaryExpansion::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 cvr::parametersManager::parametersManager::parameters.

virtual bool cvr::boundaryExpansion::boundaryExpansion::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 cvr::parametersManager::parametersManager::parameters.

---

Member Data Documentation

int cvr::boundaryExpansion::boundaryExpansion::parameters::bottomBorder

Number of pixels in the bottom border.

Default value: 5

eBoundaryType cvr::boundaryExpansion::boundaryExpansion::parameters::boundaryType

Type of boundary expansion.

int cvr::boundaryExpansion::boundaryExpansion::parameters::leftBorder

Number of pixels in the left border.

Default value: 5

bool cvr::boundaryExpansion::boundaryExpansion::parameters::normalize

Normalization.

If set to true, then the values will be normalized and denormalized when transfering the data from one matrix of one type to a matrix of another type, so that the values preserve their nature. For instance, when converting ubyte to float, the values will be divided by 255 to produce values between 0.0f and 1.0f, or the other way around. The normalization constants are given by cvr::typeInfo<T>::suggestedNorm().

If set to false then the values are simply casted.

Default value: false

int cvr::boundaryExpansion::boundaryExpansion::parameters::rightBorder

Number of pixels in the right border.

Default value: 5

int cvr::boundaryExpansion::boundaryExpansion::parameters::topBorder

Number of pixels in the top border.

Default value: 5

---

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

• cvrBoundaryExpansion.h