| SoBilateralFilterProcessing Class |
OIV.ImageViz.Engines.ImageFiltering.SmoothingAndDenoising.SoBilateralFilterProcessing engine.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.ImageFiltering.SmoothingAndDenoisingSoBilateralFilterProcessing
Namespace: OIV.ImageViz.Engines.ImageFiltering.SmoothingAndDenoising
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoBilateralFilterProcessing type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoBilateralFilterProcessing | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AbortEvaluate | Abort current processing as soon as possible. |
| Copy | Creates and returns an exact copy of the engine. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetName | Returns the name of an instance. |
| GetOutput | Returns a reference to the engine output with the given name. |
| GetOutputName | Returns (in outputName) the name of the engine output (output). |
| GetOutputs | Returns a list of outputs in this engine. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsEvaluating | Returns true if the engine evaluation is in progress. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| StartEvaluate | Evaluate engine and dependencies in another thread without blocking the current one. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| WaitEvaluate | Wait for the end of engine evaluation. |
Properties| Name | Description | |
|---|---|---|
 | computeMode | Select the compute Mode (2D or 3D or AUTO) . |
| filterMode | The filter type. |
| inImage | The input image. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| kernelSize | The kernel size in each direction (odd value). |
| outImage | The output image. |
| similarity | The photometric similarity (strictly positive value). |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Events| Name | Description | |
|---|---|---|
 | OnBegin | Event raised when the processing begins. |
| OnEnd | Event raised when processing ends and the result is available. |
| OnProgress | Event raised while processing is running. |
RemarksThe OIV.ImageViz.Engines.ImageFiltering.SmoothingAndDenoising.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.
FILE FORMAT/DEFAULT
BilateralFilterProcessing {
| computeMode | MODE_AUTO |
| kernelSize | 3 3 3 |
| inImage | NULL |
| similarity | 20.0f |
| filterMode | BILATERAL |
Library references: bilateralfilter bilateralfilter3d
See Also