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

ImageViz SoSurfaceFittingApproximation3d surface approximation. More...

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

+ Inheritance diagram for SoSurfaceFittingApproximation3d:

Public Types

enum  DetectionType {
  MAXIMUM ,
  MINIMUM
}
 
enum  BoundaryCondition {
  DIRICHLET ,
  NEUMANN
}
 Define the type of supported boundaries condition. More...
 
enum  RegularizationType {
  LAPLACIAN ,
  LAPLACIAN_2
}
 The type of regularization applied to the mesh. More...
 
- 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

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

SoSFStructuredQuadrilateralMesh inSurface
 Input surface.
 
SoSFImageDataAdapter inFeatureImage
 Input 3D image containing weight values.
 
SoSFDouble distance
 Defines the maximum distance that vertices can be moved.
 
SoSFVec2d thresholdLevel
 Defines a range of values that can be considered for the best fit.
 
SoSFFloat smoothing
 A regularization is applied on the fitted mesh in order to smooth it and limit the effect of outliers.
 
SoMFVec3f directions
 Defines the search direction for each vertex.
 
SoSFEnum detectionType
 Defines the criterion on which a vertex will be kept as the best fit.
 
SoSFEnum leftBoundaryCondition
 The type of boundary conditions for the left boundary.
 
SoSFEnum rightBoundaryCondition
 The type of boundary conditions for the right boundary.
 
SoSFEnum topBoundaryCondition
 The type of boundary conditions for the top boundary.
 
SoSFEnum bottomBoundaryCondition
 The type of boundary conditions for the bottom boundary.
 
SoSFEnum regularizationType
 The type of regularization used to enforce the smoothness of the mesh.
 
SoMFFloat dirichletValues
 Dirichlet values for left, right, top and bottom boundary conditions.
 
SoImageVizEngineOutput< SoSFStructuredQuadrilateralMesh, SbStructuredQuadrilateralMesh * > outSurface
 Output surface with fitted vertices.
 
SoImageVizEngineMFieldOutput< SoMFVec3f, const SbVec3f * > outDirections
 Directions along which the most fitted value was searched.
 
- 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 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 SoSurfaceFittingApproximation3d surface approximation.

This engine adjusts the positions of the vertices in a structured quadrilateral mesh based on "weight" values given in a volume. These values normally represent some features / structures in the volume, e.g. weights could be the distance to the outside of a wall.

The engine will search for a best fit along a direction specified for each vertex (the vertex surface normal by be default) up to a distance defined by the parameter distance. A voxel will be considered as a best fit based on a criterion given by the detectionType. A regularization can be applied on the resulting surface to smooth it and limit the effect of outliers.

FILE FORMAT/DEFAULT

    SoSurfaceFittingApproximation3d {
    inSurface NULL
    inFeatureImage NULL
    distance 1.0
    thresholdLevel SbVec2d( 0.0, std::numeric_limits<double>::max() )
    smoothing 1.0f
    directions SbVec3f( 0.0f, 0.0f, 0.0f )
    detectionType MAXIMUM
    }

SEE ALSO

SoPolylineExtrusionApproximation3d, SoSurfaceUnfoldingProcessing3d


Library references:

Definition at line 80 of file SoSurfaceFittingApproximation3d.h.

Member Enumeration Documentation

◆ BoundaryCondition

Define the type of supported boundaries condition.

Enumerator
DIRICHLET 
NEUMANN 

Definition at line 151 of file SoSurfaceFittingApproximation3d.h.

◆ DetectionType

Enumerator
MAXIMUM 

Uses the maximum value.

MINIMUM 

Uses the minimum value.

Definition at line 136 of file SoSurfaceFittingApproximation3d.h.

◆ RegularizationType

The type of regularization applied to the mesh.

Enumerator
LAPLACIAN 
LAPLACIAN_2 

Definition at line 186 of file SoSurfaceFittingApproximation3d.h.

Constructor & Destructor Documentation

◆ SoSurfaceFittingApproximation3d()

SoSurfaceFittingApproximation3d::SoSurfaceFittingApproximation3d ( )

