SoBinaryCorrelationProcessing2d

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.fields.SoFieldContainer
    - - com.openinventor.inventor.engines.SoEngine
      - com.openinventor.imageviz.engines.SoImageVizEngine
        
        com.openinventor.imageviz.engines.geometryandmatching.patternrecognition.SoBinaryCorrelationProcessing2d

All Implemented Interfaces:

SafeDisposable
```
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 {
}

Library references: bincorrel

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SoBinaryCorrelationProcessing2d.OffsetModes`	See Correlation.
`static class`	`SoBinaryCorrelationProcessing2d.SbCorrelationDetail`	Results details of image correlation.

Nested classes/interfaces inherited from class com.openinventor.imageviz.engines.SoImageVizEngine
SoImageVizEngine.ComputeModes, SoImageVizEngine.EventArg, SoImageVizEngine.Neighborhood3ds

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field	Description
`SoSFImageDataAdapter`	`inBinaryImage`	The input binary image.
`SoSFImageDataAdapter`	`inBinaryKernel`	The correlation kernel.
`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.

Fields inherited from class com.openinventor.imageviz.engines.SoImageVizEngine
onBegin, onEnd, onProgress

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor Description

SoBinaryCorrelationProcessing2d()
Constructor.

Method Summary
- Methods inherited from class com.openinventor.imageviz.engines.SoImageVizEngine
  abortEvaluate, isEvaluating, startEvaluate, waitEvaluate
- Methods inherited from class com.openinventor.inventor.engines.SoEngine
  copy, getByName, getOutput, getOutputName
- Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
  copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults
- Methods inherited from class com.openinventor.inventor.misc.SoBase
  dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable, touch
- Methods inherited from class com.openinventor.inventor.Inventor
  getNativeResourceHandle
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - inBinaryImage
```
public final SoSFImageDataAdapter inBinaryImage
```
    The input binary image. Default value is NULL. Supported types include: binary color image.
  - inBinaryKernel
```
public final SoSFImageDataAdapter inBinaryKernel
```
    The correlation kernel. Default value is NULL. Supported types include: binary color image.
  - offsetMode
```
public final SoSFEnum<SoBinaryCorrelationProcessing2d.OffsetModes> offsetMode
```
    Select the calculation offset (number of pixels). . Default is OFFSET_1
  - outMatchingImage
```
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outMatchingImage
```
    The output correlation image. Default value is NULL. Supported types include: grayscale color image.
  - outResult
```
public final SoImageVizEngineAnalysisOutput<SoBinaryCorrelationProcessing2d.SbCorrelationDetail> outResult
```
    The correlation matching results. Default value is NULL.
- Constructor Detail
  - SoBinaryCorrelationProcessing2d
```
public SoBinaryCorrelationProcessing2d()
```
    Constructor.