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

lti::modifier Class Reference

Base class for all filters and other functors, which transform an image or channel in another image of the same type. More...

#include <ltiModifier.h>

Inheritance diagram for lti::modifier:
Inheritance graph
[legend]
Collaboration diagram for lti::modifier:
Collaboration graph
[legend]

List of all members.

Classes

class  parameters
 parameter class for modifier More...

Public Member Functions

 modifier ()
virtual ~modifier ()
const parametersgetParameters () const
bool apply (fvector &srcdest) const
bool apply (ivector &srcdest) const
virtual bool apply (vector< ubyte > &srcdest) const
virtual bool apply (matrix< channel::value_type > &srcdest) const
virtual bool apply (channel &srcdest) const
virtual bool apply (imatrix &srcdest) const
virtual bool apply (matrix< channel8::value_type > &srcdest) const
virtual bool apply (channel8 &srcdest) const
virtual bool apply (image &srcdest) const
virtual bool apply (const fvector &src, fvector &dest) const
virtual bool apply (const ivector &src, ivector &dest) const
virtual bool apply (const vector< ubyte > &src, vector< ubyte > &dest) const
virtual bool apply (const matrix< channel::value_type > &src, matrix< channel::value_type > &dest) const
virtual bool apply (const channel &src, channel &dest) const
virtual bool apply (const imatrix &src, imatrix &dest) const
virtual bool apply (const matrix< channel8::value_type > &src, matrix< channel8::value_type > &dest) const
virtual bool apply (const channel8 &src, channel8 &dest) const
virtual bool apply (const image &src, image &dest) const
virtual const char * getTypeName () const

Protected Member Functions

parametersgetParameters ()

Detailed Description

Base class for all filters and other functors, which transform an image or channel in another image of the same type.

For those functors which generate more than one image or transforms the image in another totally different space (like a vector), are derived from lti::transform (see for example the FFT transformation!)


Constructor & Destructor Documentation

lti::modifier::modifier (  )  [inline]

default constructor

virtual lti::modifier::~modifier (  )  [virtual]

destructor


Member Function Documentation

virtual bool lti::modifier::apply ( const image src,
image dest 
) const [virtual]

operates on a copy of the given parameters (image) The image will be splitted in its RGB components, which will be operated with the fastest method, and the results will be merged.

Parameters:
src lti::image with the source data.
dest image, where the result will be left.
Returns:
true if successful, false otherwise.

Reimplemented in lti::cannyEdges, lti::colorEdgesGS, lti::colorNormalizationBase, lti::comprehensiveColourNormalization, lti::convolution, lti::downsampling, lti::edgeDetector, lti::filledUpsampling, lti::grayWorldNormalization, lti::rotation, lti::scaling, and lti::susanEdges.

virtual bool lti::modifier::apply ( const channel8 src,
channel8 dest 
) const [virtual]
virtual bool lti::modifier::apply ( const matrix< channel8::value_type > &  src,
matrix< channel8::value_type > &  dest 
) const [virtual]

operates on a copy of the given parameters (channel of unsigned bytes)

Parameters:
src lti::channel8 with the source data.
dest lti::channel8, where the result will be left.
Returns:
true if successful, false otherwise.

Reimplemented in lti::convolution.

virtual bool lti::modifier::apply ( const imatrix src,
imatrix dest 
) const [virtual]

operates on a copy of the given parameters (matrix of integers)

Parameters:
src matrix of integers with the source data.
dest matrix of integers, where the result will be left.
Returns:
true if successful, false otherwise.

Reimplemented in lti::fastRelabeling, lti::filledUpsampling, and lti::scaling.

virtual bool lti::modifier::apply ( const channel src,
channel dest 
) const [virtual]
virtual bool lti::modifier::apply ( const matrix< channel::value_type > &  src,
matrix< channel::value_type > &  dest 
) const [virtual]

operates on a copy of the given parameters (channel)

Parameters:
src lti::channel with the source data.
dest channel, where the result will be left.
Returns:
true if successful, false otherwise.

Reimplemented in lti::convolution, lti::correlation, lti::downsampling, lti::flipImage, lti::rotation, and lti::scaling.

virtual bool lti::modifier::apply ( const vector< ubyte > &  src,
vector< ubyte > &  dest 
) const [virtual]

operates on a copy of the given parameters (vector of unsigned bytes)

