com.openinventor.imageviz.engines.arithmeticandlogic.arithmeticoperations

Class SoImageFormulaProcessing

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.arithmeticandlogic.arithmeticoperations.SoImageFormulaProcessing

All Implemented Interfaces:

SafeDisposable

public class SoImageFormulaProcessing
extends SoImageVizEngine

SoImageFormulaProcessing engine computes a new image combining one, two or three images using a given arithmetic formula. 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoImageFormulaProcessing.DataTypes

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 and Description
static int	BINARY Deprecated. Use SoImageFormulaProcessing.DataTypes.BINARY instead.
SoSFEnum<SoImageVizEngine.ComputeModes>	computeMode Select the compute Mode (2D or 3D or AUTO) .
SoSFEnum<SoImageFormulaProcessing.DataTypes>	dataType Arithmetic format.
static int	FLOATING_POINT Deprecated. Use SoImageFormulaProcessing.DataTypes.FLOATING_POINT instead.
SoSFString	inFormula Formula to apply on image(s).
SoSFImageDataAdapter	inImage The input image.
SoSFImageDataAdapter	inImage2 Optional image : enter image or let field empty.
SoSFImageDataAdapter	inImage3 Optional image : enter image or let field empty.
static int	LABEL Deprecated. Use SoImageFormulaProcessing.DataTypes.LABEL instead.
static int	LONG_INTEGER Deprecated. Use SoImageFormulaProcessing.DataTypes.LONG_INTEGER instead.
SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter>	outImage The output image.
static int	SHORT_INTEGER Deprecated. Use SoImageFormulaProcessing.DataTypes.SHORT_INTEGER instead.
static int	SIGNED_CHAR Deprecated. Use SoImageFormulaProcessing.DataTypes.SIGNED_CHAR instead.
static int	UNSIGNED_CHAR Deprecated. Use SoImageFormulaProcessing.DataTypes.UNSIGNED_CHAR instead.
static int	UNSIGNED_SHORT Deprecated. Use SoImageFormulaProcessing.DataTypes.UNSIGNED_SHORT instead.

Fields inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

CONNECTIVITY_18, CONNECTIVITY_26, CONNECTIVITY_6, MODE_2D, MODE_3D, MODE_AUTO, onBegin, onEnd, onProgress

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoImageFormulaProcessing() 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, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNSIGNED_CHAR

@Deprecated
public static final int UNSIGNED_CHAR

Deprecated. Use SoImageFormulaProcessing.DataTypes.UNSIGNED_CHAR instead.

SIGNED_CHAR

@Deprecated
public static final int SIGNED_CHAR

Deprecated. Use SoImageFormulaProcessing.DataTypes.SIGNED_CHAR instead.

SHORT_INTEGER

@Deprecated
public static final int SHORT_INTEGER

Deprecated. Use SoImageFormulaProcessing.DataTypes.SHORT_INTEGER instead.

UNSIGNED_SHORT

@Deprecated
public static final int UNSIGNED_SHORT

Deprecated. Use SoImageFormulaProcessing.DataTypes.UNSIGNED_SHORT instead.

LABEL

@Deprecated
public static final int LABEL

Deprecated. Use SoImageFormulaProcessing.DataTypes.LABEL instead.

BINARY

@Deprecated
public static final int BINARY

Deprecated. Use SoImageFormulaProcessing.DataTypes.BINARY instead.

LONG_INTEGER

@Deprecated
public static final int LONG_INTEGER

Deprecated. Use SoImageFormulaProcessing.DataTypes.LONG_INTEGER instead.

FLOATING_POINT

@Deprecated
public static final int FLOATING_POINT

Deprecated. Use SoImageFormulaProcessing.DataTypes.FLOATING_POINT instead.

computeMode

public final SoSFEnum<SoImageVizEngine.ComputeModes> computeMode

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

inImage

public final SoSFImageDataAdapter inImage

The input image. Default value is NULL. Supported types include: grayscale binary label color image.

inImage2

public final SoSFImageDataAdapter inImage2

Optional image : enter image or let field empty. This parameter is optional. Default value is NULL. Supported types include: grayscale binary label color image.

inImage3

public final SoSFImageDataAdapter inImage3

Optional image : enter image or let field empty. This parameter is optional. Default value is NULL. Supported types include: grayscale binary label color image.

inFormula

public final SoSFString inFormula

Formula to apply on image(s). See Custom formula syntax for how to use a formula. Default value is "".

dataType

public final SoSFEnum<SoImageFormulaProcessing.DataTypes> dataType

Arithmetic format. . Default is UNSIGNED_CHAR

outImage

public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outImage

The output image. Default value is NULL. Supported types include: grayscale binary label color image.

Constructor Detail

SoImageFormulaProcessing

public SoImageFormulaProcessing()

Constructor.