SoBoxFilterProcessing

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

All Implemented Interfaces:

SafeDisposable
```
public class SoBoxFilterProcessing
extends SoImageVizEngine
```
SoBoxFilterProcessing engine. The SoBoxFilterProcessing engine smooths an image using a box kernel.
For an introduction to image filters, see section Images Filters.
This engine performs a lowpass filter using the same box kernel as a lowpass filter. Yet, with this module, size in X, Y and Z may be different and larger than 7.
The algorithm calculates the local mean in a given size window. In the 3-D case, for a window of size 2p+1 in X, 2q+1 in Y and 2r+1 in Z:

The K coefficient is the Normalization coefficient:
- K = 1 if you do not wish to Normalize the result;
- K = otherwise.
See Also:

SoRecursiveExponentialFilterProcessing File format/default: BoxFilterProcessing { computeMode MODE_AUTO kernelSize 3 3 3 inImage NULL autoScale true } Library references: boxfilter boxfilter3d

Nested Class Summary
- 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
`SoSFBool`	`autoScale`	Select the automatic intensity scaling mode.
`SoSFEnum<SoImageVizEngine.ComputeModes>`	`computeMode`	Select the compute Mode (2D or 3D or AUTO) .
`SoSFImageDataAdapter`	`inImage`	The input grayscale image.
`SoSFVec3i32`	`kernelSize`	The kernel size in each direction.
`SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter>`	`outImage`	The output image.

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

SoBoxFilterProcessing()
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. Default value is SbVec3i32(3,3,3)
  - inImage
```
public final SoSFImageDataAdapter inImage
```
    The input grayscale image. Default value is NULL. Supported types include: grayscale binary label image.
  - autoScale
```
public final SoSFBool autoScale
```
    Select the automatic intensity scaling mode. Default value is true.
  - outImage
```
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outImage
```
    The output image. Default value is NULL. Supported types include: grayscale binary label color image.
- Constructor Detail
  - SoBoxFilterProcessing
```
public SoBoxFilterProcessing()
```
    Constructor.