cvr::boundaryExpansion Class Reference
[Geometric Image Transformations]

Class boundaryExpansion. More...

#include <cvrBoundaryExpansion.h>

Inheritance diagram for cvr::boundaryExpansion:

[legend]

Collaboration diagram for cvr::boundaryExpansion:

[legend]

List of all members.

Classes
class	parameters
	The parameters for the class boundaryExpansion. More...
Public Member Functions
	boundaryExpansion ()
	boundaryExpansion (const int width, const eBoundaryType type=Zero, const bool normalize=false)
	boundaryExpansion (const parameters &par)
	boundaryExpansion (const boundaryExpansion &other)
virtual	~boundaryExpansion ()
template<typename T >
bool	apply (matrix< T > &srcdest) const
template<typename T , typename U >
bool	apply (const matrix< T > &src, matrix< U > &dest) const
boundaryExpansion &	copy (const boundaryExpansion &other)
boundaryExpansion &	operator= (const boundaryExpansion &other)
virtual const std::string &	name () const
virtual boundaryExpansion *	clone () const
virtual boundaryExpansion *	newInstance () const
const parameters &	getParameters () const

---

Detailed Description

Class boundaryExpansion.

This class is used to expand the border of an image and fill it according to the boundary type specified in the parameters. It is employed by several functors to work using "internal" pixels only, without worring about the specific border type to be used.

If negative values of border are given in the parameters, the image will be clipped.

See also:

boundaryExpansion::parameters.

---

Constructor & Destructor Documentation

cvr::boundaryExpansion::boundaryExpansion

(

)

Default constructor.

cvr::boundaryExpansion::boundaryExpansion	(	const int	width,
		const eBoundaryType	type = Zero,
		const bool	normalize = false
	)

Construct a functor with a border of homogeneous width all around, and the given boundary type.

Parameters:

	width	width of the border
	type	boundary type
	normalize	indicate if normalization by the type conversion has to be made.

cvr::boundaryExpansion::boundaryExpansion

(

const parameters &

par

)

Construct a functor using the given parameters.

cvr::boundaryExpansion::boundaryExpansion

(

const boundaryExpansion &

other

)

Copy constructor.

Parameters:

other

the object to be copied

virtual cvr::boundaryExpansion::~boundaryExpansion

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<typename T , typename U >

bool cvr::boundaryExpansion::apply	(	const matrix< T > &	src,
		matrix< U > &	dest
	)			const [inline]

Operates on a copy of the given arguments.

Parameters:

	src	matrix<T> with the source data.
	dest	matrix<T> where the result will be left.

Returns:

true if apply successful or false otherwise.

template<typename T >

bool cvr::boundaryExpansion::apply

(

matrix< T > &

srcdest

)

const [inline]

Expand the boundary of the given matrix and leave the result on the same matrix.

Parameters:

srcdest

matrix<T> with the source data. The result will be left here too.

Returns:

true if apply successful or false otherwise.

virtual boundaryExpansion* cvr::boundaryExpansion::clone

(

)

const [virtual]

Returns a pointer to a clone of this functor.

Implements cvr::functor.

boundaryExpansion& cvr::boundaryExpansion::copy

(

const boundaryExpansion &

other

)

Copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

const parameters& cvr::boundaryExpansion::getParameters

(

)

const

Returns used parameters.

Reimplemented from cvr::parametersManager.

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

(

)

const [virtual]

Returns the complete name of the functor class.

Implements cvr::functor.

virtual boundaryExpansion* cvr::boundaryExpansion::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of this functor.

Implements cvr::functor.

boundaryExpansion& cvr::boundaryExpansion::operator=

(

const boundaryExpansion &

other

)

Alias for copy member.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

---

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

• cvrBoundaryExpansion.h