Constructor.

Member Data Documentation

◆ bottomBoundaryCondition

SoSFEnum SoSurfaceFittingApproximation3d::bottomBoundaryCondition

The type of boundary conditions for the bottom boundary.

Definition at line 181 of file SoSurfaceFittingApproximation3d.h.

◆ detectionType

SoSFEnum SoSurfaceFittingApproximation3d::detectionType

Defines the criterion on which a vertex will be kept as the best fit.

Use enum DetectionType. Default is MAXIMUM.

Definition at line 134 of file SoSurfaceFittingApproximation3d.h.

◆ directions

SoMFVec3f SoSurfaceFittingApproximation3d::directions

Defines the search direction for each vertex.

If the field is empty or if its size is different from the input surface number of vertices, the vertex normals are used as directions. Default value is SbVec3f( 0.0f, 0.0f, 0.0f ), so by default vertex normals are computed for the surface.

Definition at line 128 of file SoSurfaceFittingApproximation3d.h.

◆ dirichletValues

SoMFFloat SoSurfaceFittingApproximation3d::dirichletValues

Dirichlet values for left, right, top and bottom boundary conditions.

Definition at line 206 of file SoSurfaceFittingApproximation3d.h.

◆ distance

SoSFDouble SoSurfaceFittingApproximation3d::distance

Defines the maximum distance that vertices can be moved.

This distance is expressed in world coordinates of the input mesh. Default is 1.

Definition at line 103 of file SoSurfaceFittingApproximation3d.h.

◆ inFeatureImage

SoSFImageDataAdapter SoSurfaceFittingApproximation3d::inFeatureImage

Input 3D image containing weight values.

Definition at line 97 of file SoSurfaceFittingApproximation3d.h.

◆ inSurface

SoSFStructuredQuadrilateralMesh SoSurfaceFittingApproximation3d::inSurface

Input surface.

Definition at line 92 of file SoSurfaceFittingApproximation3d.h.

◆ leftBoundaryCondition

SoSFEnum SoSurfaceFittingApproximation3d::leftBoundaryCondition

The type of boundary conditions for the left boundary.

Definition at line 166 of file SoSurfaceFittingApproximation3d.h.

◆ outDirections

SoImageVizEngineMFieldOutput< SoMFVec3f, const SbVec3f*> SoSurfaceFittingApproximation3d::outDirections

Directions along which the most fitted value was searched.

Definition at line 217 of file SoSurfaceFittingApproximation3d.h.

◆ outSurface

Output surface with fitted vertices.

Definition at line 211 of file SoSurfaceFittingApproximation3d.h.

◆ regularizationType

SoSFEnum SoSurfaceFittingApproximation3d::regularizationType

The type of regularization used to enforce the smoothness of the mesh.

Definition at line 201 of file SoSurfaceFittingApproximation3d.h.

◆ rightBoundaryCondition

SoSFEnum SoSurfaceFittingApproximation3d::rightBoundaryCondition

The type of boundary conditions for the right boundary.

Definition at line 171 of file SoSurfaceFittingApproximation3d.h.

◆ smoothing

SoSFFloat SoSurfaceFittingApproximation3d::smoothing

A regularization is applied on the fitted mesh in order to smooth it and limit the effect of outliers.

The smoothing factor defines the strength of this regularization. The greater the value is the greater the smoothing will be. A smoothing value of 0 will disable the regularization. Default is 1.

Definition at line 120 of file SoSurfaceFittingApproximation3d.h.

◆ thresholdLevel

SoSFVec2d SoSurfaceFittingApproximation3d::thresholdLevel

Defines a range of values that can be considered for the best fit.

A value outside of this range will be considered as an outlier. Default is full range of double precision values.

Definition at line 110 of file SoSurfaceFittingApproximation3d.h.

◆ topBoundaryCondition

SoSFEnum SoSurfaceFittingApproximation3d::topBoundaryCondition

The type of boundary conditions for the top boundary.

Definition at line 176 of file SoSurfaceFittingApproximation3d.h.


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