SoAverageSpaceThicknessQuantification3d engine More...

#include <ImageViz/Engines/ImageAnalysis/Morphometry/SoAverageSpaceThicknessQuantification3d.h>

Inheritance diagram for SoAverageSpaceThicknessQuantification3d:

Classes
class	SbAverageSpaceThicknessDetail
	Results details of average space thickness global measure. More...

Public Types
enum	Model { PARALLEL_PLATE_MODEL = 0 , CYLINDER_ROD_MODEL = 1 , SPHERE_MODEL = 2 }

Public Types inherited from SoImageVizEngine
enum	ComputeMode { MODE_2D = 0 , MODE_3D = 1 , MODE_AUTO = 2 }
	Compute Mode This enum specifies whether the main input will be interpreted as a 3D volume or a stack of 2D images for processing. More...

enum	Neighborhood3d { CONNECTIVITY_6 = 0 , CONNECTIVITY_18 = 1 , CONNECTIVITY_26 = 2 }
	Neighborhood Connectivity 3D. More...

Public Member Functions
	SoAverageSpaceThicknessQuantification3d ()
	Constructor.

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

virtual void	startEvaluate ()
	Evaluate engine and dependencies in another thread without blocking the current one.

virtual void	waitEvaluate ()
	Wait for the end of engine evaluation.

virtual void	abortEvaluate ()
	Abort current processing as soon as possible.

virtual bool	isEvaluating ()
	Returns true if the engine evaluation is in progress.

Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.

SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a reference to the engine output with the given name.

SbBool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in outputName) the name of the engine output (output).

SoEngine *	copy () const
	Creates and returns an exact copy of the engine.

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.

Public Attributes
SoSFImageDataAdapter	inObjectImage
	The input 3D binary image.

SoSFImageDataAdapter	inMaskImage
	The binary image for the mask or empty (command looks for only inside).

SoSFEnum	model
	The trabecular model.

SoImageVizEngineAnalysisOutput< SbAverageSpaceThicknessDetail >	outResult
	The output measure result.

Public Attributes inherited from SoImageVizEngine
SbEventHandler< EventArg & >	onBegin
	Event raised when the processing begins.

SbEventHandler< EventArg & >	onEnd
	Event raised when processing ends and the result is available.

SbEventHandler< EventArg & >	onProgress
	Event raised while processing is running.

Additional Inherited Members
Static Public Member Functions inherited from SoImageVizEngine
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.

static SoEngine *	getByName (const SbName &name)
	Looks up engine(s) by name.

static int	getByName (const SbName &name, SoEngineList &list)
	Looks up engine(s) by name.

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

SoAverageSpaceThicknessQuantification3d engine

The SoAverageSpaceThicknessQuantification3d engine measures the structure separation.

For an introduction, see section Morphometry.

This engine measures the structure separation. It represents the thickness of the spaces as defined by binarisation within the image. It can be calculated either from 2D images with model assumptions or directly in 3D. Applying the surface area-based models as for the SoAverageObjectThicknessQuantification3d engine, structure separation is calculated :

Parallel plate model :

$\mbox{AST} = \left(\frac{1}{\mbox{Object Linear Density}}\right)-\mbox{Average Object Thickness}$

Cylinder rod model :

$\mbox{AST} = \mbox{Average Object Thickness}\left(\left[\frac{4}{\pi}\right]\times\left[\frac{TV}{Obj\cdot V}\right]-1\right)$

where $TV$ is total volume of image and $Obj.V$ is object volume.

Note: Each of the above definitions uses the corresponding definition of SoAverageObjectThicknessQuantification3d using plate or rod model.

Note: In practice in trabecular bone analysis it is unsafe to employ 2D model assumptions, especially because the "plate-like" or "rod-like" character of trabecular bone can change both between bone samples and from one end of a studied bone volume to the other (see SoStructureModelIndexQuantification3d).

FILE FORMAT/DEFAULT

inObjectImage	NULL
inMaskImage	NULL
model	PARALLEL_PLATE_MODEL

Library references: average_space_thickness

Definition at line 87 of file SoAverageSpaceThicknessQuantification3d.h.

Member Enumeration Documentation

◆ Model

enum SoAverageSpaceThicknessQuantification3d::Model

Enumerator
PARALLEL_PLATE_MODEL	The computation uses a parallel plate model.
CYLINDER_ROD_MODEL	The computation uses a cylinder rod model.
SPHERE_MODEL	The computation uses a sphere model.

Definition at line 125 of file SoAverageSpaceThicknessQuantification3d.h.

Constructor & Destructor Documentation

◆ SoAverageSpaceThicknessQuantification3d()

SoAverageSpaceThicknessQuantification3d::SoAverageSpaceThicknessQuantification3d ( )

Constructor.

Member Data Documentation

◆ inMaskImage

SoSFImageDataAdapter SoAverageSpaceThicknessQuantification3d::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.

Definition at line 120 of file SoAverageSpaceThicknessQuantification3d.h.

◆ inObjectImage

SoSFImageDataAdapter SoAverageSpaceThicknessQuantification3d::inObjectImage

The input 3D binary image.

Default value is NULL. Supported types include: binary image.

Definition at line 117 of file SoAverageSpaceThicknessQuantification3d.h.

◆ model

SoSFEnum SoAverageSpaceThicknessQuantification3d::model

The trabecular model.

Use enum Model. Default is PARALLEL_PLATE_MODEL

Definition at line 143 of file SoAverageSpaceThicknessQuantification3d.h.

◆ outResult

SoImageVizEngineAnalysisOutput<SbAverageSpaceThicknessDetail> SoAverageSpaceThicknessQuantification3d::outResult

The output measure result.

Default value is NULL.

Definition at line 146 of file SoAverageSpaceThicknessQuantification3d.h.

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

ImageViz/Engines/ImageAnalysis/Morphometry/SoAverageSpaceThicknessQuantification3d.h

Open Inventor Release 2023.2.3

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members