Package com.openinventor.imageviz.engines.imagefiltering.smoothinganddenoising

Class SoGaussianBlurFilterProcessing

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.engines.SoEngine

com.openinventor.imageviz.engines.SoImageVizEngine

com.openinventor.imageviz.engines.imagefiltering.smoothinganddenoising.SoGaussianBlurFilterProcessing

All Implemented Interfaces:

SafeDisposable

public class SoGaussianBlurFilterProcessing
extends SoImageVizEngine

SoGaussianBlurFilterProcessing engine. The SoGaussianBlurFilterProcessing performs a Gaussian filter using either a separable or a recursive filter.

The SEPARABLE mode is based on a Finite Impulse Response algorithm applied in separable way (a two-dimensional convolution separated in two one-dimensional filters). Using this mode, the computation time is proportional to the kernel size.
The RECURSIVE mode is the recursive mode, based on an Infinite Impulse Response algorithm. This mode computes the sum of one causal and one anti-causal filter where previous results are used to compute next. Using this mode, the computation time is independent of the standard deviation.

See Also:

SoBoxFilterProcessing, SoMedianFilterProcessing File format/default: GaussianBlurFilterProcessing { computeMode MODE_AUTO inImage NULL filterMode RECURSIVE standardDeviation 1.0f 1.0f 1.0f kernelSizeFactor 2.0f outputType SAME_AS_INPUT } Library references: gaussfilter gaussfilter3d

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SoGaussianBlurFilterProcessing.FilterModes
static class	SoGaussianBlurFilterProcessing.OutputTypes

Nested classes/interfaces inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

SoImageVizEngine.ComputeModes, SoImageVizEngine.EventArg, SoImageVizEngine.Neighborhood3ds

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field	Description
SoSFEnum<SoImageVizEngine.ComputeModes>	computeMode	Select the compute Mode (2D or 3D or AUTO) .
SoSFEnum<SoGaussianBlurFilterProcessing.FilterModes>	filterMode	Define the algorithm used to compute the gaussian filter.
SoSFImageDataAdapter	inImage	Input image.
SoSFFloat	kernelSizeFactor	This parameter is used to compute the size of the kernel applied in the SEPARABLE mode.
SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter>	outImage	Output image.
SoSFEnum<SoGaussianBlurFilterProcessing.OutputTypes>	outputType	Define the output type.
SoSFVec3f	standardDeviation	The standard deviation value for each direction (X, Y, Z).

Fields inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

onBegin, onEnd, onProgress

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor	Description
SoGaussianBlurFilterProcessing()	Constructor.

Method Summary

Methods inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

abortEvaluate, isEvaluating, startEvaluate, waitEvaluate

Methods inherited from class com.openinventor.inventor.engines.SoEngine

copy, getByName, getOutput, getOutputName

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

computeMode

public final SoSFEnum<SoImageVizEngine.ComputeModes> computeMode

Select the compute Mode (2D or 3D or AUTO) . Default is MODE_AUTO

inImage

public final SoSFImageDataAdapter inImage

Input image. The type of image can be integer or float. Default value is NULL. Supported types include: grayscale image.

filterMode

public final SoSFEnum<SoGaussianBlurFilterProcessing.FilterModes> filterMode

Define the algorithm used to compute the gaussian filter. SEPARABLE mode will use a Finite Impulse Response algorithm on X, Y and Z directions. RECURSIVE mode will use an Infinite Impulse Response algorithm on X, Y and Z directions. . Default is RECURSIVE

standardDeviation

public final SoSFVec3f standardDeviation

The standard deviation value for each direction (X, Y, Z). Each value must be greater than 0.0. Default value is SbVec3f(1.0f,1.0f,1.0f).

kernelSizeFactor

public final SoSFFloat kernelSizeFactor

This parameter is used to compute the size of the kernel applied in the SEPARABLE mode. The kernel size value will be twice the kernelSizeFactor multiplied by the standard deviation associated to the axe. If the resulting kernel size is even, it is incremented by one in order to ensure an odd kernel size. This parameter is ignored in RECURSIVE mode. Default value is 2.0f.

outputType

public final SoSFEnum<SoGaussianBlurFilterProcessing.OutputTypes> outputType

Define the output type. It can either be SAME_AS_INPUT to keep the input type or FLOATING_POINT to force the output to float. In the case of integer images, keeping the same output type can lead to a loss of precision. In the case of floating images, this parameter has no effect. . Default is SAME_AS_INPUT

outImage

public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outImage

Output image. Size, calibration and interpretation of the output image are forced to the same values as the input. Default value is NULL. Supported types include: grayscale image.

Constructor Detail

SoGaussianBlurFilterProcessing

public SoGaussianBlurFilterProcessing()

Constructor.