HFPreReconstructor Class Reference

#include <RecoLocalCalo/HcalRecProducers/src/HFPreReconstructor.cc>

Inheritance diagram for HFPreReconstructor:

Public Member Functions
	HFPreReconstructor (const edm::ParameterSet &)
	~HFPreReconstructor () override
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 &descriptions)

Private Types
typedef std::pair< HcalDetId, int >	PmtAnodeId
typedef std::pair< PmtAnodeId, const HFQIE10Info * >	QIE10InfoWithId

Private Member Functions
void	beginRun (const edm::Run &, const edm::EventSetup &) override
void	fillInfos (const edm::Event &e, const edm::EventSetup &eventSetup)
void	produce (edm::Event &, const edm::EventSetup &) override
unsigned	sortDataByPmt ()

Private Attributes
bool	dropZSmarkedPassed_
int	forceSOI_
edm::ESGetToken< HcalTopology, HcalRecNumberingRecord >	htopoToken_
edm::InputTag	inputLabel_
edm::ESGetToken< HcalChannelPropertiesVec, HcalChannelPropertiesRecord >	propertiesToken_
std::vector< HFQIE10Info >	qie10Infos_
HFPreRecAlgo	reco_
int	soiShift_
std::vector< QIE10InfoWithId >	sortedQIE10Infos_
edm::EDGetTokenT< QIE10DigiCollection >	tok_hfQIE10_
bool	tsFromDB_

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

Description: Phase 1 HF reco with QIE 10 and split-anode readout

Implementation: [Notes on implementation]

Definition at line 52 of file HFPreReconstructor.cc.

Member Typedef Documentation

PmtAnodeId

typedef std::pair<HcalDetId, int> HFPreReconstructor::PmtAnodeId

private

Definition at line 60 of file HFPreReconstructor.cc.

QIE10InfoWithId

typedef std::pair<PmtAnodeId, const HFQIE10Info*> HFPreReconstructor::QIE10InfoWithId

private

Definition at line 61 of file HFPreReconstructor.cc.

Constructor & Destructor Documentation

HFPreReconstructor()

HFPreReconstructor::HFPreReconstructor ( const edm::ParameterSet &  conf )

explicit

Definition at line 93 of file HFPreReconstructor.cc.

References htopoToken_, inputLabel_, propertiesToken_, and tok_hfQIE10_.

    : inputLabel_(conf.getParameter<edm::InputTag>("digiLabel")),
      forceSOI_(conf.getParameter<int>("forceSOI")),
      soiShift_(conf.getParameter<int>("soiShift")),
      dropZSmarkedPassed_(conf.getParameter<bool>("dropZSmarkedPassed")),
      tsFromDB_(conf.getParameter<bool>("tsFromDB")),
      reco_(conf.getParameter<bool>("sumAllTimeSlices")) {
  // Describe consumed data
  tok_hfQIE10_ = consumes<QIE10DigiCollection>(inputLabel_);

  // Register the product
  produces<HFPreRecHitCollection>();

  // ES tokens
  htopoToken_ = esConsumes<HcalTopology, HcalRecNumberingRecord>();
  propertiesToken_ = esConsumes<HcalChannelPropertiesVec, HcalChannelPropertiesRecord>();
}

~HFPreReconstructor()

HFPreReconstructor::~HFPreReconstructor ( )

override

Definition at line 111 of file HFPreReconstructor.cc.

                                        {
  // do anything here that needs to be done at destruction time
  // (e.g. close files, deallocate resources etc.)
}

Member Function Documentation

beginRun()

void HFPreReconstructor::beginRun ( const edm::Run &  r, const edm::EventSetup &  es  )

overrideprivate

Definition at line 205 of file HFPreReconstructor.cc.

{}

fillDescriptions()

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

static

Definition at line 268 of file HFPreReconstructor.cc.

References edm::ConfigurationDescriptions::addDefault(), and submitPVResolutionJobs::desc.

                                                                                    {
  edm::ParameterSetDescription desc;

  desc.add<edm::InputTag>("digiLabel");
  desc.add<int>("forceSOI", -1);
  desc.add<int>("soiShift", 0);
  desc.add<bool>("dropZSmarkedPassed");
  desc.add<bool>("tsFromDB");
  desc.add<bool>("sumAllTimeSlices");

  descriptions.addDefault(desc);
}

fillInfos()

void HFPreReconstructor::fillInfos ( const edm::Event &  e, const edm::EventSetup &  eventSetup  )

