Correlation¶

MLModule¶

genre	`Kernel`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`MLKernel`
definition	MLKernel.def
keywords	`convolution`, `image`

Purpose¶

The module Correlation computes the correlation/convolution of one image with another.

Usage¶

Connect the larger image to input0 and the kernel image to the kernelInput.

Details¶

Note: The kernel image is limited to 256x256x256 in size. Only the x-, y-, and z-dimensions are used.

Windows¶

Default Panel¶

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

Input Fields¶

input0¶

name: input0, type: Image¶: Input image, its extent needs to be greater or equal than the extent of the kernel image.

kernelInput¶

name: kernelInput, type: Image¶: Kernel input, limited to 256x256x256 voxel.

Output Fields¶

output0¶

name: output0, type: Image¶: Normalized correlation of input image * kernel image.

Parameter Fields¶

Field Index¶

Border Handling: Enum

Fill Value: Double

kernelInfo: String

Normalize: Bool

Reference Extent Mode: Enum

Visible Fields¶

Border Handling¶

name: borderHandling, type: Enum, default: PadSrcClamp¶

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.

Reference Extent Mode¶

name: referenceExtentMode, type: Enum, default: Overlap¶: Defines the calculation mode.