SoDataMeasure Class Reference

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

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

Inheritance diagram for SoDataMeasure:

Public Types
enum	UnitDimension {   SQUAREINTENSITY ,   INTENSITY ,   VOLUME ,   AREA ,   PERIMETER ,   NOUNIT ,   DEGREES ,   PIXELS }
	"Unit dimension" is used to categorize the resulting unit of a measure. More...
enum	ResultFormat {   INT ,   FLOAT ,   STRING ,   INT64 ,   UINT64 ,   DOUBLE }
	The "result format" is the type of the output of a measure computation. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
virtual const SbString &	getMeasureName () const =0
	Returns the name of this measure.
virtual UnitDimension	getUnitDimension () const =0
	Returns the "unit dimension" of the result data.
virtual ResultFormat	getFormat () const =0
	Returns the "result format" of the result data.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Abstract base class for all ImageViz image data measures.

SEE ALSO

SoAnalyzeQuantification, SoAnalyzeFilterQuantification, SoGlobalAnalysisQuantification, SoFilterByMeasureProcessing, SoSieveLabelingProcessing, SoAdaptiveThresholdingProcessing

Definition at line 40 of file SoDataMeasure.h.

Member Enumeration Documentation

ResultFormat

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

Definition at line 81 of file SoDataMeasure.h.

UnitDimension

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).

Definition at line 54 of file SoDataMeasure.h.

Member Function Documentation

getClassTypeId()

static SoType SoDataMeasure::getClassTypeId ( )

static

Returns the type identifier for this class.

getFormat()

virtual ResultFormat SoDataMeasure::getFormat ( ) const

pure virtual

Returns the "result format" of the result data.

Implemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

getMeasureName()

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.

getTypeId()

virtual SoType SoDataMeasure::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Reimplemented in SoDataMeasureCustom, and SoDataMeasurePredefined.

getUnitDimension()

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