private

Definition at line 147 of file HFPreReconstructor.cc.

References edm::DataFrameContainer::begin(), HcalChannelProperties::channelCoder, HcalTopology::detId2denseId(), dropZSmarkedPassed_, MillePedeFileConverter_cfg::e, edm::DataFrameContainer::end(), options_cfi::eventSetup, HcalRecoParam::firstSample(), forceSOI_, amptDefault_cfi::frame, HcalForward, htopoToken_, info(), HcalChannelProperties::paramTs, propertiesToken_, qie10Infos_, reco_, HFPreRecAlgo::reconstruct(), HcalChannelProperties::shape, edm::DataFrameContainer::size(), soiShift_, tok_hfQIE10_, and tsFromDB_.

Referenced by produce().

                                                                                     {
  using namespace edm;

  // Clear the collection we want to fill in this method
  qie10Infos_.clear();

  // Get the calibrations
  const HcalTopology& htopo = eventSetup.getData(htopoToken_);
  const HcalChannelPropertiesVec& prop = eventSetup.getData(propertiesToken_);

  // Get the input collection
  Handle<QIE10DigiCollection> digi;
  e.getByToken(tok_hfQIE10_, digi);

  const unsigned inputSize = digi->size();
  if (inputSize) {
    // Process the digis and fill out the HFQIE10Info vector
    qie10Infos_.reserve(inputSize);

    for (QIE10DigiCollection::const_iterator it = digi->begin(); it != digi->end(); ++it) {
      const QIE10DataFrame& frame(*it);
      const HcalDetId cell(frame.id());

      // Protection against calibration channels which are not
      // in the database but can still come in the QIE10DataFrame
      // in the laser calibs, etc.
      if (cell.subdet() != HcalSubdetector::HcalForward)
        continue;

      // Check zero suppression
      if (dropZSmarkedPassed_)
        if (frame.zsMarkAndPass())
          continue;

      // Look up the channel properties. This lookup is O(1).
      const HcalChannelProperties& properties(prop.at(htopo.detId2denseId(cell)));

      // ADC decoding tool
      const HcalCoderDb coder(*properties.channelCoder, *properties.shape);

      int tsToUse = forceSOI_;
      if (tsToUse < 0) {
        if (tsFromDB_) {
          tsToUse = properties.paramTs->firstSample();
        } else {
          // Get the "sample of interest" from the data frame itself
          tsToUse = frame.presamples();
        }
      }

      // Reconstruct the charge, energy, etc
      const HFQIE10Info& info = reco_.reconstruct(frame, tsToUse + soiShift_, coder, properties);
      if (info.id().rawId())
        qie10Infos_.push_back(info);
    }
  }
}

produce()

void HFPreReconstructor::produce ( edm::Event &  e, const edm::EventSetup &  eventSetup  )

overrideprivate

Definition at line 208 of file HFPreReconstructor.cc.

References cms::cuda::assert(), MillePedeFileConverter_cfg::e, options_cfi::eventSetup, fillInfos(), first, mps_fire::i, eostools::move(), MillePedeFileConverter_cfg::out, edm::second(), sortDataByPmt(), and sortedQIE10Infos_.

                                                                             {
  // Process the input data
  fillInfos(e, eventSetup);

  // Create a new output collection
  std::unique_ptr<HFPreRecHitCollection> out(std::make_unique<HFPreRecHitCollection>());

  // Fill the output collection
  const unsigned pmtCount = sortDataByPmt();
  if (pmtCount) {
    out->reserve(pmtCount);
    const unsigned sz = sortedQIE10Infos_.size();
    HcalDetId previousBaseId(sortedQIE10Infos_[0].first.first);
    unsigned nFound = 1;
    for (unsigned i = 1; i <= sz; ++i) {
      bool appendData = i == sz;
      if (i < sz) {
        const HcalDetId baseId(sortedQIE10Infos_[i].first.first);
        if (baseId == previousBaseId)
          ++nFound;
        else {
          appendData = true;
          previousBaseId = baseId;
        }
      }

      if (appendData) {
        // If we have found more than two QIE10 with the same base id,
        // there is a bug somewhere in the dataframe. We can't do
        // anything useful about it here. Once we make sure that
        // everything works as expected, this assertion can be removed.
        assert(nFound <= 2);

        const HFQIE10Info* first = nullptr;
        const HFQIE10Info* second = sortedQIE10Infos_[i - 1].second;

        if (nFound >= 2)
          first = sortedQIE10Infos_[i - 2].second;
        else if (sortedQIE10Infos_[i - 1].first.second < 3) {
          // Only one QIE10 readout found for this PMT.
          // Arrange for depth 1 and 2 to be "first".
          first = second;
          second = nullptr;
        }

        out->push_back(HFPreRecHit(sortedQIE10Infos_[i - nFound].first.first, first, second));

        // Reset the QIE find count for this base id
        nFound = 1;
      }
    }

    assert(out->size() == pmtCount);
  }

  // Add the output collection to the event record
  e.put(std::move(out));
}

