| SoImageFormulaProcessing Class |
OIV.ImageViz.Engines.ArithmeticAndLogic.ArithmeticOperations.SoImageFormulaProcessing engine computes a new image combining one, two or three images using a given arithmetic formula.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.ArithmeticAndLogic.ArithmeticOperationsSoImageFormulaProcessing
Namespace: OIV.ImageViz.Engines.ArithmeticAndLogic.ArithmeticOperations
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoImageFormulaProcessing type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoImageFormulaProcessing | 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) . |
| dataType | Arithmetic format. |
| inFormula | Formula to apply on image(s). |
| inImage | The input image. |
| inImage2 | Optional image : enter image or let field empty. |
| inImage3 | Optional image : enter image or let field empty. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| outImage | The output image. |
| 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 formula used by this engine must be written according to the custom formula syntax.
Some of the examples below can be implemented with an existing engine. In these cases using the appropriate native engine will be more efficient in term of performance.
Basic usage
This engine accepts three input images which will be referenced as I1, I2 and I3 in the formula. Images two and three are optional and have to be provided if referenced in the formula.
For instance, the formula "if(I2==25, I1, 0)" allows to mask an input grey level image I1 with the blob of intensity 25 in a label image I2.
Usage with kernels
Functions with a variable number of arguments such as min, max, avg, median, sum and product can be used in two ways :
to combine images, for instance "min(I1, I2)"
to compute kernel operations : "min(I1[7, 7])"
Kernels can be defined for these function with the following syntax: IN[x,y] in 2d case and IN[x,y,z] in 3d case. Where N references the used image (in [1,3]), and x,y and z corresponds to the expected kernel size.
For instance, the formula "mean(I1[7, 7])" allows to filter an image I1 by a box filter of size 7x7.
Usage with offsets
Image offset can be defined in formula respecting following syntax : IN(x,y) in 2d case and IN(x,y,z) in 3d case. Where N references the used image (in [1,3]), and x,y and z corresponds to the offsets from the central current pixel. Symbols IN and IN(0,0) are strictly equivalent.
These offsets can be used to compute operations depending on pixels surrounding the current pixel to process.
For instance, a basic horizontal gradient operation can be written "I1(1, 0) - I1(-1, 0)"
Usage of image coordinates
Image coordinates can be used in a formula: x, y and z represent the current pixel coordinates, ox, oy and oz the image origin and gx, gy and gz the image size.
For instance, these coordinates can be used to generate synthetic images. A basic line separation can be written as "if (3*x-100<y, 100, 0)":
FILE FORMAT/DEFAULT
ImageFormulaProcessing {
| computeMode | MODE_AUTO |
| inImage | NULL |
| inImage2 | NULL |
| inImage3 | NULL |
| inFormula | "" |
| dataType | UNSIGNED_CHAR |
Library references: imageformula
See Also