BeamSpotAnalyzer Class Reference

Inheritance diagram for BeamSpotAnalyzer:

Public Member Functions
	BeamSpotAnalyzer (const edm::ParameterSet &)
	~BeamSpotAnalyzer () override
Public Member Functions inherited from edm::one::EDAnalyzer< edm::one::WatchLuminosityBlocks >
	EDAnalyzer ()=default
	EDAnalyzer (const EDAnalyzer &)=delete
SerialTaskQueue *	globalLuminosityBlocksQueue () final
SerialTaskQueue *	globalRunsQueue () final
const EDAnalyzer &	operator= (const EDAnalyzer &)=delete
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsInputProcessBlocks () const final
bool	wantsProcessBlocks () const final
Public Member Functions inherited from edm::one::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () const
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () const
	~EDAnalyzerBase () override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector < ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &)
Static Public Member Functions inherited from edm::one::EDAnalyzerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override
void	beginLuminosityBlock (const edm::LuminosityBlock &lumiSeg, const edm::EventSetup &context) override
void	endJob () override
void	endLuminosityBlock (const edm::LuminosityBlock &lumiSeg, const edm::EventSetup &c) override

Private Attributes
int	beginLumiOfBSFit_
int	countLumi_
int	endLumiOfBSFit_
int	fitNLumi_
int	ftmprun
int	ftmprun0
int	ftotalevents
int	org_resetFitNLumi_
int	previousLumi_
int	previousRun_
std::time_t	refBStime [2]
int	resetFitNLumi_
bool	runallfitters_
bool	runbeamwidthfit_
BeamFitter *	theBeamFitter
bool	write2DB_

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
void	resetItemsToGetFrom (BranchType iType)

Detailed Description

---

class: BeamSpotAnalyzer.cc package: RecoVertex/BeamSpotProducer

author: Francisco Yumiceva, Fermilab (yumic.nosp@m.eva@.nosp@m.fnal..nosp@m.gov) Geng-Yuan Jeng, UC Riverside (Geng-.nosp@m.Yuan.nosp@m..Jeng.nosp@m.@cer.nosp@m.n.ch)

---

Definition at line 27 of file BeamSpotAnalyzer.cc.

Constructor & Destructor Documentation

BeamSpotAnalyzer::BeamSpotAnalyzer ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 58 of file BeamSpotAnalyzer.cc.

References AlcaBeamMonitor_cfi::BeamFitter, beginLumiOfBSFit_, edm::EDConsumerBase::consumesCollector(), countLumi_, endLumiOfBSFit_, fitNLumi_, ftmprun, ftmprun0, ftotalevents, edm::ParameterSet::getParameter(), org_resetFitNLumi_, previousLumi_, previousRun_, BeamFitter::resetCutFlow(), resetFitNLumi_, BeamFitter::resetLSRange(), BeamFitter::resetPVFitter(), BeamFitter::resetRefTime(), BeamFitter::resetTrkVector(), runallfitters_, runbeamwidthfit_, theBeamFitter, and write2DB_.

                                                                 {
  // get parameter
  write2DB_ = iConfig.getParameter<edm::ParameterSet>("BSAnalyzerParameters").getParameter<bool>("WriteToDB");
  runallfitters_ = iConfig.getParameter<edm::ParameterSet>("BSAnalyzerParameters").getParameter<bool>("RunAllFitters");
  fitNLumi_ =
      iConfig.getParameter<edm::ParameterSet>("BSAnalyzerParameters").getUntrackedParameter<int>("fitEveryNLumi", -1);
  resetFitNLumi_ =
      iConfig.getParameter<edm::ParameterSet>("BSAnalyzerParameters").getUntrackedParameter<int>("resetEveryNLumi", -1);
  runbeamwidthfit_ =
      iConfig.getParameter<edm::ParameterSet>("BSAnalyzerParameters").getParameter<bool>("RunBeamWidthFit");

  theBeamFitter = new BeamFitter(iConfig, consumesCollector());
  theBeamFitter->resetTrkVector();
  theBeamFitter->resetLSRange();
  theBeamFitter->resetCutFlow();
  theBeamFitter->resetRefTime();
  theBeamFitter->resetPVFitter();

  ftotalevents = 0;
  ftmprun0 = ftmprun = -1;
  countLumi_ = 0;
  beginLumiOfBSFit_ = endLumiOfBSFit_ = -1;
  previousLumi_ = previousRun_ = 0;
  org_resetFitNLumi_ = resetFitNLumi_;
}

BeamSpotAnalyzer::~BeamSpotAnalyzer ( )

override

