CMS 3D CMS Logo

List of all members | Classes | Public Types | Public Member Functions
AlignmentAlgorithmBase Class Referenceabstract

#include <AlignmentAlgorithmBase.h>

Inheritance diagram for AlignmentAlgorithmBase:
ApeSettingAlgorithm CSCOverlapsAlignmentAlgorithm HIPAlignmentAlgorithm MillePedeAlignmentAlgorithm MuonAlignmentFromReference SurveyAlignmentAlgorithm

Classes

class  EndRunInfo
 define run information passed to algorithms (in endRun) More...
 
class  EventInfo
 define event information passed to algorithms More...
 

Public Types

typedef std::pair< const Trajectory *, const reco::Track * > ConstTrajTrackPair
 
typedef std::vector< ConstTrajTrackPairConstTrajTrackPairCollection
 
using RunNumber = align::RunNumber
 
using RunRange = align::RunRange
 

Public Member Functions

virtual bool addCalibrations (const Calibrations &)
 
bool addCalibrations (const CalibrationsOwner &cals)
 
 AlignmentAlgorithmBase (const edm::ParameterSet &, const edm::ConsumesCollector &)
 Constructor. More...
 
virtual void beginLuminosityBlock (const edm::EventSetup &setup)
 called at begin of luminosity block (no lumi block info passed yet) More...
 
virtual void beginRun (const edm::Run &, const edm::EventSetup &, bool changed)
 called at begin of run More...
 
virtual void endLuminosityBlock (const edm::EventSetup &setup)
 called at end of luminosity block (no lumi block info passed yet) More...
 
virtual void endRun (const EndRunInfo &runInfo, const edm::EventSetup &setup)
 called at end of run - order of arguments like in EDProducer etc. More...
 
virtual void initialize (const edm::EventSetup &setup, AlignableTracker *tracker, AlignableMuon *muon, AlignableExtras *extras, AlignmentParameterStore *store)=0
 Call at beginning of job (must be implemented in derived class) More...
 
virtual bool processesEvents ()
 Returns whether algorithm proccesses events in current configuration. More...
 
virtual void run (const edm::EventSetup &setup, const EventInfo &eventInfo)=0
 Run the algorithm (must be implemented in derived class) More...
 
virtual bool setParametersForRunRange (const RunRange &rr)
 
virtual void startNewLoop ()
 
virtual bool storeAlignments ()
 Returns whether algorithm produced results to be stored. More...
 
virtual bool supportsCalibrations ()
 
virtual void terminate (const edm::EventSetup &iSetup)=0
 Call at end of each loop (must be implemented in derived class) More...
 
virtual void terminate ()
 Called at end of job (must be implemented in derived class) More...
 
virtual ~AlignmentAlgorithmBase ()
 Destructor. More...
 

Detailed Description

Definition at line 60 of file AlignmentAlgorithmBase.h.

Member Typedef Documentation

◆ ConstTrajTrackPair

Definition at line 67 of file AlignmentAlgorithmBase.h.

◆ ConstTrajTrackPairCollection

Definition at line 68 of file AlignmentAlgorithmBase.h.

◆ RunNumber

Definition at line 69 of file AlignmentAlgorithmBase.h.

◆ RunRange

Definition at line 70 of file AlignmentAlgorithmBase.h.

Constructor & Destructor Documentation

◆ AlignmentAlgorithmBase()

AlignmentAlgorithmBase::AlignmentAlgorithmBase ( const edm::ParameterSet ,
const edm::ConsumesCollector  
)
inline

Constructor.

Definition at line 115 of file AlignmentAlgorithmBase.h.

115 {}

◆ ~AlignmentAlgorithmBase()

virtual AlignmentAlgorithmBase::~AlignmentAlgorithmBase ( )
inlinevirtual

Destructor.

Definition at line 118 of file AlignmentAlgorithmBase.h.

118 {}

Member Function Documentation

◆ addCalibrations() [1/2]

virtual bool AlignmentAlgorithmBase::addCalibrations ( const Calibrations )
inlinevirtual

Pass integrated calibrations to algorithm, to be called after initialize() Calibrations' ownership is NOT passed to algorithm

