IlvGaussianBlurFilter Class Reference

Gaussian Blur filter. More...

#include <ilviews/bitmaps/filters/gaussian.h>

Inheritance diagram for IlvGaussianBlurFilter:

Public Member Functions
	IlvGaussianBlurFilter (IlFloat deviationX=1.0, IlFloat deviationY=1.0)
	Constructor. More...
	~IlvGaussianBlurFilter ()
	Destructor. More...
IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **inputs=0)
	Applies the Gaussian Blur to the given image.
IlFloat	getDeviationX () const
	Returns the deviation in the x direction. More...
IlFloat	getDeviationY () const
	Returns the deviation in the y direction. More...
IlUInt	getRadiusX () const
	Returns the kernel radius in the x direction. More...
IlUInt	getRadiusY () const
	Returns the kernel radius in the y direction. More...
void	setDeviationX (IlFloat deviation)
	Sets the deviation value in the x direction. More...
void	setDeviationY (IlFloat deviation)
	Sets the deviation value in the y direction. More...
Public Member Functions inherited from IlvBitmapFilter
	IlvBitmapFilter ()
	Constructor. More...
virtual	~IlvBitmapFilter ()
	Destructor. More...
IlvBitmapData *	applyUnary (const IlvBitmapData *data)
	Convenience method for unary filters. More...
virtual const char *	getClassName () const
	Returns the class name of the filter. More...
IlUInt	getHeight () const
	Returns the height of the filter effect region. More...
const char *const *	getInputs (IlUInt &count) const
	Returns the name of the input bitmap data. More...
const char *	getName () const
	Returns the name of the filter. More...
IlUInt	getRefCount () const
	Returns the reference count for this instance.
const char *	getResult () const
	Returns the name of the result bitmap data. More...
IlUInt	getWidth () const
	Returns the width of the filter effect region. More...
IlInt	getX () const
	Returns the left coordinate of the filter effect region. More...
IlInt	getY () const
	Returns the top coordinate of the filter effect region. More...
void	lock ()
	Locks the current instance.
void	setHeight (IlUInt height)
	Sets the height of the filter effect region. More...
void	setInputs (IlUInt count, const char *const *name)
	Sets the input names of the filter. More...
void	setName (const char *id)
	Sets the name of the filter. More...
void	setResult (const char *name)
	Sets the result name of the filter. More...
void	setWidth (IlUInt width)
	Sets the width of the filter effect region. More...
void	setX (IlInt x)
	Sets the left coordinate of the filter effect region. More...
void	setY (IlInt y)
	Sets the top coordinate of the filter effect region. More...
void	unLock ()
	Unlocks the current instance. When the reference count is 0, the instance is deleted.
Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...
virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...
virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...
virtual void	getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const
	Retrieves the list of available accessors of an object. More...
virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...
virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvBitmapFilter
static IlvBitmapFilter *	Create (const char *classname, IlBoolean forceLoad=IlTrue)
	This static method creates an instance of a bitmap filter of given classname. If the filter class is not registered and forceLoad is IlTrue, an attempt to load a dynamic module for this filter is made. More...
static const char **	GetRegisteredFilters (IlUInt &num)
	This static method returns an array of registered filter class names. More...

Detailed Description

Gaussian Blur filter.

Library: ilvbmpflt

This bitmap filter lets you perform a Gaussian Blur on an image.

The Gaussian Blur kernel is an approximation of the normalized convolution: H(x) = exp(-x^x / (2 * s^s)) / sqrt(2 * pi * s^s) where s is the user-specified standard deviation. This filter is implemented as two successive horizontal and vertical kernels. Different deviations can be given for x and y directions.

See also

IlvRGBBitmapData, IlvBitmapFilter, IlvBitmapDataKernel, IlvConvolutionFilter

Constructor & Destructor Documentation

IlvGaussianBlurFilter()

IlvGaussianBlurFilter::IlvGaussianBlurFilter	(	IlFloat	deviationX = 1.0,
		IlFloat	deviationY = 1.0
	)

Constructor.

Initializes a new instance of the class IlvGaussianBlurFilter.

Parameters

deviationX	The deviation in the x direction.
deviationY	The deviation in the y direction.

~IlvGaussianBlurFilter()

IlvGaussianBlurFilter::~IlvGaussianBlurFilter

(

)

Destructor.

The destructor releases all the memory used by the instance.

Member Function Documentation

getDeviationX()

IlFloat IlvGaussianBlurFilter::getDeviationX

(

)

const

Returns the deviation in the x direction.

Returns

The deviation in the x direction.

getDeviationY()

IlFloat IlvGaussianBlurFilter::getDeviationY

(

)

const

Returns the deviation in the y direction.

Returns

The deviation in the y direction.

getRadiusX()

IlUInt IlvGaussianBlurFilter::getRadiusX

(

)

const

Returns the kernel radius in the x direction.

Returns

The kernel radius in the x direction.

getRadiusY()

IlUInt IlvGaussianBlurFilter::getRadiusY

(

)

const

Returns the kernel radius in the y direction.

Returns

The kernel radius in the y direction.

setDeviationX()

void IlvGaussianBlurFilter::setDeviationX

(

IlFloat

deviation

)

Sets the deviation value in the x direction.

Parameters

deviation

The new deviation value.

setDeviationY()

void IlvGaussianBlurFilter::setDeviationY

(

IlFloat

deviation

)

Sets the deviation value in the y direction.

Parameters

deviation

The new deviation value.