OrthoSwapFlip

MLModule

genre	Resample
status	stable
author	Tobias Boskamp
package	MeVisLab/Standard
dll	MLCoordUtils1
definition	MLCoordUtils1.def
see also	OrthoReformat3, SwapDimensions, InterleaveDimension, Reshape
keywords	Coordinate, transform, swap, flip, transversal, sagittal, coronal

Purpose

The module OrthoSwapFlip performs an arbitrary coordinate permutation between the three spatial coordinates X, Y and Z, together with possible flips along any of these axes.

The transformation is selected in the Main tab view either by specifying a viewing direction or by selecting the coordinate permuation and the flips explicitly.

Details

View Direction

In the View menu, the viewing direction can be set to either Transversal, Coronal or Sagittal. The coordinate permutation and flips necessary to obtain this view are displayed in the lower part of the panel accordingly.

Swap And Flip

The Orientation menu selects the coordinate permutation performed by the module (in terms of the voxel coordinate system, i.e. X from left to right, Y from top to bottom, Z into the screen plane). Each selection specifies the input coordinate axes corresponding to the three output coordinate axes.

For example, the selection YZX specifies the following mapping:

Output	Input
X	Y
Y	Z
Z	X

The options Flip Horizontal, Flip Vertical and Flip Depth flip the output image along the corresponding axis. The flipping is performed after the coordinate permutation.

Important: In order to activate the settings in the Swap and flip group, it is necessary to click the Apply button. Before this is done, the selected transformation is not performed on the image.

The checkboxes in the View Direction and the Swap And Flip group indicate which setting is kept when the input image changes.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

Output Fields

output0

name: output0, type: Image

Parameter Fields

Field Index

Apply: Trigger	Orientation: Enum
Auto (autoPageSizeX): Bool	Use Global Input Image: Bool
Auto (autoPageSizeY): Bool	useOrientation: Bool
Auto (autoPageSizeZ): Bool	useViewDir: Bool
Flip Depth: Bool	View: Enum
Flip Horizontal: Bool	X: Integer
Flip Vertical: Bool	Y: Integer
Mode: Enum	Z: Integer

Visible Fields

Use Global Input Image

name: useGlobalInputImage, type: Bool, default: FALSE, deprecated name: useCache,UseCache

If checked, the module works internally on a global image (Global Image Processing Concept).

Otherwise, it works on a Virtual Volume (VirtualVolume Concept).

Mode

name: mode, type: Enum, default: UseSwapFlip

Defines the module's mode, see options.

Values:

Title	Name	Description
Swap Flip	UseSwapFlip	The transformation is specified using the explicit permutation and flip settings.
View Dir	UseViewDir	The transformation is specified using the view direction setting.

View

name: view, type: Enum, default: Other, deprecated name: View

Defines the view direction of the transformed image

Values:

Title	Name
Other	Other
Transversal	Transversal
Coronal	Coronal
Sagittal	Sagittal

Orientation

name: orientation, type: Enum, default: XYZ, deprecated name: Orientation

Defines the coordinate permutation applied to the image

Values:

Title	Name
XYZ	XYZ
YZX	YZX
ZXY	ZXY
XZY	XZY
ZYX	ZYX
YXZ	YXZ

Apply

name: applyOrientation, type: Trigger, deprecated name: ApplyOrientation

If pressed, changes are applied of the Swap And Flip group.

Flip Horizontal

name: flipHorizontal, type: Bool, default: FALSE, deprecated name: FlipHorizontal

If checked, the image is flipped horizontally.

Flip Vertical

name: flipVertical, type: Bool, default: FALSE, deprecated name: FlipVertical

If checked, the image is flipped vertically.

Flip Depth

name: flipDepth, type: Bool, default: FALSE, deprecated name: FlipDepth

If checked, the image if flipped in the depth dimension.

Auto (autoPageSizeX)

name: autoPageSizeX, type: Bool, default: TRUE, deprecated name: AutoOutPageX

If checked, the output page x-extent is set automatically.

X

name: pageX, type: Integer, default: 0, deprecated name: OutPageX

Sets the x-extent of the output page manually.

Auto (autoPageSizeY)

name: autoPageSizeY, type: Bool, default: TRUE, deprecated name: AutoOutPageY

If checked, the output page y-extent is set automatically.

Y

name: pageY, type: Integer, default: 0, deprecated name: OutPageY

Sets the y-extent of the output page manually.

Auto (autoPageSizeZ)

name: autoPageSizeZ, type: Bool, default: TRUE, deprecated name: AutoOutPageZ

If checked, the output page z-extent is set automatically.

Z

name: pageZ, type: Integer, default: 0, deprecated name: OutPageZ

Sets the z-extent of the output page manually.

Hidden Fields

useViewDir

name: useViewDir, type: Bool, default: FALSE, deprecated name: UseViewDir

useOrientation

name: useOrientation, type: Bool, default: TRUE, deprecated name: UseOrientation