Definition at line 84 of file BeamSpotAnalyzer.cc.

References theBeamFitter.

{ delete theBeamFitter; }

Member Function Documentation

void BeamSpotAnalyzer::analyze ( const edm::Event &  iEvent, const edm::EventSetup &  iSetup  )

overrideprivatevirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 86 of file BeamSpotAnalyzer.cc.

References ftmprun, ftotalevents, edm::EventBase::id(), BeamFitter::readEvent(), edm::EventID::run(), and theBeamFitter.

                                                                                  {
  ftotalevents++;
  theBeamFitter->readEvent(iEvent);
  ftmprun = iEvent.id().run();
}

void BeamSpotAnalyzer::beginLuminosityBlock ( const edm::LuminosityBlock &  lumiSeg, const edm::EventSetup &  context  )

overrideprivate

Definition at line 93 of file BeamSpotAnalyzer.cc.

References beginLumiOfBSFit_, edm::LuminosityBlockBase::beginTime(), countLumi_, ftmprun, ftmprun0, edm::LuminosityBlockBase::luminosityBlock(), previousLumi_, previousRun_, refBStime, resetFitNLumi_, edm::LuminosityBlockBase::run(), and edm::Timestamp::value().

                                                                                                           {
  const edm::TimeValue_t fbegintimestamp = lumiSeg.beginTime().value();
  const std::time_t ftmptime = fbegintimestamp >> 32;

  if (countLumi_ == 0 || (resetFitNLumi_ > 0 && countLumi_ % resetFitNLumi_ == 0)) {
    ftmprun0 = lumiSeg.run();
    ftmprun = ftmprun0;
    beginLumiOfBSFit_ = lumiSeg.luminosityBlock();
    refBStime[0] = ftmptime;
  }

  countLumi_++;
  if (ftmprun == previousRun_) {
    if ((previousLumi_ + 1) != int(lumiSeg.luminosityBlock()))
      edm::LogWarning("BeamSpotAnalyzer") << "LUMI SECTIONS ARE NOT SORTED!";
  }
}

void BeamSpotAnalyzer::endJob ( void  )

overrideprivatevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 175 of file BeamSpotAnalyzer.cc.

References countLumi_, fitNLumi_, ftmprun, ftmprun0, ftotalevents, BeamFitter::getBeamSpot(), BeamFitter::getBeamWidth(), BeamFitter::getFitLSRange(), resetFitNLumi_, BeamFitter::runAllFitter(), runallfitters_, runbeamwidthfit_, BeamFitter::runBeamWidthFitter(), BeamFitter::runPVandTrkFitter(), theBeamFitter, BeamFitter::write2DB(), and write2DB_.

                              {
  edm::LogPrint("BeamSpotAnalyzer") << "\n-------------------------------------\n";
  edm::LogPrint("BeamSpotAnalyzer") << "\n Total number of events processed: " << ftotalevents;
  edm::LogPrint("BeamSpotAnalyzer") << "\n-------------------------------------\n\n";

  if (fitNLumi_ == -1 && resetFitNLumi_ == -1) {
    if (theBeamFitter->runPVandTrkFitter()) {
      reco::BeamSpot beam_default = theBeamFitter->getBeamSpot();
      std::pair<int, int> LSRange = theBeamFitter->getFitLSRange();

      edm::LogPrint("BeamSpotAnalyzer") << "\n RESULTS OF DEFAULT FIT:";
      edm::LogPrint("BeamSpotAnalyzer") << " for runs: " << ftmprun0 << " - " << ftmprun;
      edm::LogPrint("BeamSpotAnalyzer") << " for lumi blocks : " << LSRange.first << " - " << LSRange.second;
      edm::LogPrint("BeamSpotAnalyzer") << " lumi counter # " << countLumi_;
      edm::LogPrint("BeamSpotAnalyzer") << beam_default;

      if (write2DB_) {
        edm::LogPrint("BeamSpotAnalyzer") << "\n-------------------------------------\n\n";
        edm::LogPrint("BeamSpotAnalyzer") << " write results to DB...";
        theBeamFitter->write2DB();
      }

      if (runallfitters_) {
        theBeamFitter->runAllFitter();
      }
    }
    if ((runbeamwidthfit_)) {
      theBeamFitter->runBeamWidthFitter();
      reco::BeamSpot beam_width = theBeamFitter->getBeamWidth();
      edm::LogPrint("BeamSpotAnalyzer") << beam_width;
    } else {
      edm::LogPrint("BeamSpotAnalyzer") << "[BeamSpotAnalyzer] beamfit fails !!!";
    }
  }

  edm::LogPrint("BeamSpotAnalyzer") << "[BeamSpotAnalyzer] endJob done \n";
}

