SoDataMeasureCustom Class Reference
[Measures]

ImageViz class to define a custom measure. More...

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

Inheritance diagram for SoDataMeasureCustom:
SoDataMeasure SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
 SoDataMeasureCustom ()
virtual const SbStringgetMeasureName () const
virtual UnitDimension getUnitDimension () const
virtual ResultFormat getFormat () const

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFString measureName
SoSFString formula

Detailed Description

ImageViz class to define a custom measure.

A custom measure is defined by a string formula that can use other custom or predefined measure. It must have a unique name.

     // Example of code to define a custom measure using two predefined measure and
     // defined as the ratio of the Volume/Area.
     SoDataMeasureCustom* myMeasure1 = new SoDataMeasureCustom();
     myMeasure1->measureName = "myMeasure1";
     myMeasure1->formula = SoDataMeasurePredefined::getName(SoDataMeasurePredefined::VOLUME) + "/" + SoDataMeasurePredefined::getName(SoDataMeasurePredefined::AREA);

     // myMeasure1 can in turn be used to define an other custom measure, define as 2*myMeasure1
     SoDataMeasureCustom* myMeasure2 = new SoDataMeasureCustom();
     myMeasure2->measureName = "myMeasure2";
     myMeasure2->formula = myMeasure1.getMeasureName() + "*2";

Custom formula syntax

Basic operators

Constant values

Functions

SEE ALSO

SoDataMeasurePredefined, SoLabelAnalysisQuantification, SoFilterAnalysisQuantification, SoGlobalAnalysisQuantification, SoFilterByMeasureProcessing, SoSieveLabelingProcessing, SoAdaptiveThresholdingProcessing

See related examples:

CustomMeasure


Constructor & Destructor Documentation

SoDataMeasureCustom::SoDataMeasureCustom (  ) 

Default constructor.


Member Function Documentation

static SoType SoDataMeasureCustom::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoDataMeasure.

virtual ResultFormat SoDataMeasureCustom::getFormat (  )  const [virtual]

Returns the "result format" of the result data. . Default is FLOAT

Implements SoDataMeasure.

virtual const SbString& SoDataMeasureCustom::getMeasureName (  )  const [inline, virtual]

Returns the name of this measure. This name can be then used in custom measure formula

Implements SoDataMeasure.

virtual SoType SoDataMeasureCustom::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoDataMeasure.

virtual UnitDimension SoDataMeasureCustom::getUnitDimension (  )  const [virtual]

Returns the "unit dimension" of the result data. . Default is NOUNIT

Implements SoDataMeasure.


Member Data Documentation

Formula describing the custom measure.

Measure name that can be used in custom measure combination formula.


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

Open Inventor Toolkit reference manual, generated on 17 Dec 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/