SoObjectImageRatioQuantification

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.imageanalysis.morphometry.SoObjectImageRatioQuantification

All Implemented Interfaces:

SafeDisposable
```
public class SoObjectImageRatioQuantification
extends SoImageVizEngine
```
SoObjectImageRatioQuantification engine. The SoObjectImageRatioQuantification engine measures the proportion of the image occupied by binarised objects.
For an introduction, see section Morphometry.
This engine measures the proportion of the image occupied by binarised objects.
- In the 2D case :
- In the 3D case :
Where gx, gy and gz represent respectively the image size along x, y and z axis.
See Also:

SoObjectSpecificSurfaceQuantification File format/default: ObjectImageRatioQuantification { computeMode MODE_AUTO inBinaryImage NULL inMaskImage NULL } Library references: object_image_ratio

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SoObjectImageRatioQuantification.SbObjectImageRatioDetail
Results details of object image ratio global measure.
- 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<SoImageVizEngine.ComputeModes>`	`computeMode`	Select the compute Mode (2D or 3D or AUTO) .
`SoSFImageDataAdapter`	`inBinaryImage`	The input binary image.
`SoSFImageDataAdapter`	`inMaskImage`	The binary image for the mask or empty (command looks for only inside).
`SoImageVizEngineAnalysisOutput<SoObjectImageRatioQuantification.SbObjectImageRatioDetail>`	`outResult`	The output measure result.

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

SoObjectImageRatioQuantification()
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
  - computeMode
```
public final SoSFEnum<SoImageVizEngine.ComputeModes> computeMode
```
    Select the compute Mode (2D or 3D or AUTO) . Default is MODE_AUTO
  - inBinaryImage
```
public final SoSFImageDataAdapter inBinaryImage
```
    The input binary image. Default value is NULL. Supported types include: binary color image.
  - inMaskImage
```
public final SoSFImageDataAdapter inMaskImage
```
    The binary image for the mask or empty (command looks for only inside). This parameter is optional. Default value is NULL. Supported types include: binary image.
  - outResult
```
public final SoImageVizEngineAnalysisOutput<SoObjectImageRatioQuantification.SbObjectImageRatioDetail> outResult
```
    The output measure result. Default value is NULL.
- Constructor Detail
  - SoObjectImageRatioQuantification
```
public SoObjectImageRatioQuantification()
```
    Constructor.