PedeLabelerBase Class Reference

#include <PedeLabelerBase.h>

Inheritance diagram for PedeLabelerBase:

Classes
class	TopLevelAlignables

Public Types
using	RunNumber = align::RunNumber
using	RunRange = align::RunRange
using	RunRanges = align::RunRanges

Public Member Functions
virtual void	addCalibrations (const std::vector< IntegratedCalibrationBase * > &iCals)
	tell labeler to treat also integrated calibrations More...
const AlignableExtras *	alignableExtras () const
virtual Alignable *	alignableFromLabel (unsigned int label) const =0
virtual unsigned int	alignableLabel (Alignable *alignable) const =0
virtual unsigned int	alignableLabelFromLabel (unsigned int label) const =0
	alignable label from parameter label (works also for alignable label...) More...
virtual unsigned int	alignableLabelFromParamAndInstance (Alignable *alignable, unsigned int param, unsigned int instance) const =0
const AlignableMuon *	alignableMuon () const
const AlignableTracker *	alignableTracker () const
virtual unsigned int	calibrationLabel (const IntegratedCalibrationBase *calib, unsigned int paramNum) const
	label for parameter 'paramNum' (counted from 0) of an integrated calibration More...
virtual std::pair< IntegratedCalibrationBase *, unsigned int >	calibrationParamFromLabel (unsigned int label) const
virtual unsigned int	firstFreeLabel () const
virtual bool	hasSplitParameters (Alignable *alignable) const =0
	returns true if the alignable has parameters that are split into various bins More...
virtual unsigned int	lasBeamIdFromLabel (unsigned int label) const =0
virtual unsigned int	lasBeamLabel (unsigned int lasBeamId) const =0
virtual unsigned int	maxNumberOfParameterInstances () const =0
	returns the maximum number of instances for any parameter of an Alignable* More...
virtual unsigned int	numberOfParameterInstances (Alignable *alignable, int param=-1) const =0
	returns the number of instances for a given parameter More...
unsigned int	parameterInstanceOffset () const
	offset in labels between consecutive parameter instances of Alignable*s More...
virtual unsigned int	parameterLabel (unsigned int aliLabel, unsigned int parNum) const =0
	returns the label for a given alignable parameter number combination More...
virtual unsigned int	parameterLabel (Alignable *alignable, unsigned int parNum, const AlignmentAlgorithmBase::EventInfo &eventInfo, const TrajectoryStateOnSurface &tsos) const =0
virtual unsigned int	paramNumFromLabel (unsigned int paramLabel) const =0
	parameter number, 0 <= .. < theMaxNumParam, belonging to unique parameter label More...
	PedeLabelerBase (const TopLevelAlignables &alignables, const edm::ParameterSet &config)
	constructor from three Alignables (null pointers allowed ) More...
virtual const RunRange &	runRangeFromLabel (unsigned int label) const
virtual	~PedeLabelerBase ()

Static Public Attributes
static const unsigned int	theMaxNumParam = RigidBodyAlignmentParameters::N_PARAM + 14
static const unsigned int	theMinLabel = 1
static const unsigned int	theParamInstanceOffset = 700000

Protected Member Functions
virtual unsigned int	firstNonAlignableLabel () const
const AlignableObjectId &	objectIdProvider () const
	Return tracker alignable object ID provider derived from the tracker's geometry. More...

Protected Attributes
const RunRange	theOpenRunRange

Private Attributes
const AlignableObjectId	alignableObjectId_
std::vector< std::pair< IntegratedCalibrationBase *, unsigned int > >	theCalibrationLabels
	pairs of calibrations and their first label More...
const TopLevelAlignables	topLevelAlignables_

Detailed Description

Baseclass for pede labelers

Original author: Andreas Mussgiller, January 2011

Date

2011/02/18 17:08:13

Revision

1.2

(last update by

Author

mussgill

)

Definition at line 34 of file PedeLabelerBase.h.

Member Typedef Documentation

using PedeLabelerBase::RunNumber = align::RunNumber

Definition at line 36 of file PedeLabelerBase.h.

