VTK  9.3.20240720
Static Public Member Functions | Protected Member Functions | List of all members
vtkImageTransform Class Reference

helper class to transform output of non-axis-aligned images More...

#include <vtkImageTransform.h>

Inheritance diagram for vtkImageTransform:
[legend]
Collaboration diagram for vtkImageTransform:
[legend]

Static Public Member Functions

static void TranslatePoints (double *t, vtkDataArray *da)
 Given x-y-z points represented by a vtkDataArray, translate the points using the image origin.
 
static void TransformPoints (vtkMatrix4x4 *m4, vtkDataArray *da)
 Given x-y-z points represented by a vtkDataArray, transform the points using the matrix provided.
 
static void TransformNormals (vtkMatrix3x3 *m3, double spacing[3], vtkDataArray *da)
 Given three-component normals represented by a vtkDataArray, transform the normals using the matrix provided.
 
static void TransformVectors (vtkMatrix3x3 *m3, double spacing[3], vtkDataArray *da)
 Given three-component vectors represented by a vtkDataArray, transform the vectors using the matrix provided.
 
static void TransformPointSet (vtkImageData *im, vtkPointSet *ps)
 Given a vtkImageData (and hence its associated orientation matrix), and an instance of vtkPointSet, transform its points, as well as any normals and vectors, associated with the vtkPointSet.
 
static void TransformPointSet (vtkImageData *im, vtkPointSet *ps, bool transNormals, bool transVectors)
 Given a vtkImageData (and hence its associated orientation matrix), and an instance of vtkPointSet, transform its points, as well as any normals and vectors, associated with the vtkPointSet.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

 vtkImageTransform ()=default
 
 ~vtkImageTransform () override=default
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
typedef vtkObject Superclass
 Standard methods for construction, type information, printing.
 
static vtkImageTransformNew ()
 Standard methods for construction, type information, printing.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for construction, type information, printing.
 
static vtkImageTransformSafeDownCast (vtkObjectBase *o)
 Standard methods for construction, type information, printing.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for construction, type information, printing.
 
vtkImageTransformNewInstance () const
 Standard methods for construction, type information, printing.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for construction, type information, printing.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for construction, type information, printing.
 

Additional Inherited Members

- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper class to transform output of non-axis-aligned images

vtkImageTransform is a helper class to transform the output of image filters (i.e., filter that input vtkImageData) by applying the Index to Physical transformation from the input image, which can include origin, spacing, direction. The transformation process is threaded with vtkSMPTools for performance.

Typically in application the single method TransformPointSet() is invoked to transform the output of an image algorithm (assuming that the image's direction/orientation matrix is non-identity). Note that vtkPointSets encompass vtkPolyData as well as vtkUnstructuredGrids. In the future other output types may be added. Note that specific methods for transforming points, normals, and vectors is also provided by this class in case additional output data arrays need to be transformed (since TransformPointSet() only processes data arrays labeled as points, normals, and vectors).

Warning
This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

Definition at line 44 of file vtkImageTransform.h.

Member Typedef Documentation

◆ Superclass

Standard methods for construction, type information, printing.

Definition at line 52 of file vtkImageTransform.h.

Constructor & Destructor Documentation

◆ vtkImageTransform()

vtkImageTransform::vtkImageTransform ( )
protecteddefault

◆ ~vtkImageTransform()

vtkImageTransform::~vtkImageTransform ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkImageTransform * vtkImageTransform::New ( )
static

Standard methods for construction, type information, printing.

◆ IsTypeOf()

static vtkTypeBool vtkImageTransform::IsTypeOf ( const char *  type)
static

Standard methods for construction, type information, printing.

◆ IsA()

virtual vtkTypeBool vtkImageTransform::IsA ( const char *  type)
virtual

Standard methods for construction, type information, printing.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkImageTransform * vtkImageTransform::SafeDownCast ( vtkObjectBase o)
static

Standard methods for construction, type information, printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageTransform::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for construction, type information, printing.

◆ NewInstance()

vtkImageTransform * vtkImageTransform::NewInstance ( ) const

Standard methods for construction, type information, printing.

◆ PrintSelf()

void vtkImageTransform::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for construction, type information, printing.

Reimplemented from vtkObjectBase.

◆ TransformPointSet() [1/2]

static void vtkImageTransform::TransformPointSet ( vtkImageData im,
vtkPointSet ps 
)
static

Given a vtkImageData (and hence its associated orientation matrix), and an instance of vtkPointSet, transform its points, as well as any normals and vectors, associated with the vtkPointSet.

This is a convenience function, internally it calls TranslatePoints(), TransformPoints(), TransformNormals(), and/or TransformVectors() as appropriate. Note that both the normals and vectors associated with the point and cell data are transformed unless the second signature is called, which controls whether to transform normals and/or vectors.

◆ TransformPointSet() [2/2]

static void vtkImageTransform::TransformPointSet ( vtkImageData im,
vtkPointSet ps,
bool  transNormals,
bool  transVectors 
)
static

Given a vtkImageData (and hence its associated orientation matrix), and an instance of vtkPointSet, transform its points, as well as any normals and vectors, associated with the vtkPointSet.

This is a convenience function, internally it calls TranslatePoints(), TransformPoints(), TransformNormals(), and/or TransformVectors() as appropriate. Note that both the normals and vectors associated with the point and cell data are transformed unless the second signature is called, which controls whether to transform normals and/or vectors.

◆ TranslatePoints()

static void vtkImageTransform::TranslatePoints ( double *  t,
vtkDataArray da 
)
static

Given x-y-z points represented by a vtkDataArray, translate the points using the image origin.

This method is useful if there is no orientation or spacing to apply.

◆ TransformPoints()

static void vtkImageTransform::TransformPoints ( vtkMatrix4x4 m4,
vtkDataArray da 
)
static

Given x-y-z points represented by a vtkDataArray, transform the points using the matrix provided.

◆ TransformNormals()

static void vtkImageTransform::TransformNormals ( vtkMatrix3x3 m3,
double  spacing[3],
vtkDataArray da 
)
static

Given three-component normals represented by a vtkDataArray, transform the normals using the matrix provided.

◆ TransformVectors()

static void vtkImageTransform::TransformVectors ( vtkMatrix3x3 m3,
double  spacing[3],
vtkDataArray da 
)
static

Given three-component vectors represented by a vtkDataArray, transform the vectors using the matrix provided.


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