vetFilterColor Class Reference

Inheritance diagram for vetFilterColor:

Public Member Functions
	vetFilterColor (vetFilterColorParameters *initParams=NULL)
	Default constructor, initialize parameters and superclasses.
	~vetFilterColor ()
	Default destructor, free buffer.
float	getFrameRate () const
	Read current frame rate (frame per second).
VETRESULT	setParameters (vetFilterColorParameters *initParams)
	Set parameters for this filter.
vetFilterColorParameters &	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	clamp (vetFrameRGB24 &img, unsigned int bpp)
VETRESULT	clamp (vetFrameYUV420 &img, unsigned int bpp)
VETRESULT	clamp (vetFrameT< unsigned char > &img, unsigned int bpp)
VETRESULT	invert (vetFrameRGB24 &img, unsigned int bpp)
VETRESULT	invert (vetFrameYUV420 &img, unsigned int bpp)
VETRESULT	invert (vetFrameT< unsigned char > &img, unsigned int bpp)
VETRESULT	extractBitPlane (vetFrameRGB24 &img, unsigned int bits=1)
VETRESULT	extractBitPlane (vetFrameYUV420 &img, unsigned int bits=1)
VETRESULT	extractBitPlane (vetFrameT< unsigned char > &img, unsigned int bits=1)
VETRESULT	importFrom (vetFrameYUV420 &img)
	Process the frame with current settings and store in buffer.
VETRESULT	importFrom (vetFrameRGB24 &img)
	Process the frame with current settings and store in buffer.
VETRESULT	importFrom (vetFrameT< unsigned char > &img)
	Process the frame with current settings and store in buffer.
Protected Attributes
vetFilterColorParameters *	myParams
	Current parameters.

---

Detailed Description

Definition at line 78 of file vetFilterColor.h.

---

Constructor & Destructor Documentation

vetFilterColor::vetFilterColor (  vetFilterColorParameters *  initParams = NULL  )

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

---

Member Function Documentation

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

Get parameters for this filter. Returns: pointer to vetFilterColorParameters instance. Implements vetFilter. Definition at line 148 of file vetFilterColor.h. References myParams.

float vetFilterColor::getFrameRate (   )  const [inline]

Read current frame rate (frame per second). Returns: Frame per second as a floating point value. (delay=1/fps) See also: v_sleeptime Reimplemented from vetInput. Definition at line 103 of file vetFilterColor.h.

vetFilterColorParameters& vetFilterColor::getParameters (   )  [inline]

Get parameters for this filter. Returns: pointer to vetFilterColorParameters instance. Definition at line 121 of file vetFilterColor.h. References myParams.

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

Process the frame with current settings and store in buffer. Parameters: [in]  img  VETLib Grayscale Frame to be processed. Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameT&) Implements vetFilter. Definition at line 194 of file vetFilterColor.cpp. References vetFilter::bufferTuC, clamp(), vetFilterColorParameters::currBits, vetFilterColorParameters::currBpp, DEBUGMSG, extractBitPlane(), vetFrameT< T >::height, invert(), vetFilter::isBufferTuC(), myParams, vetFrameT< T >::profile, vetFilterColorParameters::runMode, vetFilter::useBufferTuC(), VETRET_OK, VETRET_OK_DEPRECATED, VETRET_PARAM_ERR, and vetFrameT< T >::width.

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

Process the frame with current settings and store in buffer. Parameters: [in]  img  VETLib Cache24 Frame to be processed. Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameRGB24&) Implements vetFilter. Definition at line 150 of file vetFilterColor.cpp. References vetFilter::bufferRGB, clamp(), vetFilterColorParameters::currBits, vetFilterColorParameters::currBpp, DEBUGMSG, extractBitPlane(), vetFrame::height, invert(), vetFilter::isBufferRGB(), myParams, vetFilterColorParameters::runMode, vetFilter::useBufferRGB(), VETRET_OK, VETRET_OK_DEPRECATED, VETRET_PARAM_ERR, and vetFrame::width.

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

Process the frame with current settings and store in buffer. Parameters: [in]  img  VETLib Cache Frame to be processed. Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameYUV420&) Implements vetFilter. Definition at line 106 of file vetFilterColor.cpp. References vetFilter::bufferYUV, clamp(), vetFilterColorParameters::currBits, vetFilterColorParameters::currBpp, DEBUGMSG, extractBitPlane(), vetFrame::height, invert(), vetFilter::isBufferYUV(), myParams, vetFilterColorParameters::runMode, vetFilter::useBufferYUV(), VETRET_OK, VETRET_OK_DEPRECATED, VETRET_PARAM_ERR, and vetFrame::width.

VETRESULT vetFilterColor::reset (   )  [virtual]

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

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

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

VETRESULT vetFilterColor::setParameters (  vetFilterColorParameters *  initParams  )

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

---

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

• vetFilterColor.h
• vetFilterColor.cpp

---