Click or drag to resize
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 Hierarchy

Namespace: OIV.ImageViz.Engines.ArithmeticAndLogic.ArithmeticOperations
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoImageFormulaProcessing : SoImageVizEngine

The SoImageFormulaProcessing type exposes the following members.

Constructors
  NameDescription
Public methodSoImageFormulaProcessing

Constructor.

Top
Methods
  NameDescription
Public methodAbortEvaluate

Abort current processing as soon as possible.

(Inherited from SoImageVizEngine.)
Public methodCopy

Creates and returns an exact copy of the engine.

(Inherited from SoEngine.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetOutput

Returns a reference to the engine output with the given name.

(Inherited from SoEngine.)
Public methodGetOutputName

Returns (in outputName) the name of the engine output (output).

(Inherited from SoEngine.)
Public methodGetOutputs

Returns a list of outputs in this engine.

(Inherited from SoEngine.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsEvaluating

Returns true if the engine evaluation is in progress.

(Inherited from SoImageVizEngine.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodStartEvaluate

Evaluate engine and dependencies in another thread without blocking the current one.

(Inherited from SoImageVizEngine.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Public methodWaitEvaluate

Wait for the end of engine evaluation.

(Inherited from SoImageVizEngine.)
Top
Properties
  NameDescription
Public propertycomputeMode

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

Public propertydataType

Arithmetic format.

Public propertyinFormula

Formula to apply on image(s).

Public propertyinImage

The input image.

Public propertyinImage2

Optional image : enter image or let field empty.

Public propertyinImage3

Optional image : enter image or let field empty.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyoutImage

The output image.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Events
  NameDescription
Public eventOnBegin

Event raised when the processing begins.

(Inherited from SoImageVizEngine.)
Public eventOnEnd

Event raised when processing ends and the result is available.

(Inherited from SoImageVizEngine.)
Public eventOnProgress

Event raised while processing is running.

(Inherited from SoImageVizEngine.)
Top
Remarks

The 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)":

Coordinates can also be used to handle more complex case such as "if ((x- (ox+gx)/2)*(x-(ox+gx)/2)+(y-(oy+gy)/2)*(y-(oy+gy)/2)<=50*50, I1, I2)"

FILE FORMAT/DEFAULT

ImageFormulaProcessing {
computeMode MODE_AUTO
inImage NULL
inImage2 NULL
inImage3 NULL
inFormula ""
dataType UNSIGNED_CHAR
}

Library references: imageformula

See Also