SubImage

MLModule

genre	Subimage
status	stable
authors	Florian Link, Tobias Boskamp
package	MeVisLab/Standard
dll	MLBasicModules
definition	mlBasicModules.def
see also	Magnify, VecBoxConvert, DecomposeVector, GetVoxelValue
keywords	Subimage, crop, box

Purpose

The module SubImage extracts subimages from its input image.

A SubImage module can also create a region larger than the input image.

Tips

The update of the output image of this module depends on the Apply/Apply Box buttons and the Auto Apply/ Auto Apply Box checkboxes.

If no auto apply is set, the SubImage module still does an explicit apply on each input image change. This means that the output image of the module is recalculated from the module's coordinate fields whenever 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	Modify (modifyY): Bool	Start T: Float
Apply Box: Trigger	Modify (modifyZ): Bool	Start U: Float
Auto Apply: Bool	Modify (modifyC): Bool	Start X: Float
Auto Apply Box: Bool	Modify (modifyT): Bool	Start Y: Float
Box Input: String	Modify (modifyU): Bool	Start Z: Float
Fill Value: Double	Sc: Float	Su: Float
Full Size: Trigger	Size X: Float	Sy: Float
Mode: Enum	St: Float	Sz: Float
Modify (modifyX): Bool	Start C: Float

Visible Fields

Box Input

name: boxInput, type: String, default: 0 0 0 0 0 0 -1 -1 -1 -1 -1 -1

Sets a string representing the voxel start and voxel size of the box.

Apply Box

name: applyBox, type: Trigger, deprecated name: updateFromBoxInput

If pressed, the currently specified box is used.

Auto Apply Box

name: autoApplyBox, type: Bool, default: FALSE, deprecated name: autoUpdateFromBoxInput

If checked, the currently specified is used on any field change.

Start X

name: x, type: Float, default: 0

Sets the start x-coordinate of the subimage.

Size X

name: sx, type: Float, default: 32

Sets the size or end x-coordinate of the subimage.

Modify (modifyX)

name: modifyX, type: Bool, default: TRUE

If checked, the x-extent can be modified.

Start Y

name: y, type: Float, default: 0

Sets the start y-coordinate of the subimage.

Sy

name: sy, type: Float, default: 32

Sets the size or end y-coordinate of the subimage.

Modify (modifyY)

name: modifyY, type: Bool, default: TRUE

If checked, the y-extent can be modified.

Start Z

name: z, type: Float, default: 0

Sets the start z-coordinate of the subimage.

Sz

name: sz, type: Float, default: 32

Sets the size or end z-coordinate of the subimage.

Modify (modifyZ)

name: modifyZ, type: Bool, default: TRUE

If checked, the z-extent can be modified.

Start C

name: c, type: Float, default: 0

Sets the start c-coordinate of the subimage.

Sc

name: sc, type: Float, default: 1

Sets the size or end c-coordinate of the subimage.

Modify (modifyC)

name: modifyC, type: Bool, default: FALSE

If checked, the c-extent can be modified.

Start T

name: t, type: Float, default: 0

Sets the start t-coordinate of the subimage.

St

name: st, type: Float, default: 1

Sets the size or end t-coordinate of the subimage.

Modify (modifyT)

name: modifyT, type: Bool, default: TRUE

If checked, the t-extent can be modified.

Start U

name: u, type: Float, default: 0

Sets the start u-coordinate of the subimage.

Su

name: su, type: Float, default: 1

Sets the size or end u-coordinate of the subimage.

Modify (modifyU)

name: modifyU, type: Bool, default: FALSE

If checked, the u-extent can be modified.

Fill Value

name: fillValue, type: Double, default: 0

Sets a fill value that is used for all empty regions in case the output image is larger than the input image.

Mode

name: mode, type: Enum, default: VoxelStartSize

Defines the mode in that the size of the subimage is specified.

Values:

Title	Name	Description
Voxel Start & Size	VoxelStartSize	A starting point and a size in voxel coordinates need to be specified.
Voxel Start & End	VoxelStartEnd	A starting and an ending point in voxel coordinates need to be specified.
World Start & End	WorldStartEnd	A starting and an ending point in world coordinates need to be specified.

Auto Apply

name: autoApply, type: Bool, default: FALSE

If checked, the module computes anew on any field change.

Apply

name: apply, type: Trigger

If pressed, the module computes anew.

Full Size

name: fullSize, type: Trigger, deprecated name: getProperties

If pressed, all fields are set to the full values of the input image.