ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | List of all members
InDet::IInDetBeamSpotTool Class Referenceabstract

#include <IInDetBeamSpotTool.h>

Inheritance diagram for InDet::IInDetBeamSpotTool:
Collaboration diagram for InDet::IInDetBeamSpotTool:

Public Types

enum  FitStatus { unsolved =0, problems, failed, successful }
 Internally used enum for fit status. More...
 
enum  FitID {
  trackChi2 =1, trackChi2Widths =2, vertexLL =3, vertexChi2 =4,
  RooFitLL = 6, unknown = 99
}
 Beamspot determination type. More...
 

Public Member Functions

virtual ~IInDetBeamSpotTool ()
 
virtual StatusCode initialize ()=0
 Standard initialize. More...
 
virtual StatusCode finalize ()=0
 Standard finalize. More...
 
virtual FitStatus fit (std::vector< BeamSpot::VrtHolder > &)=0
 Attempt a to find a solution of the beamspot. More...
 
virtual FitID getFitID () const =0
 A unique ID for the specific fit type. More...
 
virtual IInDetBeamSpotToolClone ()=0
 
virtual std::map< std::string, double > getCovMap () const =0
 
virtual std::map< std::string, double > getParamMap () const =0
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 Retrieve interface ID. More...
 

Detailed Description

Abstract class for all beamspot determination algorithms. Any class for finding the position of the beamspot needs to derive itself from this class.

Definition at line 45 of file IInDetBeamSpotTool.h.

Member Enumeration Documentation

◆ FitID

Beamspot determination type.

Enumerator
trackChi2 
trackChi2Widths 
vertexLL 
vertexChi2 
RooFitLL 
unknown 

Definition at line 51 of file IInDetBeamSpotTool.h.

◆ FitStatus

Internally used enum for fit status.

Useful for quick checks.

Enumerator
unsolved 
problems 
failed 
successful 

Definition at line 49 of file IInDetBeamSpotTool.h.

Constructor & Destructor Documentation

◆ ~IInDetBeamSpotTool()

virtual InDet::IInDetBeamSpotTool::~IInDetBeamSpotTool ( )
inlinevirtual

Definition at line 47 of file IInDetBeamSpotTool.h.

47 {}

Member Function Documentation

◆ Clone()

virtual IInDetBeamSpotTool* InDet::IInDetBeamSpotTool::Clone ( )
pure virtual

◆ finalize()

virtual StatusCode InDet::IInDetBeamSpotTool::finalize ( )
pure virtual

Standard finalize.

Will attempt a solution if not already done

Implemented in InDet::InDetBeamSpotRooFit, and InDet::InDetBeamSpotVertex.

◆ fit()

virtual FitStatus InDet::IInDetBeamSpotTool::fit ( std::vector< BeamSpot::VrtHolder > &  )
pure virtual

Attempt a to find a solution of the beamspot.

Implemented in InDet::InDetBeamSpotRooFit, and InDet::InDetBeamSpotVertex.

◆ getCovMap()

virtual std::map<std::string,double> InDet::IInDetBeamSpotTool::getCovMap ( ) const
pure virtual

◆ getFitID()

virtual FitID InDet::IInDetBeamSpotTool::getFitID ( ) const
pure virtual

A unique ID for the specific fit type.

Implemented in InDet::InDetBeamSpotRooFit, and InDet::InDetBeamSpotVertex.

◆ getParamMap()

virtual std::map<std::string,double> InDet::IInDetBeamSpotTool::getParamMap ( ) const
pure virtual

◆ initialize()

virtual StatusCode InDet::IInDetBeamSpotTool::initialize ( )
pure virtual

Standard initialize.

Implemented in InDet::InDetBeamSpotRooFit, and InDet::InDetBeamSpotVertex.

◆ interfaceID()

static const InterfaceID& InDet::IInDetBeamSpotTool::interfaceID ( )
inlinestatic

Retrieve interface ID.

Definition at line 53 of file IInDetBeamSpotTool.h.

53 { return IID_IInDetBeamSpotTool; }

The documentation for this class was generated from the following file:
InDet::IInDetBeamSpotTool::vertexLL
@ vertexLL
Definition: IInDetBeamSpotTool.h:51
InDet::IInDetBeamSpotTool::vertexChi2
@ vertexChi2
Definition: IInDetBeamSpotTool.h:51
InDet::IInDetBeamSpotTool::RooFitLL
@ RooFitLL
Definition: IInDetBeamSpotTool.h:51
InDet::IInDetBeamSpotTool::successful
@ successful
Definition: IInDetBeamSpotTool.h:49
InDet::IInDetBeamSpotTool::problems
@ problems
Definition: IInDetBeamSpotTool.h:49
InDet::IInDetBeamSpotTool::unsolved
@ unsolved
Definition: IInDetBeamSpotTool.h:49
InDet::IInDetBeamSpotTool::failed
@ failed
Definition: IInDetBeamSpotTool.h:49
InDet::IInDetBeamSpotTool::trackChi2
@ trackChi2
Definition: IInDetBeamSpotTool.h:51
InDet::IInDetBeamSpotTool::unknown
@ unknown
Definition: IInDetBeamSpotTool.h:51
InDet::IInDetBeamSpotTool::trackChi2Widths
@ trackChi2Widths
Definition: IInDetBeamSpotTool.h:51