Definition at line 132 of file AlignmentAlgorithmBase.h.

Referenced by addCalibrations().

132 { return false; }

◆ addCalibrations() [2/2]

bool AlignmentAlgorithmBase::addCalibrations ( const CalibrationsOwner cals)
inline

Definition at line 134 of file AlignmentAlgorithmBase.h.

References addCalibrations(), and createJobs::tmp.

134  {
136  tmp.reserve(cals.size());
137  for (const auto &ptr : cals) {
138  tmp.push_back(ptr.get());
139  }
140  return addCalibrations(tmp);
141  }
std::vector< IntegratedCalibrationBase * > Calibrations
virtual bool addCalibrations(const Calibrations &)
tmp
align.sh
Definition: createJobs.py:716

◆ beginLuminosityBlock()

virtual void AlignmentAlgorithmBase::beginLuminosityBlock ( const edm::EventSetup setup)
inlinevirtual

called at begin of luminosity block (no lumi block info passed yet)

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 170 of file AlignmentAlgorithmBase.h.

170 {}

◆ beginRun()

virtual void AlignmentAlgorithmBase::beginRun ( const edm::Run ,
const edm::EventSetup ,
bool  changed 
)
inlinevirtual

called at begin of run

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 164 of file AlignmentAlgorithmBase.h.

164 {}

◆ endLuminosityBlock()

virtual void AlignmentAlgorithmBase::endLuminosityBlock ( const edm::EventSetup setup)
inlinevirtual

called at end of luminosity block (no lumi block info passed yet)

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 173 of file AlignmentAlgorithmBase.h.

173 {}

◆ endRun()

virtual void AlignmentAlgorithmBase::endRun ( const EndRunInfo runInfo,
const edm::EventSetup setup 
)
inlinevirtual

called at end of run - order of arguments like in EDProducer etc.

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 167 of file AlignmentAlgorithmBase.h.

167 {}

◆ initialize()

virtual void AlignmentAlgorithmBase::initialize ( const edm::EventSetup setup,
AlignableTracker tracker,
AlignableMuon muon,
AlignableExtras extras,
AlignmentParameterStore store 
)
pure virtual

◆ processesEvents()

virtual bool AlignmentAlgorithmBase::processesEvents ( )
inlinevirtual

Returns whether algorithm proccesses events in current configuration.

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 144 of file AlignmentAlgorithmBase.h.

144 { return true; }

◆ run()

virtual void AlignmentAlgorithmBase::run ( const edm::EventSetup setup,
const EventInfo eventInfo 
)
pure virtual

◆ setParametersForRunRange()

virtual bool AlignmentAlgorithmBase::setParametersForRunRange ( const RunRange rr)
inlinevirtual

called in order to pass parameters to alignables for a specific run range in case the algorithm supports run range dependent alignment.

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 177 of file AlignmentAlgorithmBase.h.

177 { return false; };

◆ startNewLoop()

virtual void AlignmentAlgorithmBase::startNewLoop ( void  )
inlinevirtual

Called at start of loop, default implementation is dummy for non-iterative algorithms

Reimplemented in MuonAlignmentFromReference, and HIPAlignmentAlgorithm.

Definition at line 153 of file AlignmentAlgorithmBase.h.

153 {}

◆ storeAlignments()

virtual bool AlignmentAlgorithmBase::storeAlignments ( )
inlinevirtual

Returns whether algorithm produced results to be stored.

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 147 of file AlignmentAlgorithmBase.h.

147 { return true; }

◆ supportsCalibrations()

virtual bool AlignmentAlgorithmBase::supportsCalibrations ( )
inlinevirtual

Returns whether calibrations is supported by algorithm, default implementation returns false.

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 129 of file AlignmentAlgorithmBase.h.

129 { return false; }

◆ terminate() [1/2]

virtual void AlignmentAlgorithmBase::terminate ( const edm::EventSetup iSetup)
pure virtual

◆ terminate() [2/2]

virtual void AlignmentAlgorithmBase::terminate ( )
inlinevirtual

Called at end of job (must be implemented in derived class)

Reimplemented in MillePedeAlignmentAlgorithm.

Definition at line 158 of file AlignmentAlgorithmBase.h.

158 {}