using PedeLabelerBase::RunRange = align::RunRange

Definition at line 37 of file PedeLabelerBase.h.

using PedeLabelerBase::RunRanges = align::RunRanges

Definition at line 38 of file PedeLabelerBase.h.

Constructor & Destructor Documentation

PedeLabelerBase::PedeLabelerBase	(	const TopLevelAlignables &	alignables,
		const edm::ParameterSet &	config
	)

constructor from three Alignables (null pointers allowed )

Definition at line 28 of file PedeLabelerBase.cc.

References PedeLabelerBase::TopLevelAlignables::aliMuon_, PedeLabelerBase::TopLevelAlignables::aliTracker_, and AlignableObjectId::commonObjectIdProvider().

    : theOpenRunRange(std::make_pair<RunNumber, RunNumber>(
          RunNumber(cond::timeTypeSpecs[cond::runnumber].beginValue),  // since we know we have a runnumber here, we can
          RunNumber(
              cond::timeTypeSpecs[cond::runnumber].endValue))),  // simply convert the Time_t to make the compiler happy
      topLevelAlignables_(alignables),
      alignableObjectId_{AlignableObjectId::commonObjectIdProvider(alignables.aliTracker_, alignables.aliMuon_)} {}

virtual PedeLabelerBase::~PedeLabelerBase ( )

inlinevirtual

Definition at line 51 of file PedeLabelerBase.h.

References addCalibrations(), alignableLabel(), alignableLabelFromParamAndInstance(), ZMuMuAnalysisNtupler_cff::eventInfo, hasSplitParameters(), instance, lasBeamLabel(), maxNumberOfParameterInstances(), numberOfParameterInstances(), and parameterLabel().

{}

Member Function Documentation

void PedeLabelerBase::addCalibrations ( const std::vector< IntegratedCalibrationBase * > &  iCals )

virtual

tell labeler to treat also integrated calibrations

Definition at line 101 of file PedeLabelerBase.cc.

References firstFreeLabel(), and theCalibrationLabels.

Referenced by ~PedeLabelerBase().

                                                                                         {
  unsigned int nextId = this->firstFreeLabel();  // so far next free label

  // Now foresee labels for new calibrations:
  for (auto iCal = iCals.begin(); iCal != iCals.end(); ++iCal) {
    if (*iCal) {
      theCalibrationLabels.push_back(std::make_pair(*iCal, nextId));
      nextId += (*iCal)->numParameters();
    } else {
      edm::LogError("LogicError") << "@SUB=PedeLabelerBase::addCalibrations"
                                  << "Ignoring nullPtr.";
    }
  }
}

const AlignableExtras* PedeLabelerBase::alignableExtras ( ) const

inline

Definition at line 107 of file PedeLabelerBase.h.

References PedeLabelerBase::TopLevelAlignables::aliExtras_, and topLevelAlignables_.

{ return topLevelAlignables_.aliExtras_; }

virtual Alignable* PedeLabelerBase::alignableFromLabel ( unsigned int  label ) const

pure virtual

Alignable from alignable or parameter label, null if no alignable (but error only if not las beam, either!)

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by parameterInstanceOffset(), and PedeReader::setParameter().

virtual unsigned int PedeLabelerBase::alignableLabel ( Alignable *  alignable ) const

pure virtual

uniqueId of Alignable, 0 if alignable not known between this ID and the next there is enough 'space' to add parameter numbers 0...nPar-1 to make unique IDs for the labels of active parameters

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by PedeReader::checkAliParams(), PedeSteerer::hierarchyConstraint(), PedeSteerer::presigmasFile(), PedeReader::setParameter(), and ~PedeLabelerBase().

virtual unsigned int PedeLabelerBase::alignableLabelFromLabel ( unsigned int  label ) const

pure virtual

alignable label from parameter label (works also for alignable label...)

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by parameterInstanceOffset().

virtual unsigned int PedeLabelerBase::alignableLabelFromParamAndInstance ( Alignable *  alignable, unsigned int  param, unsigned int  instance  ) const

