SoImageStackProjectionProcessing3d engine More...

#include <ImageViz/Engines/ImageManipulation/StackOperations/SoImageStackProjectionProcessing3d.h>

Inheritance diagram for SoImageStackProjectionProcessing3d:

Public Types
enum	ProjectionMode { INTENSITY_MAXIMA = 0 , GRADIENT_MAXIMA = 1 , PROJECTION = 2 , INTENSITY_MINIMA = 3 , MEDIAN = 4 , MEAN = 5 , VARIANCE = 6 , ENTROPY = 7 , ENERGY = 8 }

enum	GradientOperator { GAUSSIAN_GRADIENT = 0 , MORPHOLOGICAL_GRADIENT = 1 , RECURSIVE_GRADIENT = 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
	SoImageStackProjectionProcessing3d ()
	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	inImage
	A 3d volume representing a stack of 2d images.

SoSFEnum	projectionMode
	The type of process.

SoSFInt32	smoothingSize
	The size for the smooth process.

SoSFEnum	gradientOperator
	The type of process.

SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * >	outImage
	The output image.

SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * >	outLabelImage
	The output map label image.

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

SoImageStackProjectionProcessing3d engine

The SoImageStackProjectionProcessing3d engine creates a single image containing selected pixels from a stack of input images.

For example, when you make several acquisitions of the same object with different acquisition conditions, the images you get may not have the same focused areas. The SoImageStackProjectionProcessing3d engine examines all the images to get the best values of the sequence and build the resulting image.

When projectionMode is one of INTENSITY_MAXIMA, GRADIENT_MAXIMA or INTENSITY_MINIMA, the engine also generates an outLabelImage that shows the contribution source (i.e. the sequence number of the image from the input stack) on the result image outImage.

This engine can produce higher quality results than using the standard Maximum/Minimum Intensity Projection (MIP) rendering in VolumeViz.

For color images, it works in the HSL color space and uses only the lightness.

FILE FORMAT/DEFAULT

inImage	NULL
projectionMode	GRADIENT_MAXIMA
smoothingSize	5
gradientOperator	MORPHOLOGICAL_GRADIENT

Library references: zstack

Definition at line 76 of file SoImageStackProjectionProcessing3d.h.

Member Enumeration Documentation

◆ GradientOperator

enum SoImageStackProjectionProcessing3d::GradientOperator

Enumerator
GAUSSIAN_GRADIENT	Compute a gaussian gradient (convolution with derivatives of gaussian function along the stack direction).
MORPHOLOGICAL_GRADIENT	Compute a morphological gradient (see SoMorphologicalGradientProcessing for definition).
RECURSIVE_GRADIENT	Compute a recursive gradient (Canny-Deriche on stack direction).

Definition at line 146 of file SoImageStackProjectionProcessing3d.h.

◆ ProjectionMode

enum SoImageStackProjectionProcessing3d::ProjectionMode

Enumerator
INTENSITY_MAXIMA	Select the pixel with the highest value of the sequence.
GRADIENT_MAXIMA	Select the pixel with the highest gradient. This mode enables the gradientOperator field.
PROJECTION	Sum all values of the sequence.
INTENSITY_MINIMA	Select the pixel with the lowest value of the sequence.
MEDIAN	Select the pixel which is the median of the sequence.
MEAN	Compute the average of the sequence.
VARIANCE	Compute the variance of the sequence.
ENTROPY	Compute the entropy of the sequence based on this formula: $Entropy= -\sum_{i \in seq} {P(x_i)*log(P(x_i))}$ where is the probability to have a pixel with value (it's the number of those pixels divided by the total number of pixels).
ENERGY	Compute the energy of the sequence based on this formula: $Energy= \sum_{i \in seq} {P(x_i)^2}$