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

ImageViz SoImagePreAlignmentTransform3d image filter More...

#include <ImageViz/Engines/GeometryAndMatching/Registration/SoImagePreAlignmentTransform3d.h>

+ Inheritance diagram for SoImagePreAlignmentTransform3d:

Public Types

enum  AlignmentMode {
  CENTERS = 0 ,
  PRINCIPAL_AXIS = 1
}
 This enum defines the different types of alignments. 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

 SoImagePreAlignmentTransform3d ()
 Constructor.
 
SbMatrix getOutputTransformation ()
 Returns the transform matrix that aligns the model image to the reference image.
 
- 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 inMovingImage
 The model image.
 
SoSFImageDataAdapter inFixedImage
 The reference image.
 
SoSFEnum alignmentMode
 Select the type of alignment Use enum AlignmentMode.
 
SoImageVizEngineOutput< SoSFFieldContainer, SoRegistrationResult * > outTransform
 Output structure storing registration results.
 
- 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 SoImagePreAlignmentTransform3d image filter

SoImagePreAlignmentTransform3d estimates a transformation (translation and rotation) that aligns a moving image with a fixed image based on their intensity values. This transformation is particularly useful as an initial transformation value for the IntensityParametricRegistration engine.

SoImagePreAlignmentTransform3d first computes the centers of gravity and (optionally) the principal axes of both images (model and reference) using the image intensity values as a mass density. In the second step, the translation and the rotation that align the centers of gravity and the principal axes of both images are estimated. Note that if the computation of principal axes is omitted, only a translation is estimated.

FILE FORMAT/DEFAULT

    ImagePreAlignmentTransform3d {
    inMovingImage NULL
    inFixedImage NULL
    alignmentMode CENTERS
    }

    Notice: This engine requires to preliminarily load the whole input data sets into memory to be computed. As a consequence, the maximum memory parameter must be either set to 0 or greater than the data set memory size:

    If this condition is not respected an exception will be raised when launching the execution of this engine: "engine cannot be computed because inputs are not in memory images."

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

SEE ALSO

SoImageRegistrationTransform, SoRegistrationResult

Definition at line 82 of file SoImagePreAlignmentTransform3d.h.

Member Enumeration Documentation

◆ AlignmentMode

This enum defines the different types of alignments.

Enumerator
CENTERS 

In this mode, the centers of gravity of the input images are aligned.

PRINCIPAL_AXIS 

In this mode, the centers of gravity and the principal axes of the input images are aligned.

Definition at line 99 of file SoImagePreAlignmentTransform3d.h.

Constructor & Destructor Documentation

◆ SoImagePreAlignmentTransform3d()

SoImagePreAlignmentTransform3d::SoImagePreAlignmentTransform3d ( )

Constructor.

Member Function Documentation

◆ getOutputTransformation()

SbMatrix SoImagePreAlignmentTransform3d::getOutputTransformation ( )
inline

Returns the transform matrix that aligns the model image to the reference image.


Definition at line 122 of file SoImagePreAlignmentTransform3d.h.

Member Data Documentation

◆ alignmentMode

SoSFEnum SoImagePreAlignmentTransform3d::alignmentMode

Select the type of alignment Use enum AlignmentMode.

Default is CENTERS

Definition at line 115 of file SoImagePreAlignmentTransform3d.h.

◆ inFixedImage

SoSFImageDataAdapter SoImagePreAlignmentTransform3d::inFixedImage

The reference image.

Default value is NULL. Supported types include: grayscale, binary, label.

Definition at line 94 of file SoImagePreAlignmentTransform3d.h.

◆ inMovingImage

SoSFImageDataAdapter SoImagePreAlignmentTransform3d::inMovingImage

The model image.

Default value is NULL. Supported types include: grayscale, binary, label.

Definition at line 91 of file SoImagePreAlignmentTransform3d.h.

◆ outTransform

SoImageVizEngineOutput<SoSFFieldContainer, SoRegistrationResult*> SoImagePreAlignmentTransform3d::outTransform

Output structure storing registration results.

Definition at line 119 of file SoImagePreAlignmentTransform3d.h.


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