OrthoViewOverlay

MacroModule

genre	View2DExtended
author	Lars Bornemann
package	FMEwork/ReleaseMeVis
definition	OrthoViewOverlay.def
see also	SoView2D, SoOrthoView2D, SoView2DOverlay, OrthoReformat3
keywords	overlay, orthogonal, view2d, reformat

Purpose

The OrthoviewOverlay module allows for a display of an overlay on a 2D viewer which can even be an OrthoView2D.

Usage

Attach the input image (the image that should be overlain on some image)to the module’s input and attach the module’s output to some 2D viewer (preferable an OrthoView2D).

Details

Internally, the macro makes use of an OrthoReformat and three SoView2DOverlay modules. Due to this, the whole image is reformatted into the three orthogonal views. Thus, if this macro module is used for displaying only one slice (on a “normal” 2D viewer) it can be more or less inefficient. Use a standard SoView2DOverlay instead.

Windows

Default Panel

Input Fields

inImage

name: inImage, type: Image

The module takes the image as an input that should be laid over any 2D image.

Output Fields

overlay

name: overlay, type: SoNode

The module’s output is an OpenInventor scene that has to be connected to a corresponding 2D viewer.

Parameter Fields

Field Index

Alpha Factor: Float	Lut Precision: Enum
Base Color: Color	maxTimePoint: Integer
Blend Mode: Enum	Overwrite Current Time Point: Bool
Draw checker tiles: Bool	Tile Size: Integer
Drawing On: Bool	Timepoint: Integer
Filter Mode: Enum	Use Global Input Image: Bool
Inherit filter mode from SoView2D: Bool
Invert tiles: Bool

Visible Fields

Drawing On

name: drawingOn, type: Bool, default: TRUE

If checked, the module draws (if possible) the input image over the image in the viewer.

Draw checker tiles

name: isCheckerTiling, type: Bool, default: TRUE

If checked, the module simulates a screen door transparency in addition to the blending.

Tile Size

name: checkerTileSize, type: Integer, default: 3, minimum: 2

The tile size of the (square) screen door checkers.

Invert tiles

name: areCheckerTilesInverted, type: Bool, default: FALSE

If checked, the checker board pattern is inverted.

Inherit filter mode from SoView2D

name: inheritFilterMode, type: Bool, default: TRUE

If checked, the filter mode (interpolation mode) of the module is inherited from the according parameter in the SoView2D.

Filter Mode

name: filterMode, type: Enum, default: FILTER_LINEAR

The filter mode (interpolation mode) of the module for fitting the voxels onto screen pixels. Values are Nearest, Linear, Linear Postclass and Cubic Postclass. Default is Linear. Note that this is only available if the module does not inherit the filter mode (see option above).

Values:

Title	Name
​Nearest	​FILTER_NEAREST
​Linear	​FILTER_LINEAR
​Linear Postclass	​FILTER_LINEAR_POSTCLASS
​Cubic Postclass	​FILTER_CUBIC_POSTCLASS

Blend Mode

name: blendMode, type: Enum, default: BLEND_BLEND

The blend mode for the overlay display. Values are Replace, Add, Blend, Maximum, Minimum, Reverse Substract and Subtract.

Values:

Title	Name
​Replace	​BLEND_REPLACE
​Add	​BLEND_ADD
​Blend	​BLEND_BLEND
​Maximum	​BLEND_MAXIMUM
​Minimum	​BLEND_MINIMUM
​Reverse Subtract	​BLEND_REVERSE_SUBTRACT
​Subtract	​BLEND_SUBTRACT

Alpha Factor

name: alphaFactor, type: Float, default: 1, minimum: 0, maximum: 1

The alpha factor of the overlay rendering.

Base Color

name: baseColor, type: Color, default: 0.333333343267441 0.666666686534882 1

The base color of the overlay.

Use Global Input Image

name: useGlobalInputImage, type: Bool, default: TRUE

If checked, the reformation is calculated on the whole image. If disabled, the reformation is computed on demand. The first option requires larger chunks of memory, which may result memory allocation failure for large datasets. The second option may lead to a slower slicing in the connected SoView2D.

Overwrite Current Time Point

name: overwriteCurrentTimePoint, type: Bool, default: TRUE

If checked, the current time point is not taken from the viewer but from the field Timepoint.

Timepoint

name: timePoint, type: Integer, default: 0, minimum: 0, maximum: :field:`maxTimePoint`

Sets the time point explicitly if Overwrite Current Time Point is checked.

Lut Precision

name: lutPrecision, type: Enum, default: VIEW2D_LUT_AUTO

Sets the precision of the LUT.

Values:

Title	Name	Description
​Auto	​VIEW2D_LUT_AUTO	​The LUT precision is calculated using the input dataset’s min and max values. The maximum supported LUT precision is 16 bits. If the input dataset is a floating point type, the LUT uses 12 bit.
​8bit	​VIEW2D_LUT_8BIT	​The LUT precision is 8 bit, regardless of the input data type.
​12bit	​VIEW2D_LUT_12BIT	​The LUT precision is 12 bit, regardless of the input data type.
​16bit	​VIEW2D_LUT_16BIT	​The LUT precision is 16 bit, regardless of the input data type.

Hidden Fields

maxTimePoint

name: maxTimePoint, type: Integer, default: 0