BeamSpotOnlineProducer Class Reference

Inheritance diagram for BeamSpotOnlineProducer:

Public Member Functions
	BeamSpotOnlineProducer (const edm::ParameterSet &iConf)
	constructor More...
void	produce (edm::Event &iEvent, const edm::EventSetup &iSetup) override
	produce a beam spot class More...
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &iDesc)
	Fill descriptor. More...

Private Attributes
const edm::ESGetToken< BeamSpotObjects, BeamSpotObjectsRcd >	beamToken_
edm::ESWatcher< BeamSpotTransientObjectsRcd >	beamTransientRcdESWatcher_
const edm::ESGetToken< BeamSpotObjects, BeamSpotTransientObjectsRcd >	beamTransientToken_
const bool	changeFrame_
const edm::EDGetTokenT< L1GlobalTriggerEvmReadoutRecord >	l1GtEvmReadoutRecordToken_
const edm::EDGetTokenT< BeamSpotOnlineCollection >	scalerToken_
const unsigned int	theBeamShoutMode
double	theMaxR2
const double	theMaxZ
const double	theSetSigmaZ
const bool	useTransientRecord_

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T... >
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Detailed Description

---

class: BeamSpotOnlineProducer.h package: RecoVertex/BeamSpotProducer

author: Francisco Yumiceva, Fermilab (yumic.nosp@m.eva@.nosp@m.fnal..nosp@m.gov) modified by: Simone Gennai, INFN MIB

---

Definition at line 32 of file BeamSpotOnlineProducer.cc.

Constructor & Destructor Documentation

BeamSpotOnlineProducer()

BeamSpotOnlineProducer::BeamSpotOnlineProducer ( const edm::ParameterSet &  iConf )

explicit

constructor

Definition at line 61 of file BeamSpotOnlineProducer.cc.

References edm::ParameterSet::getParameter(), and theMaxR2.

    : changeFrame_(iconf.getParameter<bool>("changeToCMSCoordinates")),
      theMaxZ(iconf.getParameter<double>("maxZ")),
      theSetSigmaZ(iconf.getParameter<double>("setSigmaZ")),
      useTransientRecord_(iconf.getParameter<bool>("useTransientRecord")),
      scalerToken_(useTransientRecord_ ? edm::EDGetTokenT<BeamSpotOnlineCollection>()
                                       : consumes<BeamSpotOnlineCollection>(iconf.getParameter<InputTag>("src"))),
      l1GtEvmReadoutRecordToken_(consumes<L1GlobalTriggerEvmReadoutRecord>(iconf.getParameter<InputTag>("gtEvmLabel"))),
      beamToken_(esConsumes<BeamSpotObjects, BeamSpotObjectsRcd>()),
      beamTransientToken_(esConsumes<BeamSpotObjects, BeamSpotTransientObjectsRcd>()),
      theBeamShoutMode(iconf.getUntrackedParameter<unsigned int>("beamMode", 11)) {
  theMaxR2 = iconf.getParameter<double>("maxRadius");
  theMaxR2 *= theMaxR2;

  produces<reco::BeamSpot>();
}

Member Function Documentation

fillDescriptions()

void BeamSpotOnlineProducer::fillDescriptions ( edm::ConfigurationDescriptions &  iDesc )

static

Fill descriptor.

Definition at line 78 of file BeamSpotOnlineProducer.cc.

References edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addOptional(), edm::ParameterSetDescription::addUntracked(), edm::ConfigurationDescriptions::addWithDefaultLabel(), and ProducerED_cfi::InputTag.

                                                                                 {
  edm::ParameterSetDescription ps;
  ps.add<bool>("changeToCMSCoordinates", false);
  ps.add<double>("maxZ", 40.);
  ps.add<double>("setSigmaZ", -1.);
  ps.addUntracked<unsigned int>("beamMode", 11);
  ps.addOptional<InputTag>("src", InputTag("hltScalersRawToDigi"))->setComment("SCAL decommissioned after Run 2");
  ps.add<InputTag>("gtEvmLabel", InputTag(""));
  ps.add<double>("maxRadius", 2.0);
  ps.add<bool>("useTransientRecord", false);
  iDesc.addWithDefaultLabel(ps);
}

produce()

void BeamSpotOnlineProducer::produce ( edm::Event &  iEvent, const edm::EventSetup &  iSetup  )

override

produce a beam spot class

Definition at line 91 of file BeamSpotOnlineProducer.cc.

