VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkLandmarkTransform Class Reference

a linear transform specified by two corresponding point sets More...

#include <vtkLandmarkTransform.h>

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

Public Types

typedef vtkLinearTransform Superclass
 
- Public Types inherited from vtkLinearTransform
typedef vtkHomogeneousTransform Superclass
 
- Public Types inherited from vtkHomogeneousTransform
typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
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...
 
vtkLandmarkTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSourceLandmarks (vtkPoints *points)
 Specify the source and target landmark sets. More...
 
void SetTargetLandmarks (vtkPoints *points)
 
virtual vtkPointsGetSourceLandmarks ()
 
virtual vtkPointsGetTargetLandmarks ()
 
virtual void SetMode (int)
 Set the number of degrees of freedom to constrain the solution to. More...
 
void SetModeToRigidBody ()
 
void SetModeToSimilarity ()
 
void SetModeToAffine ()
 
virtual int GetMode ()
 Get the current transformation mode. More...
 
const char * GetModeAsString ()
 
void Inverse () override
 Invert the transformation. More...
 
vtkMTimeType GetMTime () override
 Get the MTime. More...
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type. More...
 
- Public Member Functions inherited from vtkLinearTransform
vtkLinearTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void TransformNormal (const float in[3], float out[3])
 Apply the transformation to a normal. More...
 
void TransformNormal (const double in[3], double out[3])
 Apply the transformation to a double-precision normal. More...
 
doubleTransformNormal (double x, double y, double z)
 Synonymous with TransformDoubleNormal(x,y,z). More...
 
doubleTransformNormal (const double normal[3])
 
floatTransformFloatNormal (float x, float y, float z)
 Apply the transformation to an (x,y,z) normal. More...
 
floatTransformFloatNormal (const float normal[3])
 
doubleTransformDoubleNormal (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) normal. More...
 
doubleTransformDoubleNormal (const double normal[3])
 
doubleTransformVector (double x, double y, double z)
 Synonymous with TransformDoubleVector(x,y,z). More...
 
doubleTransformVector (const double normal[3])
 
void TransformVector (const float in[3], float out[3])
 Apply the transformation to a vector. More...
 
void TransformVector (const double in[3], double out[3])
 Apply the transformation to a double-precision vector. More...
 
floatTransformFloatVector (float x, float y, float z)
 Apply the transformation to an (x,y,z) vector. More...
 
floatTransformFloatVector (const float vec[3])
 
doubleTransformDoubleVector (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) vector. More...
 
doubleTransformDoubleVector (const double vec[3])
 
void TransformPoints (vtkPoints *inPts, vtkPoints *outPts) override
 Apply the transformation to a series of points, and append the results to outPts. More...
 
virtual void TransformNormals (vtkDataArray *inNms, vtkDataArray *outNms)
 Apply the transformation to a series of normals, and append the results to outNms. More...
 
virtual void TransformVectors (vtkDataArray *inVrs, vtkDataArray *outVrs)
 Apply the transformation to a series of vectors, and append the results to outVrs. More...
 
void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr) override
 Apply the transformation to a combination of points, normals and vectors. More...
 
vtkLinearTransformGetLinearInverse ()
 Just like GetInverse, but it includes a typecast to vtkLinearTransform. More...
 
void InternalTransformPoint (const float in[3], float out[3]) override
 This will calculate the transformation without calling Update. More...
 
void InternalTransformPoint (const double in[3], double out[3]) override
 
virtual void InternalTransformNormal (const float in[3], float out[3])
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformNormal (const double in[3], double out[3])
 
virtual void InternalTransformVector (const float in[3], float out[3])
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformVector (const double in[3], double out[3])
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 This will calculate the transformation as well as its derivative without calling Update. More...
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 
- Public Member Functions inherited from vtkHomogeneousTransform
vtkHomogeneousTransformNewInstance () const
 