pure virtual

uniqueId of Alignable for a given parameter index and instance, 0 if alignable not known between this ID and the next there is enough 'space' to add parameter numbers 0...nPar-1 to make unique IDs for the labels of active parameters

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by PedeSteererWeakModeConstraints::constructConstraints(), PedeSteerer::fixParameter(), and ~PedeLabelerBase().

const AlignableMuon* PedeLabelerBase::alignableMuon ( ) const

inline

Definition at line 106 of file PedeLabelerBase.h.

References PedeLabelerBase::TopLevelAlignables::aliMuon_, and topLevelAlignables_.

{ return topLevelAlignables_.aliMuon_; }

const AlignableTracker* PedeLabelerBase::alignableTracker ( ) const

inline

Definition at line 105 of file PedeLabelerBase.h.

References PedeLabelerBase::TopLevelAlignables::aliTracker_, and topLevelAlignables_.

Referenced by PedeReader::checkAliParams().

{ return topLevelAlignables_.aliTracker_; }

unsigned int PedeLabelerBase::calibrationLabel ( const IntegratedCalibrationBase *  calib, unsigned int  paramNum  ) const

virtual

label for parameter 'paramNum' (counted from 0) of an integrated calibration

Definition at line 75 of file PedeLabelerBase.cc.

References Exception, dqmdumpme::first, IntegratedCalibrationBase::name(), and theCalibrationLabels.

Referenced by runRangeFromLabel().

                                                                                                                  {
  if (!calib) {
    throw cms::Exception("LogicError") << "PedeLabelerBase::calibrationLabel: "
                                       << "nullPtr passed!\n";
  }

  // loop on all known IntegratedCalibration's
  for (auto iCal = theCalibrationLabels.begin(); iCal != theCalibrationLabels.end(); ++iCal) {
    if (iCal->first == calib) {  // found IntegratedCalibrationBase
      if (paramNum < iCal->first->numParameters()) {
        return iCal->second + paramNum;
      } else {  // paramNum out of range!
        edm::LogError("LogicError") << "@SUB=PedeLabelerBase::calibrationLabel"
                                    << "IntegratedCalibration " << calib->name() << " has only "
                                    << iCal->first->numParameters() << " parameters, but " << paramNum << "requested!";
      }
    }
  }

  edm::LogError("LogicError") << "@SUB=PedeLabelerBase::calibrationLabel"
                              << "IntegratedCalibration " << calib->name() << " not known or too few parameters.";

  return 0;
}

std::pair< IntegratedCalibrationBase *, unsigned int > PedeLabelerBase::calibrationParamFromLabel ( unsigned int  label ) const

virtual

calibration and its parameter number from label, if label does not belong to any calibration return nullptr as pair.first

Definition at line 37 of file PedeLabelerBase.cc.

References edm::second(), and theCalibrationLabels.

Referenced by parameterInstanceOffset(), and PedeReader::read().

                              {
  // Quick check whether label is in range of calibration labels:
  if (!theCalibrationLabels.empty() && label >= theCalibrationLabels.front().second) {
    // Loop on all known IntegratedCalibration's:
    for (auto iCal = theCalibrationLabels.begin(); iCal != theCalibrationLabels.end(); ++iCal) {
      if (label >= iCal->second && label < iCal->second + iCal->first->numParameters()) {
        // Label fits in range for this calibration, so return calibration
        // and subtract first label of this calibration from label.
        return std::make_pair(iCal->first, label - iCal->second);
      }
    }
    edm::LogError("LogicError") << "@SUB=PedeLabelerBase::calibrationParamFromLabel"
                                << "Label " << label << "larger than first calibration's label, "
                                << "but no calibration fits!";
  }

  // Return that nothing fits:
  return std::pair<IntegratedCalibrationBase *, unsigned int>(nullptr, 0);
}

unsigned int PedeLabelerBase::firstFreeLabel ( ) const

virtual

first free label not yet used (for hacks within millepede...) valid only after last call to addCalibrations(..)

Definition at line 59 of file PedeLabelerBase.cc.

