cvr::functor Class Reference

Base class for all lti functors. More...

#include <cvrFunctor.h>

Inheritance diagram for cvr::functor:

[legend]

Collaboration diagram for cvr::functor:

[legend]

List of all members.

Classes
class	parameters
	Parameters class of functor is empty and abstract. More...
Public Member Functions
	functor ()
	functor (const functor &other)
virtual	~functor ()
functor &	copy (const functor &other)
virtual const std::string &	name () const =0
virtual functor *	clone () const =0
virtual functor *	newInstance () const =0
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)

---

Detailed Description

Base class for all lti functors.

Every lti fuctor must have at least the member apply(), which "applies" the functor's functionality on the data given through the arguments of the apply method.

There are two kinds of apply methods:

• the "on-copy"-apply returns the result in a new object, and the original data will not be modified.
• the "on-place"-apply returns the result on the same input object and therefore the original data will be destroyed.

The operation of the functor can be controled with some parameters, which will can be set with the "setParameters" member-function.

Each functor may have also other setABC() members, to allow the change of just one parameter-item at the time.

---

Constructor & Destructor Documentation

cvr::functor::functor

(

)

Default constructor.

cvr::functor::functor

(

const functor &

other

)

Copy constructor.

virtual cvr::functor::~functor

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual functor* cvr::functor::clone

(

)

const [pure virtual]

Clone member.

Implements cvr::ioObject.

Implemented in cvr::bresenhamCircle, cvr::bresenhamLine, cvr::viewer2DPainter, cvr::bilinearInterpolation< T >, cvr::boundaryExpansion, cvr::colorQuantization, cvr::contrastEnhancement, cvr::convexHull, cvr::fastHessianDetection, cvr::filledUpsampling, cvr::genericInterpolation< T >, cvr::geometricTransformBase, cvr::geometricTransform< I >, cvr::histogramEqualization, cvr::integralImage, cvr::kMColorQuantization, cvr::labelAdjacencyMap, cvr::locationDetection, cvr::locationMatch, cvr::matrixTransform< I >, cvr::mergeHSIToImage, cvr::mergeImage, cvr::mergeRGBToImage, cvr::mergeYCbCrToImage, cvr::mergeYIQToImage, cvr::mergeYPbPrToImage, cvr::mergeYUVToImage, cvr::nearestNeighborInterpolation< T >, cvr::splitImage, cvr::splitImageToHSI, cvr::splitImageToRGB, cvr::splitImageTorgI, cvr::splitImageToYCbCr, cvr::splitImageToYIQ, cvr::splitImageToYPbPr, cvr::splitImageToYUV, cvr::surfLocalDescriptor, cvr::usePalette, cvr::affineTransformation2D, cvr::distanceFunctor< T >, cvr::euclideanDistanceFunctor< T >, cvr::euclideanTransformation2D, cvr::linearLeastSquares, cvr::luDecomposition< T >, cvr::luSolution< T >, cvr::minimizeBasis, cvr::noise, cvr::normalDistribution, cvr::pca< T >, cvr::qrDecomposition< T >, cvr::qrSolution< T >, cvr::quickMedian, cvr::quickMedian2, cvr::quickPartialSort, cvr::randomDistribution, cvr::ransacEstimation< E >, cvr::secondOrderStatistics< T, U >, cvr::similarityTransformation2D, cvr::sort, cvr::sort2, cvr::svd, cvr::symmetricEigenSystem< T >, cvr::uniformContinuousDistribution, cvr::uniformDiscreteDistribution, cvr::univariateContinuousDistribution, cvr::univariateDiscreteDistribution, cvr::validator, cvr::geometricTransform< I >, and cvr::distanceFunctor< T >.

functor& cvr::functor::copy

(

const functor &

other

)

Copy data of "other" functor.

Please note that the status string will _NOT_ be copied!

virtual const std::string& cvr::functor::name

(

)

const [pure virtual]

Returns the name of this class.

Implements cvr::ioObject.

