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

ImageViz SoSurfaceUnfoldingProcessing3d engine More...

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

+ Inheritance diagram for SoSurfaceUnfoldingProcessing3d:

Public Types

enum  InterpolationType {
  NEAREST = 0 ,
  LINEAR
}
 This enum defines the type of interpolation used. 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

 SoSurfaceUnfoldingProcessing3d ()
 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 inImage
 The input 3D image.
 
SoSFStructuredQuadrilateralMesh inSurface
 The input surface as a starting point for the process.
 
SoSFDouble thickness
 Distance in the input image defining the output image thickness.
 
SoSFVec3i32 size
 Size of the new image.
 
SoMFVec3f directions
 Optional direction vectors used to unfold the surface.
 
SoSFDouble paddingValue
 The default output value.
 
SoSFEnum interpolationType
 The type of interpolation used.
 
SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * > outImage
 The output 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 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 SoSurfaceUnfoldingProcessing3d engine

The SoSurfaceUnfoldingProcessing3d engine computes a 3D image starting from an input 3D image and an input 3D surface.

The input 3D surface is unfolded in order to appear as a flat layer of the output 3D image. Actually the surface unfolded is a thick surface defined by the thickness field.

Thus the result of this engine is also a 3D image that corresponds to the region in the input 3D image around the input surface. The number of voxels of the output image 3D must be defined by the field size. This size is independent from the number of voxels in the input image, and independent from the number of vertices in the input surface.

Creating a human dental panoramic image is a typical use case of this engine, where:

  • The inImage corresponds to a scanner image of the head.
  • The inSurface is a surface which is centered on the teeth, jaw and facial bones.
  • The thickness is usually 1 or 2 cm in order to fit the thickness of each tooth.

FILE FORMAT/DEFAULT

    SoSurfaceUnfoldingProcessing3d {
    inImage NULL
    inSurface NULL
    thickness 0.0
    size 1024 1024 256
    directions NULL
    paddingValue 0.0
    interpolationType LINEAR
    outImage
    }

SEE ALSO

SoPolylineExtrusionApproximation3d, SoSurfaceFittingApproximation3d

Definition at line 86 of file SoSurfaceUnfoldingProcessing3d.h.

Member Enumeration Documentation

◆ InterpolationType

This enum defines the type of interpolation used.

Enumerator
NEAREST 

The assigned value is the value of the nearest point in the input image.

LINEAR 

A tri-linear interpolation is used to compute the output image.

Definition at line 128 of file SoSurfaceUnfoldingProcessing3d.h.

Constructor & Destructor Documentation

◆ SoSurfaceUnfoldingProcessing3d()

SoSurfaceUnfoldingProcessing3d::SoSurfaceUnfoldingProcessing3d ( )

Constructor.

Member Data Documentation

◆ directions

SoMFVec3f SoSurfaceUnfoldingProcessing3d::directions

Optional direction vectors used to unfold the surface.

By default this field does not contain any data, which means that this engine will compute direction vectors as the normal vector to each vertex of the input surface inSurface. If this field is set, it must contain as many vectors as the number of vertices in inSurface. The field's value is ignored if it does not contain as many vectors as the number of vertices in the surface.

Definition at line 116 of file SoSurfaceUnfoldingProcessing3d.h.

◆ inImage

SoSFImageDataAdapter SoSurfaceUnfoldingProcessing3d::inImage

The input 3D image.

Default value is NULL.

Definition at line 96 of file SoSurfaceUnfoldingProcessing3d.h.

◆ inSurface

SoSFStructuredQuadrilateralMesh SoSurfaceUnfoldingProcessing3d::inSurface

The input surface as a starting point for the process.

Default value is NULL.

Definition at line 100 of file SoSurfaceUnfoldingProcessing3d.h.

◆ interpolationType

SoSFEnum SoSurfaceUnfoldingProcessing3d::interpolationType

The type of interpolation used.

Default value is LINEAR. Use enum InterpolationType

Definition at line 144 of file SoSurfaceUnfoldingProcessing3d.h.

◆ outImage

SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter*> SoSurfaceUnfoldingProcessing3d::outImage

The output image.

Default value is NULL.

Definition at line 147 of file SoSurfaceUnfoldingProcessing3d.h.

◆ paddingValue

SoSFDouble SoSurfaceUnfoldingProcessing3d::paddingValue

The default output value.

This value is used to fill output regions having no correspondence in the input image. Default is 0.

Definition at line 123 of file SoSurfaceUnfoldingProcessing3d.h.

◆ size

SoSFVec3i32 SoSurfaceUnfoldingProcessing3d::size

Size of the new image.

Default value is SbVec3i32(1024,1024,256)

Definition at line 106 of file SoSurfaceUnfoldingProcessing3d.h.

◆ thickness

SoSFDouble SoSurfaceUnfoldingProcessing3d::thickness

Distance in the input image defining the output image thickness.

Default is 0.

Definition at line 103 of file SoSurfaceUnfoldingProcessing3d.h.


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