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

ImageViz SoFractalDimensionQuantification engine More...

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

+ Inheritance diagram for SoFractalDimensionQuantification:

Classes

class  SbFractalDetail
 Results details of fractal dimension. More...
 

Public Member Functions

 SoFractalDimensionQuantification ()
 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

SoSFEnum computeMode
 Select the compute Mode (2D or 3D or AUTO) Use enum ComputeMode.
 
SoSFImageDataAdapter inBinaryImage
 The input binary image.
 
SoSFBool useOnlyBorders
 Select if use only the object borders to compute measure.
 
SoImageVizEngineAnalysisOutput< SbFractalDetailoutResult
 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

- 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 SoFractalDimensionQuantification engine

The SoFractalDimensionQuantification engine measures fractal dimension.

For an introduction, see:

This engine computes the fractal dimension of a binary 2D or 3D image. It should be used only if the feature is known as being potentially a fractal one. This is the case of complex and irregular curves which cannot be easily described with traditional geometric tools, and/or for curves which are very similar to a part of themselves at different scales.

2D definition:
The 2D fractal dimension is a number greater than 1 and strictly lower than 2. The result is 1 in case of standard geometric features (straight lines, broken lines, circles, ...). Applied to 2D images the fractal dimension is quite an effective indicator to measure and compare the irregularity and the fragmentation at different magnifications. It is also a good indicator to evaluate how the curve fills the space. The less smooth the curve is, the bigger the fractal dimension.

Caution: Do not use this engine on surfaces but on contours, according to the fractal definition. To be able to compare results, the outlines thickness should be very similar between the studied images and as small as possible so as to keep as much information as possible.

3D definition:
The 3D fractal dimension is a number greater than 2 and strictly lower than 3. The result is 2 in case of standard geometric surfaces (cubes, planes, ellipsoids, ...). Applied to 3D images the fractal dimension is quite an effective indicator to measure and compare the roughness of a surface. It is also a good indicator to evaluate how the curve fills the space. The less smooth the surface is, the bigger the fractal dimension. It can also be interpreted as a quantification of how complex the surface is and how it fills the space.

Caution: Do not use this engine on volumes but on surfaces, according to the fractal definition. To be able to compare results, the surface thickness should be very similar between the studied images and as small as possible so as to keep as much information as possible.

SEE ALSO

SoStructureModelIndexQuantification3d.

FILE FORMAT/DEFAULT

    FractalDimensionQuantification {
    computeMode MODE_AUTO
    inBinaryImage NULL
    useOnlyBorders TRUE
    }


Library references: fractal

Definition at line 100 of file SoFractalDimensionQuantification.h.

Constructor & Destructor Documentation

◆ SoFractalDimensionQuantification()

SoFractalDimensionQuantification::SoFractalDimensionQuantification ( )

Constructor.

Member Data Documentation

◆ computeMode

SoSFEnum SoFractalDimensionQuantification::computeMode

Select the compute Mode (2D or 3D or AUTO) Use enum ComputeMode.

Default is MODE_AUTO

Definition at line 112 of file SoFractalDimensionQuantification.h.

◆ inBinaryImage

SoSFImageDataAdapter SoFractalDimensionQuantification::inBinaryImage

The input binary image.

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

Definition at line 135 of file SoFractalDimensionQuantification.h.

◆ outResult

SoImageVizEngineAnalysisOutput<SbFractalDetail> SoFractalDimensionQuantification::outResult

The output measure result.

Default value is NULL.

Definition at line 141 of file SoFractalDimensionQuantification.h.

◆ useOnlyBorders

SoSFBool SoFractalDimensionQuantification::useOnlyBorders

Select if use only the object borders to compute measure.

Default value is TRUE.

Definition at line 138 of file SoFractalDimensionQuantification.h.


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