void GetMatrix (vtkMatrix4x4 *m)
 Get a copy of the internal transformation matrix. More...
 
vtkMatrix4x4GetMatrix ()
 Get a pointer to an internal vtkMatrix4x4 that represents the transformation. More...
 
vtkHomogeneousTransformGetHomogeneousInverse ()
 Just like GetInverse(), but includes typecast to vtkHomogeneousTransform. More...
 
- Public Member Functions inherited from vtkAbstractTransform
vtkAbstractTransformNewInstance () const
 
void TransformPoint (const float in[3], float out[3])
 Apply the transformation to a coordinate. More...
 
void TransformPoint (const double in[3], double out[3])
 Apply the transformation to a double-precision coordinate. More...
 
doubleTransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. More...
 
doubleTransformPoint (const double point[3])
 
floatTransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. More...
 
floatTransformFloatPoint (const float point[3])
 
doubleTransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
doubleTransformDoublePoint (const double point[3])
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a normal at the specified vertex. More...
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 
doubleTransformNormalAtPoint (const double point[3], const double normal[3])
 
doubleTransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex. More...
 
floatTransformFloatNormalAtPoint (const float point[3], const float normal[3])
 Apply the transformation to a single-precision normal at the specified vertex. More...
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a vector at the specified vertex. More...
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 
doubleTransformVectorAtPoint (const double point[3], const double vector[3])
 
doubleTransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex. More...
 
floatTransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex. More...
 
vtkAbstractTransformGetInverse ()
 Get the inverse of this transform. More...
 
void SetInverse (vtkAbstractTransform *transform)
 Set a transformation that this transform will be the inverse of. More...
 
void DeepCopy (vtkAbstractTransform *)
 Copy this transform from another of the same type. More...
 
void Update ()
 Update the transform to account for any changes which have been made. More...
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference. More...
 
void UnRegister (vtkObjectBase *O) override
 Needs a special UnRegister() implementation to avoid circular references. 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...
 
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...
 
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 vtkLandmarkTransformNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLandmarkTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLinearTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLinearTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHomogeneousTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHomogeneousTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkLandmarkTransform ()
 
 ~vtkLandmarkTransform () override
 
void InternalUpdate () override
 Perform any subclass-specific Update. More...
 
void InternalDeepCopy (vtkAbstractTransform *transform) override
 This method does no type checking, use DeepCopy instead. More...
 
- Protected Member Functions inherited from vtkLinearTransform
 vtkLinearTransform ()
 
 ~vtkLinearTransform () override
 
- Protected Member Functions inherited from vtkHomogeneousTransform
 vtkHomogeneousTransform ()
 
 ~vtkHomogeneousTransform () override
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () 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 &)
 

Protected Attributes

vtkPointsSourceLandmarks
 
vtkPointsTargetLandmarks
 
int Mode
 
- Protected Attributes inherited from vtkHomogeneousTransform
vtkMatrix4x4Matrix
 
- Protected Attributes inherited from vtkAbstractTransform
float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- 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

a linear transform specified by two corresponding point sets

A vtkLandmarkTransform is defined by two sets of landmarks, the transform computed gives the best fit mapping one onto the other, in a least squares sense. The indices are taken to correspond, so point 1 in the first set will get mapped close to point 1 in the second set, etc. Call SetSourceLandmarks and SetTargetLandmarks to specify the two sets of landmarks, ensure they have the same number of points.

Warning
Whenever you add, subtract, or set points you must call Modified() on the vtkPoints object, or the transformation might not update.
See also
vtkLinearTransform
Tests:
vtkLandmarkTransform (Tests)

Definition at line 45 of file vtkLandmarkTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkLandmarkTransform.h.

Constructor & Destructor Documentation

◆ vtkLandmarkTransform()

vtkLandmarkTransform::vtkLandmarkTransform ( )
protected

◆ ~vtkLandmarkTransform()

