class to handle label analysis. More...

#include <ImageViz/Nodes/Analysis/SoLabelAnalysisResult.h>

Inheritance diagram for SoLabelAnalysisResult:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoLabelAnalysisResult ()
	Constructor.

int	getNumMeasure () const
	Returns the number of measures results.

SbString	getMeasureName (int measureIndex) const
	Returns the ith measure name.

int	getMeasureIndex (const SbString &measureName) const
	Returns the index of the measure named measureName.

int	getNumMeasureComponent (int measureIndex) const
	Returns the number of components values for the given measure index.

size_t	getNumLabels () const
	Returns the total number of different labels in the label analysis result.

size_t	getNumImageAnalysis () const
	Returns the number of image that where analysed.

size_t	getNumLabels (int sequenceIndex) const
	Returns the number of different labels in the label analysis result for the given image index.

SoDataMeasure::ResultFormat	getMeasureFormat (int measureIndex) const
	Returns the measure format of the given resulting measure index.

SoDataMeasure::UnitDimension	getMeasureUnitDimension (int measureIndex) const
	Returns the measure unit dimension of the given resulting measure index.

SbString	getValueAsString (int labelIndex, int measureIndex, int measureComponent) const
	Returns the result as a string value for the given measure and measure's component.

int64_t	getValueAsInteger (int labelIndex, int measureIndex, int measureComponent) const
	Returns the result as an integer value for the given measure and measure's component.

uint64_t	getValueAsUInt (int labelIndex, int measureIndex, int measureComponent) const
	Returns the result as an unsigned integer value for the given measure and measure's component.

double	getValueAsDouble (int labelIndex, int measureIndex, int measureComponent) const
	Returns the result as a floating value for the given measure and measure's component.

Public Member Functions inherited from SoAnalysisResult
bool	saveAsCsv (const SbString &csvfilename, const SbString &csvSeparator) const
	Save results as a spreadsheet csv file.

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 SoAnalysisResult
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

class to handle label analysis.

Constructor & Destructor Documentation

◆ SoLabelAnalysisResult()

SoLabelAnalysisResult::SoLabelAnalysisResult ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoLabelAnalysisResult::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getMeasureFormat()

SoDataMeasure::ResultFormat SoLabelAnalysisResult::getMeasureFormat ( int measureIndex ) const

Returns the measure format of the given resulting measure index.

◆ getMeasureIndex()

int SoLabelAnalysisResult::getMeasureIndex ( const SbString & measureName ) const

Returns the index of the measure named measureName.

-1 is returned if the given measure is not in the analysis.

◆ getMeasureName()

SbString SoLabelAnalysisResult::getMeasureName ( int measureIndex ) const

Returns the ith measure name.

measureIndex is in the range 0..getNumMeasure().

◆ getMeasureUnitDimension()

SoDataMeasure::UnitDimension SoLabelAnalysisResult::getMeasureUnitDimension ( int measureIndex ) const

Returns the measure unit dimension of the given resulting measure index.

◆ getNumImageAnalysis()

size_t SoLabelAnalysisResult::getNumImageAnalysis ( ) const

Returns the number of image that where analysed.

◆ getNumLabels() [1/2]

size_t SoLabelAnalysisResult::getNumLabels ( ) const

Returns the total number of different labels in the label analysis result.

this is the sum of the label count in each image analysed.

◆ getNumLabels() [2/2]

size_t SoLabelAnalysisResult::getNumLabels ( int sequenceIndex ) const

Returns the number of different labels in the label analysis result for the given image index.

◆ getNumMeasure()

int SoLabelAnalysisResult::getNumMeasure ( ) const

Returns the number of measures results.

◆ getNumMeasureComponent()

int SoLabelAnalysisResult::getNumMeasureComponent ( int measureIndex ) const

Returns the number of components values for the given measure index.

◆ getTypeId()

virtual SoType SoLabelAnalysisResult::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoAnalysisResult.

◆ getValueAsDouble()

double SoLabelAnalysisResult::getValueAsDouble	(	int	labelIndex,
		int	measureIndex,
		int	measureComponent
	)		const

Returns the result as a floating value for the given measure and measure's component.

◆ getValueAsInteger()

int64_t SoLabelAnalysisResult::getValueAsInteger	(	int	labelIndex,
		int	measureIndex,
		int	measureComponent
	)		const

Returns the result as an integer value for the given measure and measure's component.

◆ getValueAsString()

SbString SoLabelAnalysisResult::getValueAsString	(	int	labelIndex,
		int	measureIndex,
		int	measureComponent
	)		const

Returns the result as a string value for the given measure and measure's component.

◆ getValueAsUInt()

uint64_t SoLabelAnalysisResult::getValueAsUInt	(	int	labelIndex,
		int	measureIndex,
		int	measureComponent
	)		const

Returns the result as an unsigned integer value for the given measure and measure's component.

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

ImageViz/Nodes/Analysis/SoLabelAnalysisResult.h

Open Inventor Release 2023.2.3

Public Member Functions

Static Public Member Functions