Purpose

The module LocalMaxima calculates whether a voxel is a local maximum in a user-defined neighborhood (defined by the size of the kernel).

The output value of a voxel is 1 if there is no voxel with a greater value under the kernel, otherwise the output value is 0.

Optionally a threshold interval can be used to select a subset of voxels of the input image to which the filtering is applied. Another threshold interval can be used to limit the set of voxels used in each filtering. By using these intervals filtering can be applied selectively to regions in the image and the influence of certain objects to the filtering itself can be avoided by excluding the corresponding voxels from the kernel.

Windows

Default Panel

../../../Modules/ML/MLKernel/mhelp/Images/Screenshots/LocalMaxima._default.png

Input Fields

input0

name: input0, type: Image

Output Fields

output0

name: output0, type: Image

Parameter Fields

Visible Fields

Border Handling

name: borderHandling, type: Enum, default: PadSrcClamp, deprecated name: edgeMode

Defines the border handling mode.

See Border Handling in Kernel Operations for details.

Values:

Title Name
No Pad NoPad
Pad Src Fill PadSrcFill
Pad Dst Fill PadDstFill
Pad Dst Fill With Orig PadDstFillWithOrig
Pad Src Undefined PadSrcUndefined
Pad Dst Undefined PadDstUndefined
Pad Src Clamp PadSrcClamp

Fill Value

name: fillValue, type: Double, default: 0

Sets the fill value for certain Border Handling modes.

X

name: kernelX, type: Integer, default: 5, minimum: 1, maximum: 999

Sets the x-extent of the kernel.

Y

name: kernelY, type: Integer, default: 5, minimum: 1, maximum: 999

Sets the y-extent of the kernel.

Z

name: kernelZ, type: Integer, default: 1, minimum: 1, maximum: 999

Sets the z-extent of the kernel.

C

name: kernelC, type: Integer, default: 1, minimum: 1, maximum: 999

Sets the c-extent of the kernel.

T

name: kernelT, type: Integer, default: 1, minimum: 1, maximum: 999

Sets the t-extent of the kernel.

U

name: kernelU, type: Integer, default: 1, minimum: 1, maximum: 999

Sets the u-extent of the kernel.

Make kernel spherical

name: makeSpherical, type: Bool, default: FALSE

If checked, the used kernel is a spherical kernel, not a rectangular one.

External Kernel

name: externalKernel, type: String

Sets an external kernel as a string.

Use the module KernelEditor for editing the kernel or set the kernel by scripting.

Use (useExternalKernel)

name: useExternalKernel, type: Bool, default: FALSE

If checked, the optionally attached External Kernel is used.

Info

name: kernelInfo, type: String, persistent: no

Shows information about the used kernel.

Min (intervalMinOfFilteredVoxels)

name: intervalMinOfFilteredVoxels, type: Double, default: 0.1, deprecated name: ImageIntervalMin

Sets the minimum value threshold for outputting a subset of voxel.

Max (intervalMaxOfFilteredVoxels)

name: intervalMaxOfFilteredVoxels, type: Double, default: 2000, deprecated name: ImageIntervalMax

Sets the maximum value threshold for outputting a subset of voxel.

Use (useIntervalOfFilteredVoxels)

name: useIntervalOfFilteredVoxels, type: Bool, default: FALSE, deprecated name: UseImageInterval

If checked, the module outputs only on a subset of voxels defined by a value range.

Min (intervalMinOfVoxelsForFiltering)

name: intervalMinOfVoxelsForFiltering, type: Double, default: 30, deprecated name: KernelIntervalMin

Sets the minimum value threshold for operating on a subset of voxel.

Max (intervalMaxOfVoxelsForFiltering)

name: intervalMaxOfVoxelsForFiltering, type: Double, default: 50, deprecated name: KernelIntervalMax

Sets the maximum value threshold for operating on a subset of voxel.

Use (useIntervalOfVoxelsForFiltering)

name: useIntervalOfVoxelsForFiltering, type: Bool, default: FALSE, deprecated name: UseKernelInterval

If checked, the module operates only on a subset of voxels defined by a value range.

Return source value for local maxima

name: returnSourceValue, type: Bool, default: TRUE, deprecated name: returnSourceValueField

If checked, the module returns the original value of the voxel for local maxima, otherwise 1.

Calculate minima instead of maxima

name: calculateMinima, type: Bool, default: FALSE

If checked, the module searches for local minima instead of maxima.

Calculate real maxima

name: calculateRealMaxima, type: Bool, default: FALSE

If checked, a voxel is considered no local maximum if there is another voxel with the same value in the neighbourhood defined by the kernel.

Hidden Fields

referenceExtentMode

name: referenceExtentMode, type: Enum, default: Overlap

Values:

Title Name
Overlap Overlap
Input0 Ext Without Fill Input0_ExtWithoutFill
Input0 Ext With Fill Input0_ExtWithFill
Max Extents Without Fill MaxExtentsWithoutFill
Max Extents With Fill MaxExtentsWithFill

normalize

name: normalize, type: Bool, default: TRUE

kernelOutput

name: kernelOutput, type: String, persistent: no

autoCalcMinMax

name: autoCalcMinMax, type: Bool, default: TRUE

setAutoMinMax

name: setAutoMinMax, type: Trigger

outputMin

name: outputMin, type: Double, default: 1

outputMax

name: outputMax, type: Double, default: 0

useMinMax

name: useMinMax, type: Bool, default: FALSE