VTK
Public Types | Public Member Functions | 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]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageTransformNew ()
 Standard methods for construction, type information, printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageTransformSafeDownCast (vtkObjectBase *o)
 
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. More...
 
static void TranslatePoints (double *t, vtkDataArray *da)
 Given x-y-z points represented by a vtkDataArray, translate the points using the image origin. More...
 
static void TransformPoints (vtkMatrix4x4 *m4, vtkDataArray *da)
 Given x-y-z points represented by a vtkDataArray, transform the points using the matrix provided. More...
 
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. More...
 
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. More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageTransform ()
 
 ~vtkImageTransform () override
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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 frmo 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 55 of file vtkImageTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 63 of file vtkImageTransform.h.

Constructor & Destructor Documentation

◆ vtkImageTransform()

vtkImageTransform::vtkImageTransform ( )
inlineprotected

Definition at line 110 of file vtkImageTransform.h.

◆ ~vtkImageTransform()

vtkImageTransform::~vtkImageTransform ( )
inlineoverrideprotected

Definition at line 111 of file vtkImageTransform.h.

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

◆ IsA()

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

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageTransform::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkImageTransform* vtkImageTransform::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ TransformPointSet()

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.

◆ 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: