vetFilterNoiseChannel Class Reference

Inheritance diagram for vetFilterNoiseChannel:

Public Member Functions
	vetFilterNoiseChannel (vetFilterNoiseChannelParameters *initParams=NULL)
	Default constructor, initialize parameters and superclasses.
	~vetFilterNoiseChannel ()
	Default destructor, free buffer.
VETRESULT	setParameters (vetFilterNoiseChannelParameters *initParams)
	Set parameters for this filter.
vetFilterNoiseChannelParameters &	getParameters ()
	Get parameters for this filter.
VETRESULT	setFilterParameters (vetFilterNoiseChannelParameters *initParams)
	Set parameters for this filter.
vetFilterParameters *	getFilterParameters ()
	Get parameters for this filter.
VETRESULT	reset ()
	Reset buffers and parameters.
VETRESULT	setNoiseSource (vetInput &frameSource)
void	resetNoiseSource ()
VETRESULT	AddNoise (vetFrameYUV420 &img)
VETRESULT	AddNoise (vetFrameRGB24 &img)
VETRESULT	AddNoise (vetFrameT< unsigned char > &img)
VETRESULT	MultiplyNoise (vetFrameYUV420 &img)
VETRESULT	MultiplyNoise (vetFrameRGB24 &img)
VETRESULT	MultiplyNoise (vetFrameT< unsigned char > &img)
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 Member Functions
void	generateNoise (vetFrameYUV420 &img, unsigned char zero)
void	generateNoise (vetFrameRGB24 &img, PixelRGB24 zero)
void	generateNoise (vetFrameT< unsigned char > &img, unsigned char zero)
Protected Attributes
vetFilterNoiseChannelParameters *	myParams
	Current parameters.
vetInput *	externalSource
PixelRGB24	zeroRGB
PixelRGB24	oneRGB
unsigned char	zeroChar
unsigned char	oneChar

---

Detailed Description

Definition at line 83 of file vetFilterNoiseChannel.h.

---

Constructor & Destructor Documentation

vetFilterNoiseChannel::vetFilterNoiseChannel (  vetFilterNoiseChannelParameters *  initParams = NULL  )

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

---

Member Function Documentation

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

Get parameters for this filter. Returns: pointer to vetFilterNoiseChannelParameters instance. Implements vetFilter. Definition at line 161 of file vetFilterNoiseChannel.h. References myParams.

vetFilterNoiseChannelParameters& vetFilterNoiseChannel::getParameters (   )  [inline]

Get parameters for this filter. Returns: pointer to vetFilterNoiseChannelParameters instance. Definition at line 135 of file vetFilterNoiseChannel.h. References myParams.

VETRESULT vetFilterNoiseChannel::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 405 of file vetFilterNoiseChannel.cpp. References AddNoise(), INFO, MultiplyNoise(), myParams, vetFilterNoiseChannelParameters::operation, and VETRET_OK.

VETRESULT vetFilterNoiseChannel::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 383 of file vetFilterNoiseChannel.cpp. References AddNoise(), INFO, MultiplyNoise(), myParams, vetFilterNoiseChannelParameters::operation, and VETRET_OK.

VETRESULT vetFilterNoiseChannel::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 361 of file vetFilterNoiseChannel.cpp. References AddNoise(), INFO, MultiplyNoise(), myParams, vetFilterNoiseChannelParameters::operation, and VETRET_OK.

VETRESULT vetFilterNoiseChannel::reset (   )  [virtual]

Reset buffers and parameters. Returns: VETRET_OK Implements vetFilter. Definition at line 89 of file vetFilterNoiseChannel.cpp. References vetFilter::allocateBuffer(), vetFilterParameters::currentBuffer, externalSource, INFO, myParams, vetFilter::releaseBuffers(), vetFilterNoiseChannelParameters::reset(), resetNoiseSource(), setParameters(), and VETRET_OK. Referenced by vetFilterNoiseChannel().

VETRESULT vetFilterNoiseChannel::setFilterParameters (  vetFilterNoiseChannelParameters *  initParams  )  [inline]

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

VETRESULT vetFilterNoiseChannel::setParameters (  vetFilterNoiseChannelParameters *  initParams  )

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

---

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

• vetFilterNoiseChannel.h
• vetFilterNoiseChannel.cpp

---