public class SoGrayscaleCorrelationProcessing2d extends SoImageVizEngine
SoGrayscaleCorrelationProcessing2d engine
The SoGrayscaleCorrelationProcessing2d image filter performs a correlation between a grey level image I and a grey level kernel K returning the correlation image O.
See Correlation for generalities.
Notations: 


The different possibilities are presented below using a 1-D correlation between an image and kernel. In the image, the kernel appears 6 times with different contrast and luminosity.
The 6 examples show the kernel appearing with different contrast and luminosity. 
The correlation is performed depending on SoGrayscaleCorrelationProcessing2d.CorrelationMode.
In this mode, we have detected 3 of the 6 patterns matching the kernel. Only high luminosity patterns have been detected. The best matching is obtained for the high contrast and luminosity pattern. 
In this mode, we have detected 2 of the 6 patterns matching the kernel. Only high contrast patterns have been detected. The confidence rate is the same for the two 2 patterns. 
In this mode, we have detected the 2 patterns matching the kernel with the same confidence rate. 
In this mode, we have detected the 6 patterns matching the kernel with the same confidence rate. 
The correlation is performed depending on SoGrayscaleCorrelationProcessing2d.CorrelationMode.
In this mode, we have detected 3 of the 6 patterns matching the kernel. Only similar luminosity patterns have been detected. The best matching is obtained with the similar contrast and luminosity pattern. 
In this mode, we have detected 2 of the 6 patterns matching the kernel. Only similar contrast patterns have been detected. The confidence rate is the same for the 2 patterns. 
In this mode, we have detected 3 of the 6 patterns matching the kernel. Only similar luminosity patterns have been detected. The confidence rate is the same for the 3 patterns. 
In this mode, we have detected the 6 patterns matching the kernel with the same confidence rate. 
The correlation is performed depending on SoGrayscaleCorrelationProcessing2d.CorrelationMode.
is the sign change criterion performed on the difference image. It corresponds to the number of sign changes calculated on every line.
The object in the model and the object in the image have luminosity, contrast and noise differences. After normalization depending on the correlation type, the sign change criterion is applied on the difference image. The noise is supposed to be additive and zero mean. The statistical density function of the noise is supposed to be symmetrical. The best matching will correspond to the maximum number of sign changes.
This correlation gives very good results with big kernels. It was created for medical applications where images are often very noisy.
File format/default:
GrayscaleCorrelationProcessing2d {
| correlationCriterion | MULTIPLY |
| inGrayImage | NULL |
| inKernelImage | NULL |
| offsetMode | OFFSET_1 |
| correlationMode | DIRECT |
Library references: dcorrel mcorrel scorrel
| Modifier and Type | Class and Description |
|---|---|
static class |
SoGrayscaleCorrelationProcessing2d.CorrelationCriterions
See Correlation.
|
static class |
SoGrayscaleCorrelationProcessing2d.CorrelationModes
See Correlation and for each
SoGrayscaleCorrelationProcessing2d.CorrelationCriterion. |
static class |
SoGrayscaleCorrelationProcessing2d.OffsetModes
This field is ignored in the multiply correlation mode.
|
static class |
SoGrayscaleCorrelationProcessing2d.SbCorrelationDetail
Results details of image correlation.
|
SoImageVizEngine.ComputeModes, SoImageVizEngine.EventArg, SoImageVizEngine.Neighborhood3dsInventor.ConstructorCommand| Modifier and Type | Field and Description |
|---|---|
SoSFEnum<SoGrayscaleCorrelationProcessing2d.CorrelationCriterions> |
correlationCriterion
Select the correlation operator.
|
SoSFEnum<SoGrayscaleCorrelationProcessing2d.CorrelationModes> |
correlationMode
Select the normalization mode for correlation.
|
static int |
DIRECT
Deprecated.
|
SoSFImageDataAdapter |
inGrayImage
The input grayscale image.
|
SoSFImageDataAdapter |
inKernelImage
The correlation kernel.
|
static int |
MEAN
Deprecated.
|
static int |
MEAN_VARIANCE
Deprecated.
|
static int |
MULTIPLY
Deprecated.
|
static int |
OFFSET_1
Deprecated.
|
static int |
OFFSET_2
Deprecated.
|
static int |
OFFSET_4
Deprecated.
|
static int |
OFFSET_8
Deprecated.
|
SoSFEnum<SoGrayscaleCorrelationProcessing2d.OffsetModes> |
offsetMode
Select the calculation offset (number of pixels).
|
SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> |
outMatchingImage
The output correlation image.
|
SoImageVizEngineAnalysisOutput<SoGrayscaleCorrelationProcessing2d.SbCorrelationDetail> |
outResult
The correlation matching results.
|
static int |
SIGNCHANGE
Deprecated.
|
static int |
SUBSTRACT
Deprecated.
|
static int |
VARIANCE
Deprecated.
|
CONNECTIVITY_18, CONNECTIVITY_26, CONNECTIVITY_6, MODE_2D, MODE_3D, MODE_AUTO, onBegin, onEnd, onProgressVERBOSE_LEVEL, ZeroHandle| Constructor and Description |
|---|
SoGrayscaleCorrelationProcessing2d()
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 SIGNCHANGE
SoGrayscaleCorrelationProcessing2d.CorrelationCriterions.SIGNCHANGE instead.@Deprecated public static final int SUBSTRACT
SoGrayscaleCorrelationProcessing2d.CorrelationCriterions.SUBSTRACT instead.@Deprecated public static final int MULTIPLY
SoGrayscaleCorrelationProcessing2d.CorrelationCriterions.MULTIPLY instead.@Deprecated public static final int OFFSET_1
SoGrayscaleCorrelationProcessing2d.OffsetModes.OFFSET_1 instead.@Deprecated public static final int OFFSET_2
SoGrayscaleCorrelationProcessing2d.OffsetModes.OFFSET_2 instead.@Deprecated public static final int OFFSET_4
SoGrayscaleCorrelationProcessing2d.OffsetModes.OFFSET_4 instead.@Deprecated public static final int OFFSET_8
SoGrayscaleCorrelationProcessing2d.OffsetModes.OFFSET_8 instead.@Deprecated public static final int DIRECT
SoGrayscaleCorrelationProcessing2d.CorrelationModes.DIRECT instead.@Deprecated public static final int MEAN
SoGrayscaleCorrelationProcessing2d.CorrelationModes.MEAN instead.@Deprecated public static final int VARIANCE
SoGrayscaleCorrelationProcessing2d.CorrelationModes.VARIANCE instead.@Deprecated public static final int MEAN_VARIANCE
SoGrayscaleCorrelationProcessing2d.CorrelationModes.MEAN_VARIANCE instead.public final SoSFEnum<SoGrayscaleCorrelationProcessing2d.CorrelationCriterions> correlationCriterion
public final SoSFImageDataAdapter inGrayImage
public final SoSFImageDataAdapter inKernelImage
public final SoSFEnum<SoGrayscaleCorrelationProcessing2d.OffsetModes> offsetMode
public final SoSFEnum<SoGrayscaleCorrelationProcessing2d.CorrelationModes> correlationMode
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outMatchingImage
public final SoImageVizEngineAnalysisOutput<SoGrayscaleCorrelationProcessing2d.SbCorrelationDetail> outResult
Generated on July 23, 2025, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com