SoBilateralFilterProcessing

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.SoBilateralFilterProcessing

All Implemented Interfaces:

SafeDisposable
```
public class SoBilateralFilterProcessing
extends SoImageVizEngine
```
SoBilateralFilterProcessing engine. The SoBilateralFilterProcessing engine edge-preserving smoothing filter.
For an introduction to smoothing and denoising image filters, see section Image Filters.
This engine is an edge-preserving smoothing filter. The intensity value at each voxel in an image is replaced by a weighted average of intensity values from nearby pixels. Crucially the weights depend on distance in color space from the voxel in question. This preserves sharp edges by systematically excluding pixels across discontinuities from consideration:

where is a weighting similarity factor and is a local normalisation factor given by:

The greater is, the stronger the blur is.

: SoDespeckleProcessing, SoSigmaFilterProcessing, SoUnsharpMaskingProcessing.
File format/default:
BilateralFilterProcessing {
}

Library references: bilateralfilter bilateralfilter3d

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SoBilateralFilterProcessing.FilterModes
- 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<SoBilateralFilterProcessing.FilterModes>`	`filterMode`	The filter type.
`SoSFImageDataAdapter`	`inImage`	The input image.
`SoSFVec3i32`	`kernelSize`	The kernel size in each direction (odd value).
`SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter>`	`outImage`	The output image.
`SoSFFloat`	`similarity`	The photometric similarity (strictly positive value).

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

SoBilateralFilterProcessing()
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
  - kernelSize
```
public final SoSFVec3i32 kernelSize
```
    The kernel size in each direction (odd value). Default value is SbVec3i32(3,3,3)
  - inImage
```
public final SoSFImageDataAdapter inImage
```
    The input image. Default value is NULL. Supported types include: grayscale binary label color image.
  - similarity
```
public final SoSFFloat similarity
```
    The photometric similarity (strictly positive value). Default value is 20.0f.
  - filterMode
```
public final SoSFEnum<SoBilateralFilterProcessing.FilterModes> filterMode
```
    The filter type. . Default is BILATERAL
  - outImage
```
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outImage
```
    The output image. Default value is NULL. Supported types include: grayscale binary label color image.
- Constructor Detail
  - SoBilateralFilterProcessing
```
public SoBilateralFilterProcessing()
```
    Constructor.