lti::scaling::parameters Class Reference

The parameters for the class scaling. More...

#include <ltiScaling.h>

Inheritance diagram for lti::scaling::parameters:

[legend]

Collaboration diagram for lti::scaling::parameters:

[legend]

List of all members.

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< float >	scale
eInterpolatorType	interpolatorType

---

Detailed Description

The parameters for the class scaling.

---

Constructor & Destructor Documentation

lti::scaling::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::modifier::parameters.

lti::scaling::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::scaling::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::scaling::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::modifier::parameters.

parameters& lti::scaling::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::modifier::parameters.

const char* lti::scaling::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::modifier::parameters.

parameters& lti::scaling::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::scaling::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 lti::modifier::parameters.

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

eInterpolatorType lti::scaling::parameters::interpolatorType

Interpolator type to be used.

Default value: BilinearInterpolator

tpoint<float> lti::scaling::parameters::scale

Scaling factor.

Each axis of the image can be scaled by a different factor. The x component of this point will be the horizontal scaling factor and the y component the vertical scaling factor.

Only positive values are allowed. You can flip you image using lti::flipImage if you need to first.

With scale between 0 and 1 this functor does a down-sampling and above 1.0 up-sampling.

Default value: tpoint<float>(sqrt(2),sqrt(2))

---

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

• ltiScaling.h