The abstract base class for all of the IGSTK transform types. More...
#include <igstkTransformBase.h>
Public Types | |
typedef double | ErrorType |
typedef TimeStamp::TimePeriodType | TimePeriodType |
Public Member Functions | |
TransformBase () | |
Constructor and destructor. | |
TransformBase (const TransformBase &t) | |
virtual | ~TransformBase () |
virtual ErrorType | GetError () |
Returns the estimation error associated with this transform. | |
TimePeriodType | GetStartTime () const |
Returns the time at which the validity of this transformation starts. | |
TimePeriodType | GetExpirationTime () const |
Returns the time at which the validity of this transformation expires. | |
bool | IsValidAtTime (TimePeriodType timeToTestInMilliseconds) const |
Returns the validity status of the transform at the time passed as argument. | |
bool | IsValidNow () const |
Returns the validity status of the transform when it is called. | |
virtual void | Print (std::ostream &os, itk::Indent indent) const =0 |
Method for printing the member variables of this class to an ostream. | |
Protected Attributes | |
TimeStamp | m_TimeStamp |
ErrorType | m_Error |
The abstract base class for all of the IGSTK transform types.
This class is an abstract base class for all of the IGSTK transform types. It provides a time stamp and an error value associated with all igstk transforms. The time stamp defines the validity period for the transform, and the error value is the estimation error for the transform (e.g. an RMS error).
Definition at line 40 of file igstkTransformBase.h.
typedef double igstk::TransformBase::ErrorType |
Definition at line 44 of file igstkTransformBase.h.
Definition at line 45 of file igstkTransformBase.h.
igstk::TransformBase::TransformBase | ( | ) |
Constructor and destructor.
igstk::TransformBase::TransformBase | ( | const TransformBase & | t | ) |
virtual igstk::TransformBase::~TransformBase | ( | ) | [virtual] |
virtual ErrorType igstk::TransformBase::GetError | ( | ) | [virtual] |
Returns the estimation error associated with this transform.
The correct interpretation of this error depends on the source of the transformation.
TimePeriodType igstk::TransformBase::GetStartTime | ( | ) | const |
Returns the time at which the validity of this transformation starts.
The data in this transform should not be used for scenes to be rendered before that validity time. The time is returned in milliseconds.
TimePeriodType igstk::TransformBase::GetExpirationTime | ( | ) | const |
Returns the time at which the validity of this transformation expires.
The data in this transform should not be used for scenes to be rendered after that validity time. The time is returned in milliseconds.
bool igstk::TransformBase::IsValidAtTime | ( | TimePeriodType | timeToTestInMilliseconds | ) | const |
Returns the validity status of the transform at the time passed as argument.
The transform values should not be used in a scene if the time when the scene is to be rendered returned 'false' when passed to this IsValid() function. The time is passed in milliseconds.
bool igstk::TransformBase::IsValidNow | ( | ) | const |
Returns the validity status of the transform when it is called.
virtual void igstk::TransformBase::Print | ( | std::ostream & | os, | |
itk::Indent | indent | |||
) | const [pure virtual] |
Method for printing the member variables of this class to an ostream.
Implemented in igstk::AffineTransform, igstk::PerspectiveTransform, and igstk::Transform.
TimeStamp igstk::TransformBase::m_TimeStamp [protected] |
Definition at line 102 of file igstkTransformBase.h.
ErrorType igstk::TransformBase::m_Error [protected] |
Definition at line 103 of file igstkTransformBase.h.