NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::UltrasoundPinCalibrationCostFunction Class Reference

Minimises the RMS error around a stationary invariant point. More...

Inheritance diagram for itk::UltrasoundPinCalibrationCostFunction:
Inheritance graph
[legend]
Collaboration diagram for itk::UltrasoundPinCalibrationCostFunction:
Collaboration graph
[legend]

Public Types

typedef
UltrasoundPinCalibrationCostFunction 
Self
 
typedef
itk::InvariantPointCalibrationCostFunction 
Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::MeasureType MeasureType
 
- Public Types inherited from itk::InvariantPointCalibrationCostFunction
typedef
InvariantPointCalibrationCostFunction 
Self
 
typedef
itk::MultipleValuedCostFunction 
Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::MeasureType MeasureType
 
typedef
mitk::TimeStampsContainer::TimeStamp 
TimeStampType
 

Public Member Functions

virtual void SetScaleFactors (mitk::Point2D _arg)
 
virtual mitk::Point2D GetScaleFactors () const
 
virtual void SetOptimiseScaleFactors (bool _arg)
 
virtual bool GetOptimiseScaleFactors () const
 
virtual cv::Matx44d GetCalibrationTransformation (const ParametersType &parameters) const override
 
- Public Member Functions inherited from itk::InvariantPointCalibrationCostFunction
virtual void SetInvariantPoint (mitk::Point3D _arg)
 
virtual mitk::Point3D GetInvariantPoint () const
 
virtual void SetOptimiseInvariantPoint (bool _arg)
 
virtual bool GetOptimiseInvariantPoint () const
 
virtual void SetTimingLag (double _arg)
 
virtual double GetTimingLag () const
 
virtual void SetAllowableTimingError (TimeStampType _arg)
 
virtual TimeStampType GetAllowableTimingError () const
 
virtual void SetOptimiseTimingLag (bool _arg)
 
virtual bool GetOptimiseTimingLag () const
 
virtual void SetOptimiseRigidTransformation (bool _arg)
 
virtual bool GetOptimiseRigidTransformation () const
 
virtual void SetVerbose (bool _arg)
 
virtual bool GetVerbose () const
 
void SetRigidTransformation (const cv::Matx44d &rigidBodyTrans)
 
cv::Matx44d GetRigidTransformation () const
 
std::vector< double > GetRigidTransformationParameters () const
 
void SetRigidTransformationParameters (const std::vector< double > &params)
 
virtual unsigned int GetNumberOfValues (void) const override
 Equal to the number of points * 3. More...
 
virtual unsigned int GetNumberOfParameters () const override
 Required by base class to return the number of parameters. See introduction to this class. More...
 
void SetNumberOfParameters (const int &numberOfParameters)
 Sets the number of parameters being optimised. This should be called before optimisation starts. More...
 
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
 Simply uses central differences to approximate the derivative for each of the parameters. See also SetScales where you set the relative size of each parameter step size. More...
 
void SetScales (const ParametersType &scales)
 Used when calculating derivative using central differences. More...
 
double GetResidual (const MeasureType &values) const
 Returns the RMS residual of all the values stored in the values array. More...
 
void SetTrackingData (mitk::TrackingAndTimeStampsContainer *trackingData)
 Sets the tracking data onto this object. More...
 
void SetPointData (std::vector< std::pair< unsigned long long, cv::Point3d > > *pointData)
 Sets the point data onto this object, setting the number of values = pointData.size()*3. More...
 
virtual MeasureType GetValue (const ParametersType &parameters) const override
 The cost function is the residual error of the reconstructed point, where this function returns an array of n (x, y, z) tuples where n is the number of points, and each x, y, z measure is the difference from the invariant point. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 UltrasoundPinCalibrationCostFunction ()
 
virtual ~UltrasoundPinCalibrationCostFunction ()
 
 UltrasoundPinCalibrationCostFunction (const UltrasoundPinCalibrationCostFunction &)
 
UltrasoundPinCalibrationCostFunctionoperator= (const UltrasoundPinCalibrationCostFunction &)
 
