ExtendedConvolution

MLModule

genre	Kernel
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLKernel
definition	MLKernel.def
see also	Convolution, Rank, Morphology, Sigma, StandardDeviation, KernelEditor
keywords	enhance, kernel, filter, average, gauss, interval, sphere, spherical

Purpose

The module ExtendedConvolution implements some standard convolution filters like Average or Gauss, whose kernel sizes can be specified by the user.

Optionally, a threshold interval can be used to select a subset of voxels of the input image to which the filtering is applied. By using this interval, filtering can be applied selectively to regions in the image and the number of filtered voxels can be reduced to gain performance.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

Output Fields

output0

name: output0, type: Image

Parameter Fields

Field Index

Border Handling: Enum	KernelY: Integer	referenceExtentMode: Enum
Fill Value: Double	KernelZ: Integer	Use (useIntervalOfFilteredVoxels): Bool
Info: String	Make kernel spherical: Bool	Use (useIntervalOfVoxelsForFiltering): Bool
KernelC: Integer	Max (intervalMaxOfFilteredVoxels): Double	Use (kernelType): Enum
kernelElementsSum: Double	Max (intervalMaxOfVoxelsForFiltering): Double
KernelT: Integer	Min (intervalMinOfFilteredVoxels): Double
KernelU: Integer	Min (intervalMinOfVoxelsForFiltering): Double
KernelX: Integer	numKernelElements: Integer

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.

KernelX

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

Sets the x-extent of the kernel.

KernelY

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

Sets the y-extent of the kernel.

KernelZ

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

Sets the z-extent of the kernel.

KernelC

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

Sets the c-extent of the kernel.

KernelT

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

Sets the t-extent of the kernel.

KernelU

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.

Min (intervalMinOfFilteredVoxels)

name: intervalMinOfFilteredVoxels, type: Double, default: 0, deprecated name: imageIntervalMin

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

Max (intervalMaxOfFilteredVoxels)

name: intervalMaxOfFilteredVoxels, type: Double, default: 1024, deprecated name: imageIntervalMax

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

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: 1, deprecated name: kernelIntervalMin

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

Max (intervalMaxOfVoxelsForFiltering)

name: intervalMaxOfVoxelsForFiltering, type: Double, default: 4095, deprecated name: kernelIntervalMax

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

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.

Info

name: kernelInfo, type: String, persistent: no

Shows information about the used kernel.

Use (kernelType)

name: kernelType, type: Enum, default: Gauss Kernel

Defines the used kernel type.

Values:

Title	Name	Description
Average Kernel	Average Kernel	All kernel values are the same and add up to 1.
Gauss Kernel	Gauss Kernel	The kernel is a normalized Gaussian kernel.
Id Kernel	Id Kernel	The kernel has the extent 1x1x1x1x1x1 and the value 1.

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

numKernelElements

name: numKernelElements, type: Integer, persistent: no

kernelElementsSum

name: kernelElementsSum, type: Double, persistent: no