References funct::abs(), L1GtfeExtWord::beamMode(), align::BeamSpot, beamToken_, beamTransientRcdESWatcher_, beamTransientToken_, BeamSpotObjects::beamWidthX(), BeamSpotObjects::beamWidthY(), BeamSpotObjects::betaStar(), changeFrame_, edm::ESWatcher< T >::check(), BeamSpotObjects::covariance(), reco::BeamSpot::dimension, BeamSpotOnline::dxdz(), BeamSpotObjects::dxdz(), BeamSpotOnline::dydz(), BeamSpotObjects::dydz(), BeamSpotObjects::emittanceX(), BeamSpotObjects::emittanceY(), BeamSpotOnline::err_sigma_z(), BeamSpotOnline::err_x(), BeamSpotOnline::err_y(), BeamSpotOnline::err_z(), f, edm::EventSetup::getData(), edm::EventSetup::getHandle(), L1GlobalTriggerEvmReadoutRecord::gtfeWord(), mps_fire::i, iEvent, dqmiolumiharvest::j, l1GtEvmReadoutRecordToken_, reco::BeamSpot::LHC, makeMuonMisalignmentScenario::matrix, eostools::move(), edm::ESHandle< T >::product(), diffTwoXMLs::r2, mps_fire::result, scalerToken_, BeamSpotOnline::sigma_z(), beamSpotPI::sigmaZ, BeamSpotObjects::sigmaZ(), theBeamShoutMode, theMaxR2, theMaxZ, theSetSigmaZ, reco::BeamSpot::Tracker, useTransientRecord_, BeamSpotOnline::width_x(), BeamSpotOnline::width_y(), BeamSpotOnline::x(), BeamSpotObjects::x(), BeamSpotOnline::y(), BeamSpotObjects::y(), BeamSpotOnline::z(), and BeamSpotObjects::z().

                                                                            {
  // product is a reco::BeamSpot object
  auto result = std::make_unique<reco::BeamSpot>();
  reco::BeamSpot aSpot;
  //shout MODE only in stable beam
  bool shoutMODE = false;
  edm::Handle<L1GlobalTriggerEvmReadoutRecord> gtEvmReadoutRecord;
  if (iEvent.getByToken(l1GtEvmReadoutRecordToken_, gtEvmReadoutRecord)) {
    if (gtEvmReadoutRecord->gtfeWord().beamMode() == theBeamShoutMode)
      shoutMODE = true;
  } else {
    shoutMODE = true;
  }
  bool fallBackToDB = false;
  if (useTransientRecord_) {
    auto const& spotDB = iSetup.getData(beamTransientToken_);
    if (spotDB.beamType() != 2) {
      if (shoutMODE && beamTransientRcdESWatcher_.check(iSetup)) {
        edm::LogWarning("BeamSpotOnlineProducer")
            << "Online Beam Spot producer falls back to DB value because the ESProducer returned a fake beamspot ";
      }
      fallBackToDB = true;
    } else {
      // translate from BeamSpotObjects to reco::BeamSpot
      // in case we need to switch to LHC reference frame
      // ignore for the moment rotations, and translations
      double f = 1.;
      if (changeFrame_)
        f = -1.;
      reco::BeamSpot::Point apoint(f * spotDB.x(), f * spotDB.y(), f * spotDB.z());

      reco::BeamSpot::CovarianceMatrix matrix;
      for (int i = 0; i < reco::BeamSpot::dimension; ++i) {
        for (int j = 0; j < reco::BeamSpot::dimension; ++j) {
          matrix(i, j) = spotDB.covariance(i, j);
        }
      }
      double sigmaZ = spotDB.sigmaZ();
      if (theSetSigmaZ > 0)
        sigmaZ = theSetSigmaZ;

      // this assume beam width same in x and y
      aSpot = reco::BeamSpot(apoint, sigmaZ, spotDB.dxdz(), spotDB.dydz(), spotDB.beamWidthX(), matrix);
      aSpot.setBeamWidthY(spotDB.beamWidthY());
      aSpot.setEmittanceX(spotDB.emittanceX());
      aSpot.setEmittanceY(spotDB.emittanceY());
      aSpot.setbetaStar(spotDB.betaStar());
      aSpot.setType(reco::BeamSpot::Tracker);
    }
  } else {
    // get scalar collection
    Handle<BeamSpotOnlineCollection> handleScaler;
    iEvent.getByToken(scalerToken_, handleScaler);

    // beam spot scalar object
    BeamSpotOnline spotOnline;

    // product is a reco::BeamSpot object
    auto result = std::make_unique<reco::BeamSpot>();

    if (!handleScaler->empty()) {
      // get one element
      spotOnline = *(handleScaler->begin());

      // in case we need to switch to LHC reference frame
      // ignore for the moment rotations, and translations
      double f = 1.;
      if (changeFrame_)
        f = -1.;

      reco::BeamSpot::Point apoint(f * spotOnline.x(), spotOnline.y(), f * spotOnline.z());

      reco::BeamSpot::CovarianceMatrix matrix;
      matrix(0, 0) = spotOnline.err_x() * spotOnline.err_x();
      matrix(1, 1) = spotOnline.err_y() * spotOnline.err_y();
      matrix(2, 2) = spotOnline.err_z() * spotOnline.err_z();
      matrix(3, 3) = spotOnline.err_sigma_z() * spotOnline.err_sigma_z();

      double sigmaZ = spotOnline.sigma_z();
      if (theSetSigmaZ > 0)
        sigmaZ = theSetSigmaZ;

      aSpot = reco::BeamSpot(apoint, sigmaZ, spotOnline.dxdz(), f * spotOnline.dydz(), spotOnline.width_x(), matrix);

      aSpot.setBeamWidthY(spotOnline.width_y());
      aSpot.setEmittanceX(0.);
      aSpot.setEmittanceY(0.);
      aSpot.setbetaStar(0.);
      aSpot.setType(reco::BeamSpot::LHC);  // flag value from scalars

      // check if we have a valid beam spot fit result from online DQM
      if (spotOnline.x() == 0 && spotOnline.y() == 0 && spotOnline.z() == 0 && spotOnline.width_x() == 0 &&
          spotOnline.width_y() == 0) {
        if (shoutMODE) {
          edm::LogWarning("BeamSpotOnlineProducer")
              << "Online Beam Spot producer falls back to DB value because the scaler values are zero ";
        }
        fallBackToDB = true;
      }
      double r2 = spotOnline.x() * spotOnline.x() + spotOnline.y() * spotOnline.y();
      if (std::abs(spotOnline.z()) >= theMaxZ || r2 >= theMaxR2) {
        if (shoutMODE) {
          edm::LogError("BeamSpotOnlineProducer")
              << "Online Beam Spot producer falls back to DB value because the scaler values are too big to be true :"
              << spotOnline.x() << " " << spotOnline.y() << " " << spotOnline.z();
        }
        fallBackToDB = true;
      }
    } else {
      //empty online beamspot collection: FED data was empty
      //the error should probably have been send at unpacker level
      fallBackToDB = true;
    }
  }
  if (fallBackToDB) {
    edm::ESHandle<BeamSpotObjects> beamhandle = iSetup.getHandle(beamToken_);
    const BeamSpotObjects* spotDB = beamhandle.product();

    // translate from BeamSpotObjects to reco::BeamSpot
    reco::BeamSpot::Point apoint(spotDB->x(), spotDB->y(), spotDB->z());

    reco::BeamSpot::CovarianceMatrix matrix;
    for (int i = 0; i < reco::BeamSpot::dimension; ++i) {
      for (int j = 0; j < reco::BeamSpot::dimension; ++j) {
        matrix(i, j) = spotDB->covariance(i, j);
      }
    }

    // this assume beam width same in x and y
    aSpot = reco::BeamSpot(apoint, spotDB->sigmaZ(), spotDB->dxdz(), spotDB->dydz(), spotDB->beamWidthX(), matrix);
    aSpot.setBeamWidthY(spotDB->beamWidthY());
    aSpot.setEmittanceX(spotDB->emittanceX());
    aSpot.setEmittanceY(spotDB->emittanceY());
    aSpot.setbetaStar(spotDB->betaStar());
    aSpot.setType(reco::BeamSpot::Tracker);

    GlobalError bse(aSpot.rotatedCovariance3D());
    if ((bse.cxx() <= 0.) || (bse.cyy() <= 0.) || (bse.czz() <= 0.)) {
      edm::LogError("UnusableBeamSpot") << "Beamspot from fallback to DB with invalid errors: " << aSpot.covariance();
    }
  }

  *result = aSpot;

  iEvent.put(std::move(result));
}