cv::Matx44d GetScalingTransformation (const ParametersType &parameters) const
 Computes the scaling transformation. More...
 
- Protected Member Functions inherited from itk::InvariantPointCalibrationCostFunction
 InvariantPointCalibrationCostFunction ()
 
virtual ~InvariantPointCalibrationCostFunction ()
 
 InvariantPointCalibrationCostFunction (const InvariantPointCalibrationCostFunction &)
 
InvariantPointCalibrationCostFunctionoperator= (const InvariantPointCalibrationCostFunction &)
 
void ValidateSizeOfParametersArray (const ParametersType &parameters) const
 Checks the supplied parameters array is the right size (i.e. it equals this->GetNumberOfParameters()), and throws mitk::Exception if it isnt. More...
 
void ValidateSizeOfScalesArray (const ParametersType &parameters) const
 Checks the supplied parameters array is the right size (i.e. it equals this->m_Scales.GetSize()), and throws mitk::Exception if it isnt. More...
 
cv::Matx44d GetRigidTransformation (const ParametersType &parameters) const
 Computes the rigid body part (US: image-to-probe) or (Video: hand-eye) transformation from the current estimate of the parameters. More...
 
cv::Matx44d GetTranslationTransformation (const ParametersType &parameters) const
 Computes the translation transformation. More...
 
double GetLag (const ParametersType &parameters) const
 Extracts the lag parameter from the array of things being optimised. More...
 

Additional Inherited Members

- Protected Attributes inherited from itk::InvariantPointCalibrationCostFunction
ParametersType m_Scales
 
mitk::Point3D m_InvariantPoint
 
bool m_OptimiseInvariantPoint
 
double m_TimingLag
 
bool m_OptimiseTimingLag
 
std::vector< double > m_RigidTransformation
 
bool m_OptimiseRigidTransformation
 
unsigned int m_NumberOfValues
 
TimeStampType m_AllowableTimingError
 
unsigned int m_NumberOfParameters
 
std::vector< std::pair
< TimeStampType, cv::Point3d > > * 
m_PointData
 
mitk::TrackingAndTimeStampsContainerm_TrackingData
 
bool m_Verbose
 

Detailed Description

Minimises the RMS error around a stationary invariant point.

See also
itk::InvariantPointCalibrationCostFunction
itk::VideoHandEyeCalibrationCostFunction

Member Typedef Documentation

Constructor & Destructor Documentation

itk::UltrasoundPinCalibrationCostFunction::UltrasoundPinCalibrationCostFunction ( )
protected
itk::UltrasoundPinCalibrationCostFunction::~UltrasoundPinCalibrationCostFunction ( )
protectedvirtual
itk::UltrasoundPinCalibrationCostFunction::UltrasoundPinCalibrationCostFunction ( const UltrasoundPinCalibrationCostFunction )
protected

Member Function Documentation

cv::Matx44d itk::UltrasoundPinCalibrationCostFunction::GetCalibrationTransformation ( const ParametersType parameters) const
overridevirtual
virtual bool itk::UltrasoundPinCalibrationCostFunction::GetOptimiseScaleFactors ( ) const
virtual
virtual mitk::Point2D itk::UltrasoundPinCalibrationCostFunction::GetScaleFactors ( ) const
virtual
cv::Matx44d itk::UltrasoundPinCalibrationCostFunction::GetScalingTransformation ( const ParametersType parameters) const
protected

Computes the scaling transformation.

static Pointer itk::UltrasoundPinCalibrationCostFunction::New ( )
static
UltrasoundPinCalibrationCostFunction& itk::UltrasoundPinCalibrationCostFunction::operator= ( const UltrasoundPinCalibrationCostFunction )
protected
virtual void itk::UltrasoundPinCalibrationCostFunction::SetOptimiseScaleFactors ( bool  _arg)
virtual
virtual void itk::UltrasoundPinCalibrationCostFunction::SetScaleFactors ( mitk::Point2D  _arg)
virtual

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