sortDataByPmt()

unsigned HFPreReconstructor::sortDataByPmt ( )

private

Definition at line 119 of file HFPreReconstructor.cc.

References LEDCalibrationChannels::depth, first, mps_fire::i, triggerObjects_cff::id, info(), qie10Infos_, jetUpdater_cfi::sort, and sortedQIE10Infos_.

Referenced by produce().

                                           {
  sortedQIE10Infos_.clear();
  unsigned pmtCount = 0;
  const unsigned sz = qie10Infos_.size();
  if (sz) {
    // Perform sorting
    sortedQIE10Infos_.reserve(sz);
    const HFQIE10Info* info = &qie10Infos_[0];
    for (unsigned i = 0; i < sz; ++i) {
      const HcalDetId id(info[i].id());
      sortedQIE10Infos_.push_back(QIE10InfoWithId(PmtAnodeId(id.baseDetId(), id.depth()), info + i));
    }
    std::sort(sortedQIE10Infos_.begin(), sortedQIE10Infos_.end());

    // Count the PMTs
    HcalDetId previousBaseId(sortedQIE10Infos_[0].first.first);
    pmtCount = 1;
    for (unsigned i = 1; i < sz; ++i) {
      const HcalDetId baseId(sortedQIE10Infos_[i].first.first);
      if (baseId != previousBaseId) {
        previousBaseId = baseId;
        ++pmtCount;
      }
    }
  }
  return pmtCount;
}

Member Data Documentation

dropZSmarkedPassed_

bool HFPreReconstructor::dropZSmarkedPassed_

private

Definition at line 70 of file HFPreReconstructor.cc.

Referenced by fillInfos().

forceSOI_

int HFPreReconstructor::forceSOI_

private

Definition at line 68 of file HFPreReconstructor.cc.

Referenced by fillInfos().

htopoToken_

edm::ESGetToken<HcalTopology, HcalRecNumberingRecord> HFPreReconstructor::htopoToken_

private

Definition at line 86 of file HFPreReconstructor.cc.

Referenced by fillInfos(), and HFPreReconstructor().

inputLabel_

edm::InputTag HFPreReconstructor::inputLabel_

private

Definition at line 67 of file HFPreReconstructor.cc.

Referenced by HFPreReconstructor().

propertiesToken_

edm::ESGetToken<HcalChannelPropertiesVec, HcalChannelPropertiesRecord> HFPreReconstructor::propertiesToken_

private

Definition at line 87 of file HFPreReconstructor.cc.

Referenced by fillInfos(), and HFPreReconstructor().

qie10Infos_

std::vector<HFQIE10Info> HFPreReconstructor::qie10Infos_

private

Definition at line 76 of file HFPreReconstructor.cc.

Referenced by fillInfos(), and sortDataByPmt().

reco_

HFPreRecAlgo HFPreReconstructor::reco_

private

Definition at line 74 of file HFPreReconstructor.cc.

Referenced by fillInfos().

soiShift_

int HFPreReconstructor::soiShift_

private

Definition at line 69 of file HFPreReconstructor.cc.

Referenced by fillInfos().

sortedQIE10Infos_

std::vector<QIE10InfoWithId> HFPreReconstructor::sortedQIE10Infos_

private

Definition at line 77 of file HFPreReconstructor.cc.

Referenced by produce(), and sortDataByPmt().

tok_hfQIE10_

edm::EDGetTokenT<QIE10DigiCollection> HFPreReconstructor::tok_hfQIE10_

private

Definition at line 75 of file HFPreReconstructor.cc.

Referenced by fillInfos(), and HFPreReconstructor().

tsFromDB_

bool HFPreReconstructor::tsFromDB_

private

Definition at line 71 of file HFPreReconstructor.cc.

Referenced by fillInfos().