void BeamSpotAnalyzer::endLuminosityBlock ( const edm::LuminosityBlock &  lumiSeg, const edm::EventSetup &  c  )

overrideprivate

Definition at line 112 of file BeamSpotAnalyzer.cc.

References beginLumiOfBSFit_, cms::cuda::bs, countLumi_, endLumiOfBSFit_, edm::LuminosityBlockBase::endTime(), reco::BeamSpot::Fake, fitNLumi_, ftmprun, ftmprun0, BeamFitter::getBeamSpot(), BeamFitter::getBSvector(), BeamFitter::getFitLSRange(), BeamFitter::getNPVs(), BeamFitter::getNTracks(), edm::LuminosityBlockBase::luminosityBlock(), org_resetFitNLumi_, previousLumi_, refBStime, BeamFitter::resetCutFlow(), resetFitNLumi_, BeamFitter::resetLSRange(), BeamFitter::resetPVFitter(), BeamFitter::resetRefTime(), BeamFitter::resetTrkVector(), BeamFitter::runPVandTrkFitter(), BeamFitter::setFitLSRange(), BeamFitter::setRefTime(), BeamFitter::setRun(), reco::BeamSpot::setType(), theBeamFitter, and edm::Timestamp::value().

                                                                                                        {
  edm::LogPrint("BeamSpotAnalyzer") << "for lumis " << beginLumiOfBSFit_ << " - " << endLumiOfBSFit_ << std::endl
                                    << "number of selected tracks = " << theBeamFitter->getNTracks();
  edm::LogPrint("BeamSpotAnalyzer") << "number of selected PVs = " << theBeamFitter->getNPVs();
  //edm::LogPrint("BeamSpotAnalyzer") << "number of selected PVs per bx: " << theBeamFitter->getNPVsperBX() std::endl;

  const edm::TimeValue_t fendtimestamp = lumiSeg.endTime().value();
  const std::time_t fendtime = fendtimestamp >> 32;
  refBStime[1] = fendtime;

  endLumiOfBSFit_ = lumiSeg.luminosityBlock();
  previousLumi_ = endLumiOfBSFit_;

  if (fitNLumi_ == -1 && resetFitNLumi_ == -1)
    return;

  if (fitNLumi_ > 0 && countLumi_ % fitNLumi_ != 0)
    return;

  theBeamFitter->setFitLSRange(beginLumiOfBSFit_, endLumiOfBSFit_);
  theBeamFitter->setRefTime(refBStime[0], refBStime[1]);
  theBeamFitter->setRun(ftmprun0);

  std::pair<int, int> LSRange = theBeamFitter->getFitLSRange();

  if (theBeamFitter->runPVandTrkFitter()) {
    reco::BeamSpot bs = theBeamFitter->getBeamSpot();
    edm::LogPrint("BeamSpotAnalyzer") << "\n RESULTS OF DEFAULT FIT ";
    edm::LogPrint("BeamSpotAnalyzer") << " for runs: " << ftmprun0 << " - " << ftmprun;
    edm::LogPrint("BeamSpotAnalyzer") << " for lumi blocks : " << LSRange.first << " - " << LSRange.second;
    edm::LogPrint("BeamSpotAnalyzer") << " lumi counter # " << countLumi_;
    edm::LogPrint("BeamSpotAnalyzer") << bs;
    edm::LogPrint("BeamSpotAnalyzer") << "[BeamFitter] fit done. \n";
  } else {  // Fill in empty beam spot if beamfit fails
    reco::BeamSpot bs;
    bs.setType(reco::BeamSpot::Fake);
    edm::LogPrint("BeamSpotAnalyzer") << "\n Empty Beam spot fit";
    edm::LogPrint("BeamSpotAnalyzer") << " for runs: " << ftmprun0 << " - " << ftmprun;
    edm::LogPrint("BeamSpotAnalyzer") << " for lumi blocks : " << LSRange.first << " - " << LSRange.second;
    edm::LogPrint("BeamSpotAnalyzer") << " lumi counter # " << countLumi_;
    edm::LogPrint("BeamSpotAnalyzer") << bs;
    edm::LogPrint("BeamSpotAnalyzer") << "[BeamFitter] fit failed \n";
    // accumulate more events
    // disable this for the moment
    //resetFitNLumi_ += 1;
    //edm::LogPrint("BeamSpotAnalyzer") << "reset fitNLumi " << resetFitNLumi_ ;
  }

  if (resetFitNLumi_ > 0 && countLumi_ % resetFitNLumi_ == 0) {
    std::vector<BSTrkParameters> theBSvector = theBeamFitter->getBSvector();
    edm::LogPrint("BeamSpotAnalyzer") << "Total number of tracks accumulated = " << theBSvector.size();
    edm::LogPrint("BeamSpotAnalyzer") << "Reset track collection for beam fit";
    theBeamFitter->resetTrkVector();
    theBeamFitter->resetLSRange();
    theBeamFitter->resetCutFlow();
    theBeamFitter->resetRefTime();
    theBeamFitter->resetPVFitter();
    countLumi_ = 0;
    // reset counter to orginal
    resetFitNLumi_ = org_resetFitNLumi_;
  }
}

