LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::polygonApproximation::parameters Class Reference

the parameters for the class polygonApproximation More...

#include <ltiPolygonApproximation.h>

Inheritance diagram for lti::polygonApproximation::parameters:
Inheritance graph
[legend]
Collaboration diagram for lti::polygonApproximation::parameters:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 parameters ()
 parameters (const parameters &other)
 ~parameters ()
const char * getTypeName () const
parameterscopy (const parameters &other)
parametersoperator= (const parameters &other)
virtual functor::parametersclone () const
virtual bool write (ioHandler &handler, const bool complete=true) const
virtual bool read (ioHandler &handler, const bool complete=true)

Public Attributes

int minStep
bool searchMaxDistance
double maxDistance
bool closed

Detailed Description

the parameters for the class polygonApproximation


Constructor & Destructor Documentation

lti::polygonApproximation::parameters::parameters (  ) 

default constructor

Reimplemented from lti::modifier::parameters.

lti::polygonApproximation::parameters::parameters ( const parameters other  ) 

copy constructor

Parameters:
other the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::polygonApproximation::parameters::~parameters (  )  [virtual]

destructor

Reimplemented from lti::functor::parameters.


Member Function Documentation

virtual functor::parameters* lti::polygonApproximation::parameters::clone (  )  const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

parameters& lti::polygonApproximation::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::polygonApproximation::parameters::getTypeName (  )  const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

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

If true, only the found vertices will be in the list.

If false, the last point of the list will be adjacent to the first point in the list.

Default: true

Specify the maximal allowed euclidean distance between the border points and the approximated polygon.

(if negative, each "minStep" pixel of the border points will be taken).

Default value: 1

Minimal "distance" between vertices of the polygon.

if 0 or negative, only the maxDistance parameter will be considered). The "distance" used here is NOT the euclidean distance between the vertices but the number of elements between both vertices in the border list. These is usually therefore a city-block distance or an 8-neighborhood distance depending on the border-points description used.

Default value: -1 (i.e. use only maxDistance).

If true, the first two vertices will be computed as the two points in the border with the maximal distance.

If false, the first point in the list will be a vertex and the border point with the maximal distance to it too. This faster method is the default. It provides usually good results.

Default value: false


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

Generated on Sat Apr 10 15:27:41 2010 for LTI-Lib by Doxygen 1.6.1