MaskShape

MacroModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
definition	MaskShape.def
see also	Mask, SubImage

Purpose

The module MaskShape creates a defined shape into an image.

The generated image can be used as a mask image for the module Mask.

Usage

Define the size and world matrix of the output mask image by connecting any image to image input connector. Alternatively, use the field enforceImageSize to set the image size manually. Choose between two predefined shapes (Box, Ellipsoid) with the Shape field. The size of the shape can be set with a bounding box or its center and radius.

Windows

Default Panel

Input Fields

inputRefImage

name: inputRefImage, type: Image

Optional reference image to use its size and world matrix.

Output Fields

output0

name: output0, type: Image

Output binary mask image.

Parameter Fields

Field Index

Auto apply: Bool	Radius: Integer	Z: Integer
Center: Vector3	Shape: Enum
End X: Integer	Start X: Integer
End Y: Integer	Start Y: Integer
End Z: Integer	Start Z: Integer
enforceImageSize: Bool	Update: Trigger
Mode: Enum	X: Integer
Position Mode: Enum	Y: Integer

Visible Fields

X

name: imageSizeX, type: Integer, default: 256, minimum: 1, maximum: 1.07374e+09

Sets the size in x-direction of the new mask image. It is only used if enforceImageSize is set.

Y

name: imageSizeY, type: Integer, default: 256, minimum: 1, maximum: 1.07374e+09

Sets the size in y-direction of the new mask image. It is only used if enforceImageSize is set.

Z

name: imageSizeZ, type: Integer, default: 1, minimum: 1, maximum: 1.07374e+09

Sets the size in z-direction of the new mask image. It is only used if enforceImageSize is set.

Center

name: maskCenter, type: Vector3, default: 0 0 0

Sets the 3D position of the center of the mask shape. It is only used if Position Mode is set to ‘Center Radius’.

Radius

name: maskRadius, type: Integer, default: 0

Sets the radius of the mask shape. It is only used if Position Mode is set to ‘Center Radius’.

Start X

name: maskXMin, type: Integer, default: 0

Sets the start x-coordinate of the mask shape. It is only used if Position Mode is set to ‘Bounding Box’.

End X

name: maskXMax, type: Integer, default: 0

Sets the end x-coordinate of the mask shape. It is only used if Position Mode is set to ‘Bounding Box’.

Start Y

name: maskYMin, type: Integer, default: 0

Sets the start y-coordinate of the mask shape. It is only used if Position Mode is set to ‘Bounding Box’.

End Y

name: maskYMax, type: Integer, default: 0

Sets the end y-coordinate of the mask shape. It is only used if Position Mode is set to ‘Bounding Box’.

Start Z

name: maskZMin, type: Integer, default: 0

Sets the start z-coordinate of the mask shape. It is only used if Position Mode is set to ‘Bounding Box’.

End Z

name: maskZMax, type: Integer, default: 0

Sets the end z-coordinate of the mask shape. It is only used if Position Mode is set to ‘Bounding Box’.

Position Mode

name: positionMode, type: Enum, default: CenterRadius

Defines how the position and size of the mask shape is specified.

Values:

Title	Name	Description
​Center Radius	​CenterRadius	​A center point and radius need to be specified.
​Bounding Box	​BoundingBox	​A bounding box needs to be specified.

Shape

name: shape, type: Enum, default: Box

Defines the shape of the mask object.

Values:

Title	Name	Description
​Box	​Box	​Renders a box whose shape is determined by the voxel extents, reducing to cube if they are homogeneous.
​Ellipsoid	​Ellipsoid	​Renders an ellipsoid whose shape is determined by the voxel extents, reducing to a sphere if they are homogeneous.

Mode

name: updateMode, type: Enum, default: AutoUpdate

Defines the update mode of MaskShape.

Values:

Title	Name	Description
​Off	​Off	​The module does not compute anew if the input image changes.
​Auto Clear	​AutoClear	​The output of this module is cleared if the input image changes.
​Auto Update	​AutoUpdate	​The module computes anew if the input image changes.

Auto apply

name: autoApply, type: Bool, default: FALSE

If checked, the mask is generated anew if any field on the GUI is changed.

Update

name: update, type: Trigger

When pressed, the mask is generated anew.

Hidden Fields

enforceImageSize

name: enforceImageSize, type: Bool, default: FALSE