Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoCenterLineApproximation3d Class Reference

ImageViz SoCenterLineApproximation3d engine More...

#include <ImageViz/Engines/ImageSegmentation/ComputationalGeometry/SoCenterLineApproximation3d.h>

+ Inheritance diagram for SoCenterLineApproximation3d:

Public Member Functions

 SoCenterLineApproximation3d ()
 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.
 
SoEngineOutputgetOutput (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).
 
SoEnginecopy () 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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 inLabelImage
 Input label image.
 
SoSFBool autoMode
 If this parameter is set to true the number of branches is computed automatically (the parameter newBranchSensibility controls the adding of new branches) otherwise branches are added until numberOfBranches connections is reached.
 
SoSFUInt32 numberOfBranches
 Number of branches iteratively added to the reconstructed centerline tree.
 
SoSFDouble newBranchSensibility
 This parameter controls the adding of a new branch in the tree in automatic mode.
 
SoSFDouble distanceMapSmoothing
 This parameter controls the smoothing of the distance map which is computed internally to make the tree centered.
 
SoSFUInt32 smoothingIteration
 Number of smoothing iteration of the output line set (post processing).
 
SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * > outBinaryImage
 Output centerline.
 
SoImageVizEngineOutput< SoSFFieldContainer, SoIndexedLineSet * > outLineSet
 Output line set.
 
- 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

- 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...
 
- 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 SoEnginegetByName (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

ImageViz SoCenterLineApproximation3d engine

The engine extracts the centerline of a label image. A centerline is a path with a tree topology that approximates the input shape. The extraction procedure enforces the path to be equidistant to its boundaries.

The engine searches for a graph with tree topology (without loops). If the object contains loops this algorithms will not fail, instead it will just ignore certain connectivity so that the tree topology of graph is preserved.

The engine searches iteratively for the longest branch that can be added to the tree.

FILE FORMAT/DEFAULT

    CenterLineApproximation3d {
    inBinaryImage NULL
    autoMode FALSE
    numberOfBranches 1
    newBranchSensibility 3.0
    distanceMapSmoothing 0.3
    smoothingIteration 3
    }

    Notice: This engine requires to preliminarily load the whole input data set into memory to be computed. As a consequence the input data set will be automatically loaded before the execution of this engine, ignoring the maximum memory parameter of the SbImageDataAdapterHelper::getAppropriateAdapter function or SoFileDataAdapter class

    If the input data set cannot fit in memory, this engine will fail during its computation.


Library references: centerline3d

Definition at line 78 of file SoCenterLineApproximation3d.h.

Constructor & Destructor Documentation

◆ SoCenterLineApproximation3d()

SoCenterLineApproximation3d::SoCenterLineApproximation3d ( )

Constructor.

Member Data Documentation

◆ autoMode

SoSFBool SoCenterLineApproximation3d::autoMode

If this parameter is set to true the number of branches is computed automatically (the parameter newBranchSensibility controls the adding of new branches) otherwise branches are added until numberOfBranches connections is reached.

Default value is false.

Definition at line 97 of file SoCenterLineApproximation3d.h.

◆ distanceMapSmoothing

SoSFDouble SoCenterLineApproximation3d::distanceMapSmoothing

This parameter controls the smoothing of the distance map which is computed internally to make the tree centered.

Smoothing of the distance map can be useful when the distance map is not sufficiently smooth ( generally it leads to oscillation in the tree ). The filter is a Gaussian filter of standard deviation euclideanDistanceMapSigmaSmoothing. Default value is 0.3.

Definition at line 119 of file SoCenterLineApproximation3d.h.

◆ inLabelImage

SoSFImageDataAdapter SoCenterLineApproximation3d::inLabelImage

Input label image.

One centerline will be extracted by label. Default is NULL.

Definition at line 90 of file SoCenterLineApproximation3d.h.

◆ newBranchSensibility

SoSFDouble SoCenterLineApproximation3d::newBranchSensibility

This parameter controls the adding of a new branch in the tree in automatic mode.

A new branch is added to the tree only if its length (b in scheme) is newBranchSensibility time farther than the closest boundary point at junction (a in scheme). Default value is 3.0.

Figure 1: New branch sensibility

Definition at line 111 of file SoCenterLineApproximation3d.h.

◆ numberOfBranches

SoSFUInt32 SoCenterLineApproximation3d::numberOfBranches

Number of branches iteratively added to the reconstructed centerline tree.

This parameter is not used if autoMode is set to true. Default value is 1.

Definition at line 103 of file SoCenterLineApproximation3d.h.

◆ outBinaryImage

SoImageVizEngineOutput<SoSFImageDataAdapter, SoImageDataAdapter*> SoCenterLineApproximation3d::outBinaryImage

Output centerline.

The resulting image is a binary image that represents the extracted centerline. Default value is NULL.

Definition at line 131 of file SoCenterLineApproximation3d.h.

◆ outLineSet

SoImageVizEngineOutput<SoSFFieldContainer, SoIndexedLineSet*> SoCenterLineApproximation3d::outLineSet

Output line set.

This output is the geometric counterpart of the output binary image. Default value is NULL.

Definition at line 138 of file SoCenterLineApproximation3d.h.

◆ smoothingIteration

SoSFUInt32 SoCenterLineApproximation3d::smoothingIteration

Number of smoothing iteration of the output line set (post processing).

A smoothing iteration applies a mean filter of size 3 on vertices. Default value is 3.

Definition at line 125 of file SoCenterLineApproximation3d.h.


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