LTI-Lib latest version v1.9 - last update 24 Nov 2005
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
lti::edgeDetector::parameters

lti::edgeDetector::parameters Class Reference

the parameters for the class edgeDetector More...

#include <ltiEdgeDetector.h>

Inheritance diagram for lti::edgeDetector::parameters:

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

Collaboration graph
[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

ubyte noEdgeValue
ubyte edgeValue

Detailed Description

the parameters for the class edgeDetector

Constructor & Destructor Documentation

lti::edgeDetector::parameters::parameters (   ) 
 

default constructor

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::cannyEdges::parameters, lti::classicEdgeDetector::parameters, lti::colorEdgesGS::parameters, and lti::susanEdges::parameters.

lti::edgeDetector::parameters::parameters (  const parameters &  other  ) 
 

copy constructor

Parameters:
other the parameters object to be copied

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

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::cannyEdges::parameters, lti::classicEdgeDetector::parameters, lti::colorEdgesGS::parameters, and lti::susanEdges::parameters.

Member Function Documentation

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

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::cannyEdges::parameters, lti::classicEdgeDetector::parameters, lti::colorEdgesGS::parameters, and lti::susanEdges::parameters.

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

const char* lti::edgeDetector::parameters::getTypeName (   )  const [virtual]
 

returns name of this type

Reimplemented from lti::modifier::parameters.

Reimplemented in lti::cannyEdges::parameters, lti::classicEdgeDetector::parameters, lti::colorEdgesGS::parameters, and lti::susanEdges::parameters.

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

Reimplemented in lti::cannyEdges::parameters, lti::classicEdgeDetector::parameters, lti::colorEdgesGS::parameters, and lti::susanEdges::parameters.

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

Reimplemented in lti::cannyEdges::parameters, lti::classicEdgeDetector::parameters, lti::colorEdgesGS::parameters, and lti::susanEdges::parameters.

Member Data Documentation

ubyte lti::edgeDetector::parameters::edgeValue
 

Value used to denote an edge pixel.

The value must be between 0 and 255. For channels the used value will be scaled by 255.

Default value: 255

ubyte lti::edgeDetector::parameters::noEdgeValue
 

Value used to denote a no-edge pixel.

The value must be between 0 and 255. For channels the used value will be scaled by 255.

Default value: 0

The documentation for this class was generated from the following file:
Generated on Thu Nov 24 16:39:18 2005 for LTI-Lib by Doxygen 1.4.4