SoDataMeasure Class Reference
[Measures]

Abstract base class for all ImageViz image data measures. More...

#include <ImageViz/Nodes/Measures/SoDataMeasure.h>

Inheritance diagram for SoDataMeasure:

List of all members.

Public Types
enum	UnitDimension {   SQUAREINTENSITY,   INTENSITY,   VOLUME,   AREA,   PERIMETER,   NOUNIT,   DEGREES,   PIXELS }
enum	ResultFormat {   INT,   FLOAT,   STRING,   INT64,   UINT64,   DOUBLE }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SbString &	getMeasureName () const =0
virtual UnitDimension	getUnitDimension () const =0
virtual ResultFormat	getFormat () const =0
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

Abstract base class for all ImageViz image data measures.

SEE ALSO

SoAnalyzeQuantification, SoAnalyzeFilterQuantification, SoGlobalAnalysisQuantification, SoFilterByMeasureProcessing, SoSieveLabelingProcessing, SoAdaptiveThresholdingProcessing

---

Member Enumeration Documentation

enum SoDataMeasure::ResultFormat

The "result format" is the type of the output of a measure computation.

It can be an integer value, a floating value, or a string. This gives to the user of the VpSpreadSheet class which method must be called to retrieve the measure result, getValueAsInt, getValueAsFloat, or getValueAsString. Calling another method than the right value accessor will result in a InvalidCallException.

Enumerator:

INT
FLOAT
STRING
INT64
UINT64
DOUBLE

enum SoDataMeasure::UnitDimension

"Unit dimension" is used to categorize the resulting unit of a measure.

This is not the exact resulting unit, which depends on the input data unit. ex: an area computation on a data in mm will result in a measure in mm² ; the unit dimension is the relation between the intput and output units, in this example the square of the length unit, ie "Area". If the input data length unit is cm, the result will be cm², the unit dimension is the same and only depends on the measure algorithm, not on data.

Enumerator:

SQUAREINTENSITY	Output unit is the square of the input data value unit.
INTENSITY	Output unit is the same as the input data value unit.
VOLUME	Output unit is the cube as the input data length unit.
AREA	Output unit is the square as the input data length unit.
PERIMETER	Output unit is the same as the input length value unit.
NOUNIT	for measure without units (count for ex.)
DEGREES	Output is an angle in degrees (not radians).
PIXELS	Output is a pixel position or length (independent from the input length value unit).

---

Member Function Documentation

static SoType SoDataMeasure::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoFieldContainer.

Reimplemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

virtual ResultFormat SoDataMeasure::getFormat

(

)

const [pure virtual]

Returns the "result format" of the result data.

Implemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

virtual const SbString& SoDataMeasure::getMeasureName

(

)

const [pure virtual]

Returns the name of this measure.

This name can be then used in custom measure formula

Implemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

virtual SoType SoDataMeasure::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Reimplemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

virtual UnitDimension SoDataMeasure::getUnitDimension

(

)

const [pure virtual]

Returns the "unit dimension" of the result data.

Implemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

---

The documentation for this class was generated from the following file:

• ImageViz/Nodes/Measures/SoDataMeasure.h