References firstNonAlignableLabel(), and theCalibrationLabels.

Referenced by addCalibrations(), and runRangeFromLabel().

                                                   {
  unsigned int nextId = this->firstNonAlignableLabel();

  for (auto iCal = theCalibrationLabels.begin(); iCal != theCalibrationLabels.end(); ++iCal) {
    nextId += iCal->first->numParameters();
  }

  return nextId;
}

unsigned int PedeLabelerBase::firstNonAlignableLabel ( ) const

protectedvirtual

first free label after everything about Alignables and LAS beams (to be used for calibrations)

Definition at line 70 of file PedeLabelerBase.cc.

References maxNumberOfParameterInstances(), and parameterInstanceOffset().

Referenced by firstFreeLabel().

                                                           {
  return this->parameterInstanceOffset() * this->maxNumberOfParameterInstances() + 1;
}

virtual bool PedeLabelerBase::hasSplitParameters ( Alignable *  alignable ) const

pure virtual

returns true if the alignable has parameters that are split into various bins

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by ~PedeLabelerBase().

virtual unsigned int PedeLabelerBase::lasBeamIdFromLabel ( unsigned int  label ) const

pure virtual

las beam id from las beam or parameter label zero and error if not a valid las beam label

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by parameterInstanceOffset(), and PedeReader::setParameter().

virtual unsigned int PedeLabelerBase::lasBeamLabel ( unsigned int  lasBeamId ) const

pure virtual

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by ~PedeLabelerBase().

virtual unsigned int PedeLabelerBase::maxNumberOfParameterInstances ( ) const

pure virtual

returns the maximum number of instances for any parameter of an Alignable*

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by firstNonAlignableLabel(), PedeSteererWeakModeConstraints::PedeSteererWeakModeConstraints(), and ~PedeLabelerBase().

virtual unsigned int PedeLabelerBase::numberOfParameterInstances ( Alignable *  alignable, int  param = -1  ) const

pure virtual

returns the number of instances for a given parameter

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by PedeSteerer::fixParameters(), and ~PedeLabelerBase().

const AlignableObjectId& PedeLabelerBase::objectIdProvider ( ) const

inlineprotected

Return tracker alignable object ID provider derived from the tracker's geometry.

Definition at line 119 of file PedeLabelerBase.h.

References alignableObjectId_.

Referenced by MomentumDependentPedeLabeler::buildMomentumDependencyMap(), and RunRangeDependentPedeLabeler::buildRunRangeDependencyMap().

{ return alignableObjectId_; }

unsigned int PedeLabelerBase::parameterInstanceOffset ( ) const

inline

offset in labels between consecutive parameter instances of Alignable*s

Definition at line 82 of file PedeLabelerBase.h.

References alignableFromLabel(), alignableLabelFromLabel(), calibrationParamFromLabel(), label, lasBeamIdFromLabel(), volumeBasedMagneticField_1103l_cfi::paramLabel, paramNumFromLabel(), and theParamInstanceOffset.

Referenced by firstNonAlignableLabel().

{ return theParamInstanceOffset; }

virtual unsigned int PedeLabelerBase::parameterLabel ( unsigned int  aliLabel, unsigned int  parNum  ) const

pure virtual

returns the label for a given alignable parameter number combination

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by PedeSteererWeakModeConstraints::constructConstraints(), PedeSteerer::fixParameter(), PedeSteerer::hierarchyConstraint(), PedeSteerer::presigmasFile(), and ~PedeLabelerBase().

virtual unsigned int PedeLabelerBase::parameterLabel ( Alignable *  alignable, unsigned int  parNum, const AlignmentAlgorithmBase::EventInfo &  eventInfo, const TrajectoryStateOnSurface &  tsos  ) const

pure virtual

returns the label for a given alignable parameter number combination in case the parameters are split into various instances

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

virtual unsigned int PedeLabelerBase::paramNumFromLabel ( unsigned int  paramLabel ) const

pure virtual

parameter number, 0 <= .. < theMaxNumParam, belonging to unique parameter label

