public class SoBinaryCorrelationProcessing2d extends SoImageVizEngine
SoBinaryCorrelationProcessing2d engine
SoBinaryCorrelationProcessing2d performs the logical correlation between a binary image and a binary kernel.
Notations: 

The binary correlation between image I and kernel K is defined as: 

At the end of the processus, the correlation image is normalized between -1 and 1.
When a part of the kernel lies beyond the edge of the image, the correlation is not computed on the border. In which case, the values are set to -3e38.
Note: The SoBinaryCorrelationProcessing2d filter does not accept a mask AOI attached to the kernel image.
File format/default:
BinaryCorrelationProcessing2d {
| inBinaryImage | NULL |
| inBinaryKernel | NULL |
| offsetMode | OFFSET_1 |
Library references: bincorrel
| Modifier and Type | Class and Description |
|---|---|
static class |
SoBinaryCorrelationProcessing2d.OffsetModes
See Correlation.
|
static class |
SoBinaryCorrelationProcessing2d.SbCorrelationDetail
Results details of image correlation.
|
SoImageVizEngine.ComputeModes, SoImageVizEngine.EventArg, SoImageVizEngine.Neighborhood3dsInventor.ConstructorCommand| Modifier and Type | Field and Description |
|---|---|
SoSFImageDataAdapter |
inBinaryImage
The input binary image.
|
SoSFImageDataAdapter |
inBinaryKernel
The correlation kernel.
|
static int |
OFFSET_1
Deprecated.
Use
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_1 instead. |
static int |
OFFSET_2
Deprecated.
Use
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_2 instead. |
static int |
OFFSET_4
Deprecated.
Use
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_4 instead. |
static int |
OFFSET_8
Deprecated.
Use
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_8 instead. |
SoSFEnum<SoBinaryCorrelationProcessing2d.OffsetModes> |
offsetMode
Select the calculation offset (number of pixels).
|
SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> |
outMatchingImage
The output correlation image.
|
SoImageVizEngineAnalysisOutput<SoBinaryCorrelationProcessing2d.SbCorrelationDetail> |
outResult
The correlation matching results.
|
CONNECTIVITY_18, CONNECTIVITY_26, CONNECTIVITY_6, MODE_2D, MODE_3D, MODE_AUTO, onBegin, onEnd, onProgressVERBOSE_LEVEL, ZeroHandle| Constructor and Description |
|---|
SoBinaryCorrelationProcessing2d()
Constructor.
|
abortEvaluate, isEvaluating, startEvaluate, waitEvaluatecopy, getByName, getOutput, getOutputNamecopyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaultsdispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touchgetAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads@Deprecated public static final int OFFSET_1
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_1 instead.@Deprecated public static final int OFFSET_2
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_2 instead.@Deprecated public static final int OFFSET_4
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_4 instead.@Deprecated public static final int OFFSET_8
SoBinaryCorrelationProcessing2d.OffsetModes.OFFSET_8 instead.public final SoSFImageDataAdapter inBinaryImage
public final SoSFImageDataAdapter inBinaryKernel
public final SoSFEnum<SoBinaryCorrelationProcessing2d.OffsetModes> offsetMode
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outMatchingImage
public final SoImageVizEngineAnalysisOutput<SoBinaryCorrelationProcessing2d.SbCorrelationDetail> outResult
Generated on July 23, 2025, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com