Abstract base class for all ImageViz engines. More...

#include <ImageViz/Engines/SoImageVizEngine.h>

Inheritance diagram for SoImageVizEngine:

Classes
struct	EventArg
	Structure given to callback when an event is raised. More...

Public Types
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
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.

Static Public Member Functions
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.

Public Attributes
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.

Detailed Description

Abstract base class for all ImageViz engines.

Member Enumeration Documentation

◆ ComputeMode

enum SoImageVizEngine::ComputeMode

Compute Mode This enum specifies whether the main input will be interpreted as a 3D volume or a stack of 2D images for processing.

Enumerator

MODE_2D

The engine processes the input image as a stack of 2D images (slice by slice).

MODE_3D

The engine processes the input image as a 3D volume.

MODE_AUTO

The inputs determine if the processing should be applied in 2D or 3D mode.

Depending on the expected results, it may be necessary to set explicitly MODE_2D or MODE_3D.

Definition at line 53 of file SoImageVizEngine.h.

◆ Neighborhood3d

enum SoImageVizEngine::Neighborhood3d

Neighborhood Connectivity 3D.

Enumerator
CONNECTIVITY_6	Voxels with a common face are considered connected.
CONNECTIVITY_18	Voxels with at least one common edge are considered connected.
CONNECTIVITY_26	Voxels with at least one common vertex are considered connected.

Definition at line 70 of file SoImageVizEngine.h.

Member Function Documentation

◆ abortEvaluate()

virtual void SoImageVizEngine::abortEvaluate ( )

virtual

Abort current processing as soon as possible.

If no processing is currently running, do nothing.

◆ getClassTypeId()

static SoType SoImageVizEngine::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoImageVizEngine::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ isEvaluating()

virtual bool SoImageVizEngine::isEvaluating ( )

virtual

Returns true if the engine evaluation is in progress.

◆ startEvaluate()

virtual void SoImageVizEngine::startEvaluate ( )

virtual

Evaluate engine and dependencies in another thread without blocking the current one.

Event onEnd is raised when processing ends and result is available.

◆ waitEvaluate()

virtual void SoImageVizEngine::waitEvaluate ( )

virtual

Wait for the end of engine evaluation.

This method blocks the current thread.

Member Data Documentation

◆ onBegin

SbEventHandler<EventArg&> SoImageVizEngine::onBegin

Event raised when the processing begins.

Definition at line 120 of file SoImageVizEngine.h.

◆ onEnd

SbEventHandler<EventArg&> SoImageVizEngine::onEnd

Event raised when processing ends and the result is available.

Important note: Do not use waitEvaluate() method in this event because this can cause a dead-lock during evaluation.

Definition at line 127 of file SoImageVizEngine.h.

◆ onProgress

SbEventHandler<EventArg&> SoImageVizEngine::onProgress

Event raised while processing is running.

Nb: This event is regularly called during processing. It can be used to observe progression of the computing (e.g. to display a progress bar).

Definition at line 134 of file SoImageVizEngine.h.

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

ImageViz/Engines/SoImageVizEngine.h

Open Inventor Release 2023.2.3

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

SEE ALSO

Member Enumeration Documentation

◆ ComputeMode

◆ Neighborhood3d

Member Function Documentation

◆ abortEvaluate()

◆ getClassTypeId()

◆ getTypeId()

◆ isEvaluating()

◆ startEvaluate()

◆ waitEvaluate()

Member Data Documentation

◆ onBegin

◆ onEnd

◆ onProgress