CMS 3D CMS Logo

List of all members | Public Member Functions
ClosestApproachOnHelices Class Referenceabstract

#include <ClosestApproachOnHelices.h>

Inheritance diagram for ClosestApproachOnHelices:
ClosestApproachInRPhi TangentApproachInRPhi TwoTrackMinimumDistance

Public Member Functions

virtual bool calculate (const FreeTrajectoryState &sta, const FreeTrajectoryState &stb)=0
 
virtual bool calculate (const TrajectoryStateOnSurface &sta, const TrajectoryStateOnSurface &stb)=0
 
virtual ClosestApproachOnHelicesclone () const =0
 
 ClosestApproachOnHelices ()
 
virtual GlobalPoint crossingPoint () const =0
 
virtual float distance () const =0
 
virtual std::pair< GlobalPoint, GlobalPointpoints () const =0
 
virtual bool status () const =0
 
virtual ~ClosestApproachOnHelices ()
 

Detailed Description

Abstract interface for classes which compute the points of closest approach of 2 helices.
For a pair of states, the calculate methods have to be called before any of the other methods. This will do all calculations needed to get the result. It returns a status which says whether the calculation was successful. This should be checked before getting the result. If the status is false and the results querried, an exception will be thrown.

Definition at line 20 of file ClosestApproachOnHelices.h.

Constructor & Destructor Documentation

◆ ClosestApproachOnHelices()

ClosestApproachOnHelices::ClosestApproachOnHelices ( )
inline

Definition at line 22 of file ClosestApproachOnHelices.h.

22 {}

◆ ~ClosestApproachOnHelices()

virtual ClosestApproachOnHelices::~ClosestApproachOnHelices ( )
inlinevirtual

Definition at line 24 of file ClosestApproachOnHelices.h.

24 {}

Member Function Documentation

◆ calculate() [1/2]

virtual bool ClosestApproachOnHelices::calculate ( const FreeTrajectoryState sta,
const FreeTrajectoryState stb 
)
pure virtual

◆ calculate() [2/2]

virtual bool ClosestApproachOnHelices::calculate ( const TrajectoryStateOnSurface sta,
const TrajectoryStateOnSurface stb 
)
pure virtual

◆ clone()

virtual ClosestApproachOnHelices* ClosestApproachOnHelices::clone ( ) const
pure virtual

◆ crossingPoint()

virtual GlobalPoint ClosestApproachOnHelices::crossingPoint ( ) const
pure virtual

Crossing point of the 2 helices, computed as an average of the points of closest approach. The average can be weighted or not, depending on the implementation.

Implemented in ClosestApproachInRPhi, TwoTrackMinimumDistance, and TangentApproachInRPhi.

◆ distance()

virtual float ClosestApproachOnHelices::distance ( ) const
pure virtual

Distance between the points of closest approach

Implemented in ClosestApproachInRPhi, TwoTrackMinimumDistance, and TangentApproachInRPhi.

◆ points()

virtual std::pair<GlobalPoint, GlobalPoint> ClosestApproachOnHelices::points ( ) const
pure virtual

Points of closest approach on the 2 helices

Implemented in ClosestApproachInRPhi, TwoTrackMinimumDistance, and TangentApproachInRPhi.

◆ status()

virtual bool ClosestApproachOnHelices::status ( ) const
pure virtual