SoGradientMagnitudeProcessing2d

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.edgedetection.gradient.SoGradientMagnitudeProcessing2d

All Implemented Interfaces:

SafeDisposable
```
public class SoGradientMagnitudeProcessing2d
extends SoImageVizEngine
```
SoGradientMagnitudeProcessing2d engine. For an introduction to gradient operations, see section Introduction to Gradient.
The SoGradientMagnitudeProcessing2d engine computes the gradient amplitude and orientation from gradient images along X and Y axis. The results depend on the selected gradient mode.
See also: SoGradientOperatorProcessing2d, SoGradientMagnitudeProcessing3d.
File format/default:
GradientMagnitudeProcessing2d {
}

Library references: gradient_mag

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SoGradientMagnitudeProcessing2d.GradientModes
- 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
`SoSFEnum<SoGradientMagnitudeProcessing2d.GradientModes>`	`gradientMode`	Select an output mode.
`SoSFImageDataAdapter`	`inGradientXImage`	The input X-gradient image.
`SoSFImageDataAdapter`	`inGradientYImage`	The input Y-gradient image.
`SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter>`	`outAmplitudeImage`	The output gradient amplitude image.
`SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter>`	`outOrientationImage`	The output gradient orientation image.

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

SoGradientMagnitudeProcessing2d()
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
  - inGradientXImage
```
public final SoSFImageDataAdapter inGradientXImage
```
    The input X-gradient image. Default value is NULL. Supported types include: grayscale color image.
  - inGradientYImage
```
public final SoSFImageDataAdapter inGradientYImage
```
    The input Y-gradient image. Default value is NULL. Supported types include: grayscale color image.
  - gradientMode
```
public final SoSFEnum<SoGradientMagnitudeProcessing2d.GradientModes> gradientMode
```
    Select an output mode. . Default is AMPLITUDE_MAX_OF_MAGS
  - outAmplitudeImage
```
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outAmplitudeImage
```
    The output gradient amplitude image. Default value is NULL. Supported types include: grayscale binary label color image.
  - outOrientationImage
```
public final SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter> outOrientationImage
```
    The output gradient orientation image. Default value is NULL. Supported types include: grayscale binary label color image.
- Constructor Detail
  - SoGradientMagnitudeProcessing2d
```
public SoGradientMagnitudeProcessing2d()
```
    Constructor.