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

ImageViz SoResampleImageProcessing3d filter More...

#include <ImageViz/Engines/GeometryAndMatching/GeometricTransforms/SoResampleImageProcessing3d.h>

+ Inheritance diagram for SoResampleImageProcessing3d:

Public Types

enum  SamplingMode {
  AUTOMATIC = 0 ,
  MANUAL
}
 This enum defines how the voxel size of the output image is computed. More...
 
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

 SoResampleImageProcessing3d ()
 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 image.
 
SoSFBox3f subVolume
 Specifies the input subvolume as an axis aligned box in 3D space.
 
SoSFMatrix subVolumeTransform
 Specifies a transformation of the axis aligned box subVolume.
 
SoSFEnum samplingMode
 Specifies how the voxel size is computed.
 
SoSFVec3i32 subVolumeDimension
 The dimensions of the output sub volume.
 
SoSFEnum interpolationType
 The type of interpolation used for the re-sampling.
 
SoSFDouble paddingValue
 The output value if an output voxel position is outside the bounding box of the input image.
 
SoSFMatrix transform
 This transformation is applied to all output voxel positions before the interpolation.
 
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 SoResampleImageProcessing3d filter

The SoResampleImageProcessing3d engine allows to resample an input image into a new coordinate system applying a transform on it.

For instance it can be used to :

  • apply the transform computed by an automatic registration in order to process the registered image.
  • extract a "rotated ROI" (not aligned with the input bounding box).

The resampled sub-volume is defined by an SbBox3f (axis aligned box) in 3D space and a SbMatrix that transforms the axis aligned box. The output voxel values are computed by interpolating the input image.

The SbMatrix that transforms the axis aligned box must only contain translation, rotation and scale (no shearing), otherwise an error is raised.

An additional transformation can be applied to each output voxel position before the interpolation. This is useful for re-sampling an image after a registration.

FILE FORMAT/DEFAULT

    ResampleImageProcessing3d {
    inImage NULL
    subVolume 0, 0, 0, 1, 1, 1
    subVolumeTransform 1 0 0 0
    0 1 0 0
    0 0 1 0
    0 0 0 1
    samplingMode AUTOMATIC
    subVolumeDimension 1 1 1
    interpolationType LINEAR
    paddingValue 0.0
    transform 1 0 0 0
    0 1 0 0
    0 0 1 0
    0 0 0 1
    }

SEE ALSO

SoSampleImageProcessing, SoProxyDataAdapter

Definition at line 84 of file SoResampleImageProcessing3d.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 130 of file SoResampleImageProcessing3d.h.

◆ SamplingMode

This enum defines how the voxel size of the output image is computed.

Enumerator
AUTOMATIC 

The voxel size is automatically computed to be as close as possible to the input image.

Note that this mode does not work if SoResampleImageProcessing3d::transform is not the identity (an error is raised) .

MANUAL 

The user specifies the output image dimension (SoResampleImageProcessing3d::outputImageDimension) and thus the output voxel size.

Definition at line 106 of file SoResampleImageProcessing3d.h.

Constructor & Destructor Documentation

◆ SoResampleImageProcessing3d()

SoResampleImageProcessing3d::SoResampleImageProcessing3d ( )

Constructor.

Member Data Documentation

◆ inImage

SoSFImageDataAdapter SoResampleImageProcessing3d::inImage

The input image.

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

Definition at line 94 of file SoResampleImageProcessing3d.h.

◆ interpolationType

SoSFEnum SoResampleImageProcessing3d::interpolationType

The type of interpolation used for the re-sampling.

Default value is LINEAR. Use enum InterpolationType

Definition at line 144 of file SoResampleImageProcessing3d.h.

◆ outImage

SoImageVizEngineOutput<SoSFImageDataAdapter, SoImageDataAdapter*> SoResampleImageProcessing3d::outImage

The output image.

Definition at line 153 of file SoResampleImageProcessing3d.h.

◆ paddingValue

SoSFDouble SoResampleImageProcessing3d::paddingValue

The output value if an output voxel position is outside the bounding box of the input image.

Default value is 0.

Definition at line 147 of file SoResampleImageProcessing3d.h.

◆ samplingMode

SoSFEnum SoResampleImageProcessing3d::samplingMode

Specifies how the voxel size is computed.

Default value is AUTOMATIC. Use enum SamplingMode

Definition at line 121 of file SoResampleImageProcessing3d.h.

◆ subVolume

SoSFBox3f SoResampleImageProcessing3d::subVolume

Specifies the input subvolume as an axis aligned box in 3D space.

Default is (0,0,0, 1,1,1). This box is (optionally) transformed by the subVolumeTransform to define the final input subvolume.

Definition at line 98 of file SoResampleImageProcessing3d.h.

◆ subVolumeDimension

SoSFVec3i32 SoResampleImageProcessing3d::subVolumeDimension

The dimensions of the output sub volume.

If the parameter SoResampleImageProcessing3d::samplingMode is not set to MANUAL this parameter is ignored. Default value is (1,1,1).

Definition at line 125 of file SoResampleImageProcessing3d.h.

◆ subVolumeTransform

SoSFMatrix SoResampleImageProcessing3d::subVolumeTransform

Specifies a transformation of the axis aligned box subVolume.

Default is identity.

Definition at line 101 of file SoResampleImageProcessing3d.h.

◆ transform

SoSFMatrix SoResampleImageProcessing3d::transform

This transformation is applied to all output voxel positions before the interpolation.

The default value is the identity.

Definition at line 150 of file SoResampleImageProcessing3d.h.


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