vetDigitalFilter Class Reference

Inheritance diagram for vetDigitalFilter:

Public Member Functions
	vetDigitalFilter (vetDigitalFilterParameters *initParams=NULL)
	Default constructor, initialize parameters and superclasses.
	~vetDigitalFilter ()
	Default destructor, free buffer.
VETRESULT	setParameters (vetDigitalFilterParameters *initParams)
	Set parameters for this filter.
vetDigitalFilterParameters &	getParameters ()
	Get parameters for this filter.
VETRESULT	setFilterParameters (vetFilterParameters *initParams)
	Set parameters for this filter.
vetFilterParameters *	getFilterParameters ()
	Get parameters for this filter.
VETRESULT	reset ()
	Reset buffers and parameters.
VETRESULT	setDefaultKernel (int index)
VETRESULT	importFrom (vetFrameYUV420 &img)
	Inherited class must implement this function, processing frames to specific output (device or stream).
VETRESULT	importFrom (vetFrameRGB24 &img)
	Inherited class must implement this function, processing frames to specific output (device or stream).
VETRESULT	importFrom (vetFrameT< unsigned char > &img)
	Inherited class must implement this function, processing frames to specific output (device or stream).
Static Public Member Functions
template<class T, class S>
static int	doProcessing (vetFrameT< T > &source, vetFrameT< S > &dest, vetDFMatrix &kernel)
static int	doProcessing (vetFrameRGB24 &source, vetFrameRGB24 &dest, vetDFMatrix &kernel, bool clamp=true)
static int	doProcessing (vetFrameYUV420 &source, vetFrameYUV420 &dest, vetDFMatrix &kernel, bool clamp=true)
static int	doProcessing (vetFrameT< unsigned char > &source, vetFrameT< unsigned char > &dest, vetDFMatrix &kernel, bool clamp=true)
static int	doRotateKernel (vetDFMatrix &kernel)
Protected Attributes
vetDigitalFilterParameters *	myParams

---

Detailed Description

Definition at line 75 of file vetDigitalFilter.h.

---

Constructor & Destructor Documentation

vetDigitalFilter::vetDigitalFilter (  vetDigitalFilterParameters *  initParams = NULL  )

Default constructor, initialize parameters and superclasses. Parameters: [in]  initParams  parameters for this module or NULL for defaults. Definition at line 27 of file vetDigitalFilter.cpp. References reset(), vetObject::setDescription(), vetObject::setName(), setParameters(), and vetObject::setVersion().

---

Member Function Documentation

vetFilterParameters* vetDigitalFilter::getFilterParameters (   )  [inline, virtual]

Get parameters for this filter. Returns: pointer to vetDigitalFilterParameters instance. Implements vetFilter. Definition at line 139 of file vetDigitalFilter.h. References myParams.

vetDigitalFilterParameters& vetDigitalFilter::getParameters (   )  [inline]

Get parameters for this filter. Returns: pointer to vetDigitalFilterParameters instance. Definition at line 112 of file vetDigitalFilter.h. References myParams.

VETRESULT vetDigitalFilter::importFrom (  vetFrameT< unsigned char > &  img  )  [virtual]

Inherited class must implement this function, processing frames to specific output (device or stream). Parameters: [in]  img  Greyscale VETLib Frame to be processed (encoded for example) Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameT&) Implements vetFilter. Definition at line 149 of file vetDigitalFilter.cpp. References DEBUGMSG, myParams, and VETRET_NOT_IMPLEMENTED.

VETRESULT vetDigitalFilter::importFrom (  vetFrameRGB24 &  img  )  [virtual]

Inherited class must implement this function, processing frames to specific output (device or stream). Parameters: [in]  img  VETLib Cache24 Frame to be processed (encoded for example) Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameRGB24&) Implements vetFilter. Definition at line 125 of file vetDigitalFilter.cpp. References vetFilter::bufferRGB, vetDigitalFilterParameters::clampNegative, vetDigitalFilterParameters::currentKernel, DEBUGMSG, doProcessing(), vetFrame::height, vetFilter::isBufferRGB(), myParams, vetFilter::useBufferRGB(), VETRET_OK, VETRET_OK_DEPRECATED, and vetFrame::width.

VETRESULT vetDigitalFilter::importFrom (  vetFrameYUV420 &  img  )  [virtual]

Inherited class must implement this function, processing frames to specific output (device or stream). Parameters: [in]  img  VETLib Cache Frame to be processed (encoded for example) Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameYUV420&) Implements vetFilter. Definition at line 102 of file vetDigitalFilter.cpp. References vetFilter::bufferYUV, vetDigitalFilterParameters::clampNegative, vetDigitalFilterParameters::currentKernel, DEBUGMSG, doProcessing(), vetFrame::height, vetFilter::isBufferYUV(), myParams, vetFilter::useBufferYUV(), VETRET_OK, VETRET_OK_DEPRECATED, and vetFrame::width.

VETRESULT vetDigitalFilter::reset (   )  [virtual]

Reset buffers and parameters. Returns: VETRET_OK Implements vetFilter. Definition at line 50 of file vetDigitalFilter.cpp. References vetFilter::allocateBuffer(), vetFilterParameters::currentBuffer, INFO, myParams, vetFilter::releaseBuffers(), vetDigitalFilterParameters::reset(), setParameters(), and VETRET_OK. Referenced by vetDigitalFilter().

VETRESULT vetDigitalFilter::setFilterParameters (  vetFilterParameters *  initParams  )  [inline, virtual]

Set parameters for this filter. Parameters: [in]  initParams  Instance of vetDigitalFilterParameters or NULL, NULL argument make function to create a new instance with default parameters. Returns: VETRET_OK Implements vetFilter. Definition at line 124 of file vetDigitalFilter.h. References setParameters().

VETRESULT vetDigitalFilter::setParameters (  vetDigitalFilterParameters *  initParams  )

Set parameters for this filter. Parameters: [in]  initParams  Instance of vetDigitalFilterParameters or NULL, NULL argument make function to create a new instance with default parameters. Returns: VETRET_OK Definition at line 69 of file vetDigitalFilter.cpp. References vetFilter::allocateBuffer(), vetFilterParameters::currentBuffer, myParams, and VETRET_OK. Referenced by reset(), setFilterParameters(), and vetDigitalFilter().

---

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

• vetDigitalFilter.h
• vetDigitalFilter.cpp

---