| SoGrayscaleCorrelationProcessing2d Class |
OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognition.SoGrayscaleCorrelationProcessing2d engine.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognitionSoGrayscaleCorrelationProcessing2d
Namespace: OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognition
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoGrayscaleCorrelationProcessing2d type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoGrayscaleCorrelationProcessing2d | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AbortEvaluate | Abort current processing as soon as possible. |
| Copy | Creates and returns an exact copy of the engine. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetName | Returns the name of an instance. |
| GetOutput | Returns a reference to the engine output with the given name. |
| GetOutputName | Returns (in outputName) the name of the engine output (output). |
| GetOutputs | Returns a list of outputs in this engine. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsEvaluating | Returns true if the engine evaluation is in progress. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| StartEvaluate | Evaluate engine and dependencies in another thread without blocking the current one. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| WaitEvaluate | Wait for the end of engine evaluation. |
Properties| Name | Description | |
|---|---|---|
 | correlationCriterion | Select the correlation operator. |
| correlationMode | Select the normalization mode for correlation. |
| inGrayImage | The input grayscale image. |
| inKernelImage | The correlation kernel. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| offsetMode | Select the calculation offset (number of pixels). |
| outMatchingImage | The output correlation image. |
| outResult | The correlation matching results. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Events| Name | Description | |
|---|---|---|
 | OnBegin | Event raised when the processing begins. |
| OnEnd | Event raised when processing ends and the result is available. |
| OnProgress | Event raised while processing is running. |
RemarksThe OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognition.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.
Multiply correlation
The correlation is performed depending on OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognition.SoGrayscaleCorrelationProcessing2d.CorrelationModes.
For DIRECT
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.
For MEAN
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.
For VARIANCE
In this mode, we have detected the 2 patterns matching the kernel with the same confidence rate.
For MEAN_VARIANCE
In this mode, we have detected the 6 patterns matching the kernel with the same confidence rate.
Difference correlation
The correlation is performed depending on OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognition.SoGrayscaleCorrelationProcessing2d.CorrelationModes.
For DIRECT
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.
For MEAN
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.
For VARIANCE
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.
For MEAN_VARIANCE
In this mode, we have detected the 6 patterns matching the kernel with the same confidence rate.
Sign Change correlation
The correlation is performed depending on OIV.ImageViz.Engines.GeometryAndMatching.PatternRecognition.SoGrayscaleCorrelationProcessing2d.CorrelationModes.
is the sign change criterion performed on the difference image. It corresponds to the number of sign changes calculated on every line.
This correlation gives very good results with big kernels. It was created for medical applications where images are often very noisy.
For DIRECT
For MEAN
For VARIANCE
For MEAN_VARIANCE
FILE FORMAT/DEFAULT
GrayscaleCorrelationProcessing2d {
| correlationCriterion | MULTIPLY |
| inGrayImage | NULL |
| inKernelImage | NULL |
| offsetMode | OFFSET_1 |
| correlationMode | DIRECT |
Library references: dcorrel mcorrel scorrel
See Also