vtkLandmarkTransform::~vtkLandmarkTransform ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLandmarkTransform* vtkLandmarkTransform::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLandmarkTransform::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 vtkLinearTransform.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLandmarkTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLinearTransform.

◆ NewInstance()

vtkLandmarkTransform* vtkLandmarkTransform::NewInstance ( ) const

◆ PrintSelf()

void vtkLandmarkTransform::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 vtkHomogeneousTransform.

◆ SetSourceLandmarks()

void vtkLandmarkTransform::SetSourceLandmarks ( vtkPoints points)

Specify the source and target landmark sets.

The two sets must have the same number of points. If you add or change points in these objects, you must call Modified() on them or the transformation might not update.

◆ SetTargetLandmarks()

void vtkLandmarkTransform::SetTargetLandmarks ( vtkPoints points)

◆ GetSourceLandmarks()

virtual vtkPoints* vtkLandmarkTransform::GetSourceLandmarks ( )
virtual

◆ GetTargetLandmarks()

virtual vtkPoints* vtkLandmarkTransform::GetTargetLandmarks ( )
virtual

◆ SetMode()

virtual void vtkLandmarkTransform::SetMode ( int  )
virtual

Set the number of degrees of freedom to constrain the solution to.

Rigidbody (VTK_LANDMARK_RIGIDBODY): rotation and translation only. Similarity (VTK_LANDMARK_SIMILARITY): rotation, translation and isotropic scaling. Affine (VTK_LANDMARK_AFFINE): collinearity is preserved. Ratios of distances along a line are preserved. The default is similarity.

◆ SetModeToRigidBody()

void vtkLandmarkTransform::SetModeToRigidBody ( )
inline

Definition at line 76 of file vtkLandmarkTransform.h.

◆ SetModeToSimilarity()

void vtkLandmarkTransform::SetModeToSimilarity ( )
inline

Definition at line 77 of file vtkLandmarkTransform.h.

◆ SetModeToAffine()

void vtkLandmarkTransform::SetModeToAffine ( )
inline

Definition at line 78 of file vtkLandmarkTransform.h.

◆ GetMode()

virtual int vtkLandmarkTransform::GetMode ( )
virtual

Get the current transformation mode.

◆ GetModeAsString()

const char * vtkLandmarkTransform::GetModeAsString ( )
inline

Definition at line 126 of file vtkLandmarkTransform.h.

◆ Inverse()

void vtkLandmarkTransform::Inverse ( )
overridevirtual

Invert the transformation.

This is done by switching the source and target landmarks.

Implements vtkAbstractTransform.

◆ GetMTime()

vtkMTimeType vtkLandmarkTransform::GetMTime ( )
overridevirtual

Get the MTime.

Reimplemented from vtkAbstractTransform.

◆ MakeTransform()

vtkAbstractTransform* vtkLandmarkTransform::MakeTransform ( )
overridevirtual

Make another transform of the same type.

Implements vtkAbstractTransform.

◆ InternalUpdate()

void vtkLandmarkTransform::InternalUpdate ( )
overrideprotectedvirtual

Perform any subclass-specific Update.

Reimplemented from vtkAbstractTransform.

◆ InternalDeepCopy()

void vtkLandmarkTransform::InternalDeepCopy ( vtkAbstractTransform transform)
overrideprotectedvirtual

This method does no type checking, use DeepCopy instead.

Reimplemented from vtkHomogeneousTransform.

Member Data Documentation

◆ SourceLandmarks

vtkPoints* vtkLandmarkTransform::SourceLandmarks
protected

Definition at line 117 of file vtkLandmarkTransform.h.

◆ TargetLandmarks

vtkPoints* vtkLandmarkTransform::TargetLandmarks
protected

Definition at line 118 of file vtkLandmarkTransform.h.

◆ Mode

int vtkLandmarkTransform::Mode
protected

Definition at line 120 of file vtkLandmarkTransform.h.


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