Parameters:
src vector of unsigned bytes with the source data.
dest vector of unsigned bytes, where the result will be left.
Returns:
true if successful, false otherwise.

Reimplemented in lti::histogramEqualization.

virtual bool lti::modifier::apply ( const ivector src,
ivector dest 
) const [virtual]

operates on a copy of the given parameters (vector of integers)

Parameters:
src vector of integers with the source data.
dest vector of integers, where the result will be left.
Returns:
true if successful, false otherwise.
virtual bool lti::modifier::apply ( const fvector src,
fvector dest 
) const [virtual]

operates on a copy of the given parameters (vector of floats)

Parameters:
src vector of floats with the source data.
dest vector of floats, where the result will be left.
Returns:
true if successful, false otherwise.

Reimplemented in lti::convolution, lti::correlation, lti::dilation, lti::downsampling, lti::erosion, lti::filledUpsampling, lti::histogramEqualization, and lti::upsampling.

virtual bool lti::modifier::apply ( image srcdest  )  const [virtual]

operates on the given image The image will be splitted in its RGB components, which will be operated with the fastest method, and the results will be merged again.

Parameters:
srcdest lti::image with the source data. The result will be left here.
Returns:
true if successful, false otherwise.

Reimplemented in lti::cannyEdges, lti::colorEdgesGS, lti::colorNormalizationBase, lti::comprehensiveColourNormalization, lti::convolution, lti::downsampling, lti::edgeDetector, lti::filledUpsampling, lti::grayWorldNormalization, lti::rotation, lti::scaling, and lti::susanEdges.

virtual bool lti::modifier::apply ( channel8 srcdest  )  const [virtual]
virtual bool lti::modifier::apply ( matrix< channel8::value_type > &  srcdest  )  const [virtual]

operates on the given parameter (channel of unsigned bytes).

If this method is not implemented an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest channel8 with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.

Reimplemented in lti::convolution.

virtual bool lti::modifier::apply ( imatrix srcdest  )  const [virtual]

operates on the given parameter (matrix of integers).

If this method is not implemented an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest matrix of integers with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.

Reimplemented in lti::fastRelabeling, lti::filledUpsampling, and lti::scaling.

virtual bool lti::modifier::apply ( channel srcdest  )  const [virtual]

operates on the given parameter (channel, i.e.

matrix of floats). If this method is not implemented, an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest channel with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.

Reimplemented in lti::cannyEdges, lti::colorEdgesGS, lti::cornerDetector, lti::dilation, lti::distanceTransform, lti::edgeDetector, lti::edgeSaliency, lti::erosion, lti::filledUpsampling, lti::harrisCorners, lti::histogramEqualization, lti::medianFilter, lti::morphology, lti::ogdFilter, lti::relativeThresholding, lti::susanCorners, lti::susanDenoise, lti::susanEdges, lti::thresholding, and lti::upsampling.

virtual bool lti::modifier::apply ( matrix< channel::value_type > &  srcdest  )  const [virtual]

operates on the given parameter (channel, i.e.

matrix of floats). If this method is not implemented, an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest channel with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.

Reimplemented in lti::convolution, lti::correlation, lti::downsampling, lti::flipImage, lti::rotation, and lti::scaling.

virtual bool lti::modifier::apply ( vector< ubyte > &  srcdest  )  const [virtual]

operates on the given parameter (vector of unsigned bytes).

If this method is not implemented, an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest vector of unsigned bytes with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.

Reimplemented in lti::histogramEqualization.

bool lti::modifier::apply ( ivector srcdest  )  const

operates on the given parameter (vector of integers).

If this method is not implemented, an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest vector of integers with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.
bool lti::modifier::apply ( fvector srcdest  )  const

operates on the given parameter (vector of floats).

If this method is not implemented, an exception of type lti::functor::invalidMethodException will be thrown.

Parameters:
srcdest vector of floats with the source data. The result will be left here too.
Returns:
true if successful, false otherwise.

Reimplemented in lti::convolution, lti::correlation, lti::dilation, lti::downsampling, lti::erosion, lti::filledUpsampling, lti::histogramEqualization, and lti::upsampling.

parameters& lti::modifier::getParameters (  )  [protected]

non const getParameters()

Reimplemented from lti::functor.

Reimplemented in lti::kNearestNeighFilter.

const parameters& lti::modifier::getParameters (  )  const
virtual const char* lti::modifier::getTypeName (  )  const [virtual]

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

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