lti::gradientFunctor::parameters Class Reference

the parameters for the class gradientFunctor More...

#include <ltiGradientFunctor.h>

Inheritance diagram for lti::gradientFunctor::parameters:

[legend]

Collaboration diagram for lti::gradientFunctor::parameters:

[legend]

List of all members.

Public Types
enum	eOutputFormat { Polar, Cartesic }
enum	eKernelType {   Optimal, OGD, Difference, Roberts,   Sobel, Prewitt , Kirsch, Harris }
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
eOutputFormat	format
eKernelType	kernelType
int	gradientKernelSize
float	ogdVariance

---

Detailed Description

the parameters for the class gradientFunctor

---

Member Enumeration Documentation

enum lti::gradientFunctor::parameters::eKernelType

Kernel Type.

Enumerator:

Optimal	Use the optimal kernel gradients of Ando (see lti::gradientKernelX).
OGD	Use oriented Gaussian derivatives.
Difference	Simplest (and fastest) kernel just right-left, top-bottom.
Roberts	Also very simple, but has a location-bias of half pixel. These are 2x2 kernels,
Sobel	3x3 separable kernel with a 1 2 1, -1 0 1 sub-kernels (see lti::sobelKernelX)
Prewitt	3x3 separable kernel with a 1 1 1, -1 0 1 sub-kernels (see lti::prewittKernelX)
Kirsch	3x3 non-separable kernel (see lti::robinsonKernelX)
Harris	3x3 non-separable kernel (see lti::kirschKernelX) 1x5 separable kernel -2 -1 0 1 2 (see lti::harrisKernelX)

enum lti::gradientFunctor::parameters::eOutputFormat

Format types.

Enumerator:

Polar	Polar coordinates first magnitud, then angle.
Cartesic	Cartesian coordinates first x, then y.

---

Constructor & Destructor Documentation

lti::gradientFunctor::parameters::parameters

(

)

default constructor

Reimplemented from lti::transform::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

lti::gradientFunctor::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::transform::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

lti::gradientFunctor::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::gradientFunctor::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::transform::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

parameters& lti::gradientFunctor::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::transform::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

const char* lti::gradientFunctor::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::transform::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

parameters& lti::gradientFunctor::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

Reimplemented in lti::colorContrastGradient::parameters.

virtual bool lti::gradientFunctor::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::functor::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

virtual bool lti::gradientFunctor::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::functor::parameters.

Reimplemented in lti::colorContrastGradient::parameters.

---

Member Data Documentation

eOutputFormat lti::gradientFunctor::parameters::format

The output of the apply methods can be in polar or cartesic coordinates.

You can specify here which format you prefer.

Default value: Polar

int lti::gradientFunctor::parameters::gradientKernelSize

Size of the kernel used.

This attribute is used only for the Optimal and OGD Kernel types.

For the Optimal kernel type, the value must be 3, 4, or 5. For the OGD odd values greater or equal 3 should be used.

Default value: 3

eKernelType lti::gradientFunctor::parameters::kernelType

Type of gradient kernel to be used.

Default value: Optimal

float lti::gradientFunctor::parameters::ogdVariance

Variance used for the Gaussian.

This argument has effect only if kernelType is OGD.

It is the variance use for the Gaussian to be derived as approximation for a gradient kernel.

Default value: -1 (i.e. the variance will be computed from the size of the kernel (gradientKernelSize) )

---

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

• ltiGradientFunctor.h