Implemented in cvr::bresenhamCircle, cvr::bresenhamLine, cvr::viewer2DPainter, cvr::bilinearInterpolation< T >, cvr::boundaryExpansion, cvr::colorQuantization, cvr::contrastEnhancement, cvr::convexHull, cvr::fastHessianDetection, cvr::filledUpsampling, cvr::genericInterpolation< T >, cvr::geometricTransformBase, cvr::geometricTransform< I >, cvr::histogramEqualization, cvr::integralImage, cvr::kMColorQuantization, cvr::labelAdjacencyMap, cvr::locationDetection, cvr::locationMatch, cvr::matrixTransform< I >, cvr::mergeHSIToImage, cvr::mergeRGBToImage, cvr::mergeYCbCrToImage, cvr::mergeYIQToImage, cvr::mergeYPbPrToImage, cvr::mergeYUVToImage, cvr::nearestNeighborInterpolation< T >, cvr::splitImageToHSI, cvr::splitImageToRGB, cvr::splitImageTorgI, cvr::splitImageToYCbCr, cvr::splitImageToYIQ, cvr::splitImageToYPbPr, cvr::splitImageToYUV, cvr::surfLocalDescriptor, cvr::usePalette, cvr::affineTransformation2D, cvr::decompositionSolution< T >, cvr::distanceFunctor< T >, cvr::euclideanDistanceFunctor< T >, cvr::euclideanTransformation2D, cvr::fixedGridInterpolation< T >, cvr::linearLeastSquares, cvr::luDecomposition< T >, cvr::luSolution< T >, cvr::minimizeBasis, cvr::noise, cvr::normalDistribution, cvr::pca< T >, cvr::qrDecomposition< T >, cvr::qrSolution< T >, cvr::quickMedian, cvr::quickMedian2, cvr::quickPartialSort, cvr::randomDistribution, cvr::ransacEstimation< E >, cvr::secondOrderStatistics< T, U >, cvr::similarityTransformation2D, cvr::sort, cvr::sort2, cvr::svd, cvr::symmetricEigenSystem< T >, cvr::uniformContinuousDistribution, cvr::uniformDiscreteDistribution, cvr::univariateContinuousDistribution, cvr::validator, cvr::geometricTransform< I >, cvr::decompositionSolution< T >, cvr::distanceFunctor< T >, and cvr::fixedGridInterpolation< T >.

virtual functor* cvr::functor::newInstance

(

)

const [pure virtual]

Create new instance.

Implements cvr::ioObject.

Implemented in cvr::bresenhamCircle, cvr::bresenhamLine, cvr::viewer2DPainter, cvr::bilinearInterpolation< T >, cvr::boundaryExpansion, cvr::colorQuantization, cvr::contrastEnhancement, cvr::convexHull, cvr::fastHessianDetection, cvr::filledUpsampling, cvr::genericInterpolation< T >, cvr::geometricTransformBase, cvr::geometricTransform< I >, cvr::histogramEqualization, cvr::integralImage, cvr::kMColorQuantization, cvr::labelAdjacencyMap, cvr::locationDetection, cvr::locationMatch, cvr::matrixTransform< I >, cvr::mergeHSIToImage, cvr::mergeImage, cvr::mergeRGBToImage, cvr::mergeYCbCrToImage, cvr::mergeYIQToImage, cvr::mergeYPbPrToImage, cvr::mergeYUVToImage, cvr::nearestNeighborInterpolation< T >, cvr::splitImage, cvr::splitImageToHSI, cvr::splitImageToRGB, cvr::splitImageTorgI, cvr::splitImageToYCbCr, cvr::splitImageToYIQ, cvr::splitImageToYPbPr, cvr::splitImageToYUV, cvr::surfLocalDescriptor, cvr::usePalette, cvr::affineTransformation2D, cvr::distanceFunctor< T >, cvr::euclideanDistanceFunctor< T >, cvr::euclideanTransformation2D, cvr::linearLeastSquares, cvr::luDecomposition< T >, cvr::luSolution< T >, cvr::minimizeBasis, cvr::noise, cvr::normalDistribution, cvr::pca< T >, cvr::qrDecomposition< T >, cvr::qrSolution< T >, cvr::quickMedian, cvr::quickMedian2, cvr::quickPartialSort, cvr::randomDistribution, cvr::ransacEstimation< E >, cvr::secondOrderStatistics< T, U >, cvr::similarityTransformation2D, cvr::sort, cvr::sort2, cvr::svd, cvr::symmetricEigenSystem< T >, cvr::uniformContinuousDistribution, cvr::uniformDiscreteDistribution, cvr::univariateContinuousDistribution, cvr::univariateDiscreteDistribution, cvr::validator, cvr::geometricTransform< I >, and cvr::distanceFunctor< T >.

virtual bool cvr::functor::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parametersManager from the given ioHandler.

The default implementation is to read just the parameters object.

Since this virtual method needs to know the exact type of the parameters to call the proper read method, it will just assume that the current parametersManager instance has a valid, consistent parameter set. If this is not the case, you need to reimplement the read method to set first a dummy parameter object or the correct type.

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 cvr::parametersManager.

Reimplemented in cvr::pca< T >, and cvr::randomDistribution.

virtual bool cvr::functor::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parametersManager in the given ioHandler.

The default implementation is to write just the parameters object.

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 cvr::parametersManager.

Reimplemented in cvr::pca< T >, and cvr::randomDistribution.

---

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

• cvrFunctor.h