rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvGaussianBlurFilter Class Reference

Gaussian Blur filter. More...

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

Inheritance diagram for IlvGaussianBlurFilter:
IlvBitmapFilter

List of all members.

Public Member Functions

 IlvGaussianBlurFilter (IlFloat deviationX=1.0, IlFloat deviationY=1.0)
 Constructor.
 ~IlvGaussianBlurFilter ()
 Destructor.
IlvBitmapDataapply (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.
IlFloat getDeviationY () const
 Returns the deviation in the y direction.
IlUInt getRadiusX () const
 Returns the kernel radius in the x direction.
IlUInt getRadiusY () const
 Returns the kernel radius in the y direction.
void setDeviationX (IlFloat deviation)
 Sets the deviation value in the x direction.
void setDeviationY (IlFloat deviation)
 Sets the deviation value in the y direction.

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 ( 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 (  ) 

Destructor.

The destructor releases all the memory used by the instance.


Member Function Documentation

IlFloat IlvGaussianBlurFilter::getDeviationX (  )  const

Returns the deviation in the x direction.

Returns:
The deviation in the x direction.
IlFloat IlvGaussianBlurFilter::getDeviationY (  )  const

Returns the deviation in the y direction.

Returns:
The deviation in the y direction.
IlUInt IlvGaussianBlurFilter::getRadiusX (  )  const

Returns the kernel radius in the x direction.

Returns:
The kernel radius in the x direction.
IlUInt IlvGaussianBlurFilter::getRadiusY (  )  const

Returns the kernel radius in the y direction.

Returns:
The kernel radius in the y direction.
void IlvGaussianBlurFilter::setDeviationX ( IlFloat  deviation  ) 

Sets the deviation value in the x direction.

Parameters:
deviation The new deviation value.
void IlvGaussianBlurFilter::setDeviationY ( IlFloat  deviation  ) 

Sets the deviation value in the y direction.

Parameters:
deviation The new deviation value.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.