IGSTK
Public Types | Public Member Functions | Protected Member Functions | List of all members
igstk::PerspectiveTransform Class Reference

A class representing a 3D rigid transformation followed by a perspective projection. More...

#include <igstkPerspectiveTransform.h>

Inheritance diagram for igstk::PerspectiveTransform:
Inheritance graph
[legend]
Collaboration diagram for igstk::PerspectiveTransform:
Collaboration graph
[legend]

Public Types

typedef ::itk::Matrix< double, 3, 4 > ExtrinsicMatrixType
 Extrinsic perspective camera parameters [R,t]. More...
 
typedef ::itk::Matrix< double, 3, 3 > IntrinsicMatrixType
 Intrinsic perspective camera parameters, upper triangular matrix. More...
 
- Public Types inherited from igstk::TransformBase
typedef double ErrorType
 
typedef TimeStamp::TimePeriodType TimePeriodType
 

Public Member Functions

 PerspectiveTransform ()
 Constructor and destructor. More...
 
 PerspectiveTransform (const PerspectiveTransform &t)
 
virtual ~PerspectiveTransform ()
 
const PerspectiveTransformoperator= (const PerspectiveTransform &inputTransform)
 Assign the values of one transform to another. More...
 
void SetTransform (const ExtrinsicMatrixType &extrinsic, const IntrinsicMatrixType &intrinsic, ErrorType errorValue, TimePeriodType millisecondsToExpiration)
 Set perspective transformation. More...
 
void ExportTransform (vtkPerspectiveTransform &outMatrix) const
 Export the content of the transformation into a vtkPerspective transform which represents the rigid transform followed by the perspective projection. More...
 
void ExportExtrinsicParameters (vtkMatrix4x4 &matrix) const
 Export the extrinsic camera parameters. More...
 
void ExportIntrinsicParameters (vtkPerspectiveTransform &outMatrix) const
 Export the intrinsic camera parameters. More...
 
void Print (std::ostream &os, itk::Indent indent) const
 Method for printing the member variables of this class to an ostream. More...
 
- Public Member Functions inherited from igstk::TransformBase
 TransformBase ()
 Constructor and destructor. More...
 
 TransformBase (const TransformBase &t)
 
virtual ~TransformBase ()
 
virtual ErrorType GetError ()
 Returns the estimation error associated with this transform. More...
 
TimePeriodType GetStartTime () const
 Returns the time at which the validity of this transformation starts. More...
 
TimePeriodType GetExpirationTime () const
 Returns the time at which the validity of this transformation expires. More...
 
bool IsValidAtTime (TimePeriodType timeToTestInMilliseconds) const
 Returns the validity status of the transform at the time passed as argument. More...
 
bool IsValidNow () const
 Returns the validity status of the transform when it is called. More...
 

Protected Member Functions

void PrintHeader (std::ostream &os, itk::Indent indent) const
 
void PrintTrailer (std::ostream &itkNotUsed(os), itk::Indent itkNotUsed(indent)) const
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 

Additional Inherited Members

- Protected Attributes inherited from igstk::TransformBase
TimeStamp m_TimeStamp
 
ErrorType m_Error
 

Detailed Description

A class representing a 3D rigid transformation followed by a perspective projection.

This class represents a perspective transform of points from 3D to 2D.

All the set methods require an argument that defines the number of milliseconds for which the stored information is considered to be valid. The validity period will be counted from the moment the Set method was invoked.

See Also
TransformBase

Definition at line 46 of file igstkPerspectiveTransform.h.

Member Typedef Documentation

typedef ::itk::Matrix<double, 3, 4> igstk::PerspectiveTransform::ExtrinsicMatrixType

Extrinsic perspective camera parameters [R,t].

Definition at line 50 of file igstkPerspectiveTransform.h.

typedef ::itk::Matrix<double, 3, 3> igstk::PerspectiveTransform::IntrinsicMatrixType

Intrinsic perspective camera parameters, upper triangular matrix.

Definition at line 52 of file igstkPerspectiveTransform.h.

Constructor & Destructor Documentation

igstk::PerspectiveTransform::PerspectiveTransform ( )

Constructor and destructor.

igstk::PerspectiveTransform::PerspectiveTransform ( const PerspectiveTransform t)
virtual igstk::PerspectiveTransform::~PerspectiveTransform ( )
virtual

Member Function Documentation

const PerspectiveTransform& igstk::PerspectiveTransform::operator= ( const PerspectiveTransform inputTransform)

Assign the values of one transform to another.

void igstk::PerspectiveTransform::SetTransform ( const ExtrinsicMatrixType extrinsic,
const IntrinsicMatrixType intrinsic,
ErrorType  errorValue,
TimePeriodType  millisecondsToExpiration 
)

Set perspective transformation.

This transformation will override any previously set values. The information will be considered valid from the time of invocation of the method until that time plus the millisecondsToExpiration value.

void igstk::PerspectiveTransform::ExportTransform ( vtkPerspectiveTransform &  outMatrix) const

Export the content of the transformation into a vtkPerspective transform which represents the rigid transform followed by the perspective projection.

Users must allocate the matrix first and then pass it by reference to this method. The current method will simply fill in the transform.

void igstk::PerspectiveTransform::ExportExtrinsicParameters ( vtkMatrix4x4 &  matrix) const

Export the extrinsic camera parameters.

This is the rigid transformation between the camera and the reference frame relative to which it was calibrated.

void igstk::PerspectiveTransform::ExportIntrinsicParameters ( vtkPerspectiveTransform &  outMatrix) const

Export the intrinsic camera parameters.

This is the perspective transformation associated with the internal camera parameters.

void igstk::PerspectiveTransform::Print ( std::ostream &  os,
itk::Indent  indent 
) const
virtual

Method for printing the member variables of this class to an ostream.

Implements igstk::TransformBase.

void igstk::PerspectiveTransform::PrintHeader ( std::ostream &  os,
itk::Indent  indent 
) const
protected
void igstk::PerspectiveTransform::PrintTrailer ( std::ostream &  itkNotUsedos,
itk::Indent   itkNotUsedindent 
) const
protected
virtual void igstk::PerspectiveTransform::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print the object information in a stream.


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