Implemented in RunRangeDependentPedeLabeler, MomentumDependentPedeLabeler, and PedeLabeler.

Referenced by parameterInstanceOffset(), and PedeReader::setParameter().

virtual const RunRange& PedeLabelerBase::runRangeFromLabel ( unsigned int  label ) const

inlinevirtual

Reimplemented in RunRangeDependentPedeLabeler.

Definition at line 98 of file PedeLabelerBase.h.

References calibrationLabel(), firstFreeLabel(), and theOpenRunRange.

Referenced by PedeReader::read().

{ return theOpenRunRange; }

Member Data Documentation

const AlignableObjectId PedeLabelerBase::alignableObjectId_

private

Definition at line 125 of file PedeLabelerBase.h.

Referenced by objectIdProvider().

std::vector<std::pair<IntegratedCalibrationBase *, unsigned int> > PedeLabelerBase::theCalibrationLabels

private

pairs of calibrations and their first label

Definition at line 128 of file PedeLabelerBase.h.

Referenced by addCalibrations(), calibrationLabel(), calibrationParamFromLabel(), and firstFreeLabel().

const unsigned int PedeLabelerBase::theMaxNumParam = RigidBodyAlignmentParameters::N_PARAM + 14

static

Definition at line 109 of file PedeLabelerBase.h.

Referenced by PedeLabeler::buildMap(), MomentumDependentPedeLabeler::buildMap(), RunRangeDependentPedeLabeler::buildMap(), MillePedeMonitor::fillDerivatives(), MillePedeMonitor::init(), PedeLabeler::parameterLabel(), MomentumDependentPedeLabeler::parameterLabel(), RunRangeDependentPedeLabeler::parameterLabel(), PedeLabeler::paramNumFromLabel(), RunRangeDependentPedeLabeler::paramNumFromLabel(), and RunRangeDependentPedeLabeler::runRangeIndexFromLabel().

const unsigned int PedeLabelerBase::theMinLabel = 1

static

Definition at line 111 of file PedeLabelerBase.h.

Referenced by PedeLabeler::alignableFromLabel(), MomentumDependentPedeLabeler::alignableFromLabel(), RunRangeDependentPedeLabeler::alignableFromLabel(), PedeLabeler::buildMap(), MomentumDependentPedeLabeler::buildMap(), RunRangeDependentPedeLabeler::buildMap(), PedeLabeler::lasBeamIdFromLabel(), MomentumDependentPedeLabeler::lasBeamIdFromLabel(), RunRangeDependentPedeLabeler::lasBeamIdFromLabel(), PedeLabeler::paramNumFromLabel(), MomentumDependentPedeLabeler::paramNumFromLabel(), and RunRangeDependentPedeLabeler::paramNumFromLabel().

const RunRange PedeLabelerBase::theOpenRunRange

protected

Definition at line 121 of file PedeLabelerBase.h.

Referenced by RunRangeDependentPedeLabeler::runRangeFromLabel(), and runRangeFromLabel().

const unsigned int PedeLabelerBase::theParamInstanceOffset = 700000

static

Definition at line 110 of file PedeLabelerBase.h.

Referenced by MomentumDependentPedeLabeler::alignableLabelFromParamAndInstance(), RunRangeDependentPedeLabeler::alignableLabelFromParamAndInstance(), MomentumDependentPedeLabeler::buildMap(), RunRangeDependentPedeLabeler::buildMap(), MomentumDependentPedeLabeler::buildReverseMap(), RunRangeDependentPedeLabeler::buildReverseMap(), parameterInstanceOffset(), MomentumDependentPedeLabeler::parameterLabel(), RunRangeDependentPedeLabeler::parameterLabel(), MomentumDependentPedeLabeler::paramNumFromLabel(), and RunRangeDependentPedeLabeler::runRangeFromLabel().

const TopLevelAlignables PedeLabelerBase::topLevelAlignables_

private

Definition at line 124 of file PedeLabelerBase.h.

Referenced by alignableExtras(), alignableMuon(), and alignableTracker().