void BeamSpotAnalyzer::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 213 of file BeamSpotAnalyzer.cc.

References edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addUntracked(), edm::ConfigurationDescriptions::addWithDefaultLabel(), submitPVResolutionJobs::desc, BeamFitter::fillDescription(), PVFitter::fillDescription(), and edm::ParameterSetDescription::setComment().

                                                                                  {
  edm::ParameterSetDescription desc;
  desc.setComment("Analyzer of BeamSpot Objects");

  edm::ParameterSetDescription bsAnalyzerParamsDesc;
  bsAnalyzerParamsDesc.add("WriteToDB", false);
  bsAnalyzerParamsDesc.add("RunAllFitters", false);
  bsAnalyzerParamsDesc.addUntracked("fitEveryNLumi", -1);
  bsAnalyzerParamsDesc.addUntracked("resetEveryNLumi", -1);
  bsAnalyzerParamsDesc.add("RunBeamWidthFit", false);
  desc.add<edm::ParameterSetDescription>("BSAnalyzerParameters", bsAnalyzerParamsDesc);

  BeamFitter::fillDescription(desc);
  PVFitter::fillDescription(desc);

  descriptions.addWithDefaultLabel(desc);
}

Member Data Documentation

int BeamSpotAnalyzer::beginLumiOfBSFit_

private

Definition at line 47 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), beginLuminosityBlock(), and endLuminosityBlock().

int BeamSpotAnalyzer::countLumi_

private

Definition at line 42 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), beginLuminosityBlock(), endJob(), and endLuminosityBlock().

int BeamSpotAnalyzer::endLumiOfBSFit_

private

Definition at line 48 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), and endLuminosityBlock().

int BeamSpotAnalyzer::fitNLumi_

private

Definition at line 40 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), endJob(), and endLuminosityBlock().

int BeamSpotAnalyzer::ftmprun

private

Definition at line 46 of file BeamSpotAnalyzer.cc.

Referenced by analyze(), BeamSpotAnalyzer(), beginLuminosityBlock(), endJob(), and endLuminosityBlock().

int BeamSpotAnalyzer::ftmprun0

private

Definition at line 46 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), beginLuminosityBlock(), endJob(), and endLuminosityBlock().

int BeamSpotAnalyzer::ftotalevents

private

Definition at line 39 of file BeamSpotAnalyzer.cc.

Referenced by analyze(), BeamSpotAnalyzer(), and endJob().

int BeamSpotAnalyzer::org_resetFitNLumi_

private

Definition at line 43 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), and endLuminosityBlock().

int BeamSpotAnalyzer::previousLumi_

private

Definition at line 44 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), beginLuminosityBlock(), and endLuminosityBlock().

int BeamSpotAnalyzer::previousRun_

private

Definition at line 45 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), and beginLuminosityBlock().

std::time_t BeamSpotAnalyzer::refBStime[2]

private

Definition at line 49 of file BeamSpotAnalyzer.cc.

Referenced by beginLuminosityBlock(), and endLuminosityBlock().

int BeamSpotAnalyzer::resetFitNLumi_

private

Definition at line 41 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), beginLuminosityBlock(), endJob(), and endLuminosityBlock().

bool BeamSpotAnalyzer::runallfitters_

private

Definition at line 53 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), and endJob().

bool BeamSpotAnalyzer::runbeamwidthfit_

private

Definition at line 52 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), and endJob().

BeamFitter* BeamSpotAnalyzer::theBeamFitter

private

Definition at line 55 of file BeamSpotAnalyzer.cc.

Referenced by analyze(), BeamSpotAnalyzer(), endJob(), endLuminosityBlock(), and ~BeamSpotAnalyzer().

bool BeamSpotAnalyzer::write2DB_

private

Definition at line 51 of file BeamSpotAnalyzer.cc.

Referenced by BeamSpotAnalyzer(), and endJob().