lti::flipImage Class Reference
[Simple geometry classes and functions]

Flips an image horizontally or vertically. More...

#include <ltiFlipImage.h>

Inheritance diagram for lti::flipImage:

[legend]

Collaboration diagram for lti::flipImage:

[legend]

List of all members.

Classes
class	parameters
	the parameters for the class flipImage More...
Public Member Functions
	flipImage ()
	flipImage (const parameters &par)
	flipImage (const flipImage &other)
virtual	~flipImage ()
virtual const char *	getTypeName () const
bool	apply (matrix< rgbPixel > &srcdest) const
bool	apply (const matrix< rgbPixel > &src, matrix< rgbPixel > &dest) const
bool	apply (matrix< float > &srcdest) const
bool	apply (const matrix< float > &src, matrix< float > &dest) const
bool	apply (matrix< ubyte > &srcdest) const
bool	apply (const matrix< ubyte > &src, matrix< ubyte > &dest) const
flipImage &	copy (const flipImage &other)
flipImage &	operator= (const flipImage &other)
virtual functor *	clone () const
const parameters &	getParameters () const

---

Detailed Description

Flips an image horizontally or vertically.

This is a very simple functor that returns a flipped version of the original image. The mirroring can be done along the horizontal or vertical axes, or both.

This functor is about 20 times faster in release-mode than using the lti::geometricTransform functor. In the debug mode it is even 40 times faster! The reason is that the latter functor is much more general, and the overhead required for the interpolation and rotation (which is zero in this case) is really expensive.

See also:

lti::geometricTransform, lti::rotation, lti::scaling

---

Constructor & Destructor Documentation

lti::flipImage::flipImage

(

)

default constructor

lti::flipImage::flipImage

(

const parameters &

par

)

Construct a functor using the given parameters.

lti::flipImage::flipImage

(

const flipImage &

other

)

copy constructor

Parameters:

other

the object to be copied

virtual lti::flipImage::~flipImage

(

)

[virtual]

destructor

---

Member Function Documentation

bool lti::flipImage::apply	(	const matrix< ubyte > &	src,
		matrix< ubyte > &	dest
	)			const

operates on a copy of the given parameters.

Parameters:

	src	image with the source data.
	dest	image where the result will be left.

Returns:

true if apply successful or false otherwise.

bool lti::flipImage::apply

(

matrix< ubyte > &

srcdest

)

const

operates on the given parameter.

Parameters:

srcdest

image with the source data. The result will be left here too.

Returns:

true if apply successful or false otherwise.

bool lti::flipImage::apply	(	const matrix< float > &	src,
		matrix< float > &	dest
	)			const [virtual]

operates on a copy of the given parameters.

Parameters:

	src	image with the source data.
	dest	image where the result will be left.

Returns:

true if apply successful or false otherwise.

Reimplemented from lti::modifier.

bool lti::flipImage::apply

(

matrix< float > &

srcdest

)

const [virtual]

operates on the given parameter.

Parameters:

srcdest

image with the source data. The result will be left here too.

Returns:

true if apply successful or false otherwise.

Reimplemented from lti::modifier.

bool lti::flipImage::apply	(	const matrix< rgbPixel > &	src,
		matrix< rgbPixel > &	dest
	)			const

operates on a copy of the given parameters.

Parameters:

	src	image with the source data.
	dest	image where the result will be left.

Returns:

true if apply successful or false otherwise.

bool lti::flipImage::apply

(

matrix< rgbPixel > &

srcdest

)

const

operates on the given parameter.

Parameters:

srcdest

image with the source data. The result will be left here too.

Returns:

true if apply successful or false otherwise.

virtual functor* lti::flipImage::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

flipImage& lti::flipImage::copy

(

const flipImage &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

const parameters& lti::flipImage::getParameters

(

)

const

returns used parameters

Reimplemented from lti::modifier.

virtual const char* lti::flipImage::getTypeName

(

)

const [virtual]

returns the name of this type ("flipImage")

Reimplemented from lti::modifier.

flipImage& lti::flipImage::operator=

(

const flipImage &

other

)

alias for copy member

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

---

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

• ltiFlipImage.h