Member Data Documentation

beamToken_

const edm::ESGetToken<BeamSpotObjects, BeamSpotObjectsRcd> BeamSpotOnlineProducer::beamToken_

private

Definition at line 50 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

beamTransientRcdESWatcher_

edm::ESWatcher<BeamSpotTransientObjectsRcd> BeamSpotOnlineProducer::beamTransientRcdESWatcher_

private

Definition at line 54 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

beamTransientToken_

const edm::ESGetToken<BeamSpotObjects, BeamSpotTransientObjectsRcd> BeamSpotOnlineProducer::beamTransientToken_

private

Definition at line 51 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

changeFrame_

const bool BeamSpotOnlineProducer::changeFrame_

private

Definition at line 44 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

l1GtEvmReadoutRecordToken_

const edm::EDGetTokenT<L1GlobalTriggerEvmReadoutRecord> BeamSpotOnlineProducer::l1GtEvmReadoutRecordToken_

private

Definition at line 49 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

scalerToken_

const edm::EDGetTokenT<BeamSpotOnlineCollection> BeamSpotOnlineProducer::scalerToken_

private

Definition at line 48 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

theBeamShoutMode

const unsigned int BeamSpotOnlineProducer::theBeamShoutMode

private

Definition at line 56 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

theMaxR2

double BeamSpotOnlineProducer::theMaxR2

private

Definition at line 46 of file BeamSpotOnlineProducer.cc.

Referenced by BeamSpotOnlineProducer(), and produce().

theMaxZ

const double BeamSpotOnlineProducer::theMaxZ

private

Definition at line 45 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

theSetSigmaZ

const double BeamSpotOnlineProducer::theSetSigmaZ

private

Definition at line 45 of file BeamSpotOnlineProducer.cc.

Referenced by produce().

useTransientRecord_

const bool BeamSpotOnlineProducer::useTransientRecord_

private

Definition at line 47 of file BeamSpotOnlineProducer.cc.

Referenced by produce().