CMS 3D CMS Logo

HFPreReconstructor.cc
Go to the documentation of this file.
1 // -*- C++ -*-
2 //
3 // Package: RecoLocalCalo/HcalRecProducers
4 // Class: HFPreReconstructor
5 //
13 //
14 // Original Author: Igor Volobouev
15 // Created: Thu, 05 May 2016 00:17:51 GMT
16 //
17 //
18 
19 // system include files
20 #include <memory>
21 #include <utility>
22 #include <cassert>
23 
24 // user include files
30 
33 
36 
38 
40 
43 
47 
48 //
49 // class declaration
50 //
51 
53 public:
54  explicit HFPreReconstructor(const edm::ParameterSet&);
55  ~HFPreReconstructor() override;
56 
57  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
58 
59 private:
60  typedef std::pair<HcalDetId, int> PmtAnodeId;
61  typedef std::pair<PmtAnodeId, const HFQIE10Info*> QIE10InfoWithId;
62 
63  void beginRun(const edm::Run&, const edm::EventSetup&) override;
64  void produce(edm::Event&, const edm::EventSetup&) override;
65 
66  // Module configuration parameters
68  int forceSOI_;
69  int soiShift_;
71  bool tsFromDB_;
72 
73  // Other members
76  std::vector<HFQIE10Info> qie10Infos_;
77  std::vector<QIE10InfoWithId> sortedQIE10Infos_;
78 
79  // Fill qie10Infos_ from the event data
80  void fillInfos(const edm::Event& e, const edm::EventSetup& eventSetup);
81 
82  // Fill out sortedQIE10Infos_ from qie10Infos_ and return the PMT count
83  unsigned sortDataByPmt();
84 
85  // ES tokens
88 };
89 
90 //
91 // constructors and destructor
92 //
94  : inputLabel_(conf.getParameter<edm::InputTag>("digiLabel")),
95  forceSOI_(conf.getParameter<int>("forceSOI")),
96  soiShift_(conf.getParameter<int>("soiShift")),
97  dropZSmarkedPassed_(conf.getParameter<bool>("dropZSmarkedPassed")),
98  tsFromDB_(conf.getParameter<bool>("tsFromDB")),
99  reco_(conf.getParameter<bool>("sumAllTimeSlices")) {
100  // Describe consumed data
101  tok_hfQIE10_ = consumes<QIE10DigiCollection>(inputLabel_);
102 
103  // Register the product
104  produces<HFPreRecHitCollection>();
105 
106  // ES tokens
107  htopoToken_ = esConsumes<HcalTopology, HcalRecNumberingRecord>();
108  propertiesToken_ = esConsumes<HcalChannelPropertiesVec, HcalChannelPropertiesRecord>();
109 }
110 
112  // do anything here that needs to be done at destruction time
113  // (e.g. close files, deallocate resources etc.)
114 }
115 
116 //
117 // member functions
118 //
120  sortedQIE10Infos_.clear();
121  unsigned pmtCount = 0;
122  const unsigned sz = qie10Infos_.size();
123  if (sz) {
124  // Perform sorting
125  sortedQIE10Infos_.reserve(sz);
126  const HFQIE10Info* info = &qie10Infos_[0];
127  for (unsigned i = 0; i < sz; ++i) {
128  const HcalDetId id(info[i].id());
129  sortedQIE10Infos_.push_back(QIE10InfoWithId(PmtAnodeId(id.baseDetId(), id.depth()), info + i));
130  }
131  std::sort(sortedQIE10Infos_.begin(), sortedQIE10Infos_.end());
132 
133  // Count the PMTs
134  HcalDetId previousBaseId(sortedQIE10Infos_[0].first.first);
135  pmtCount = 1;
136  for (unsigned i = 1; i < sz; ++i) {
137  const HcalDetId baseId(sortedQIE10Infos_[i].first.first);
138  if (baseId != previousBaseId) {
139  previousBaseId = baseId;
140  ++pmtCount;
141  }
142  }
143  }
144  return pmtCount;
145 }
146 
148  using namespace edm;
149 
150  // Clear the collection we want to fill in this method
151  qie10Infos_.clear();
152 
153  // Get the calibrations
154  const HcalTopology& htopo = eventSetup.getData(htopoToken_);
155  const HcalChannelPropertiesVec& prop = eventSetup.getData(propertiesToken_);
156 
157  // Get the input collection
159  e.getByToken(tok_hfQIE10_, digi);
160 
161  const unsigned inputSize = digi->size();
162  if (inputSize) {
163  // Process the digis and fill out the HFQIE10Info vector
164  qie10Infos_.reserve(inputSize);
165 
166  for (QIE10DigiCollection::const_iterator it = digi->begin(); it != digi->end(); ++it) {
167  const QIE10DataFrame& frame(*it);
168  const HcalDetId cell(frame.id());
169 
170  // Protection against calibration channels which are not
171  // in the database but can still come in the QIE10DataFrame
172  // in the laser calibs, etc.
173  if (cell.subdet() != HcalSubdetector::HcalForward)
174  continue;
175 
176  // Check zero suppression
178  if (frame.zsMarkAndPass())
179  continue;
180 
181  // Look up the channel properties. This lookup is O(1).
182  const HcalChannelProperties& properties(prop.at(htopo.detId2denseId(cell)));
183 
184  // ADC decoding tool
185  const HcalCoderDb coder(*properties.channelCoder, *properties.shape);
186 
187  int tsToUse = forceSOI_;
188  if (tsToUse < 0) {
189  if (tsFromDB_) {
190  tsToUse = properties.paramTs->firstSample();
191  } else {
192  // Get the "sample of interest" from the data frame itself
193  tsToUse = frame.presamples();
194  }
195  }
196 
197  // Reconstruct the charge, energy, etc
198  const HFQIE10Info& info = reco_.reconstruct(frame, tsToUse + soiShift_, coder, properties);
199  if (info.id().rawId())
200  qie10Infos_.push_back(info);
201  }
202  }
203 }
204 
206 
207 // ------------ method called to produce the data ------------
209  // Process the input data
210  fillInfos(e, eventSetup);
211 
212  // Create a new output collection
213  std::unique_ptr<HFPreRecHitCollection> out(std::make_unique<HFPreRecHitCollection>());
214 
215  // Fill the output collection
216  const unsigned pmtCount = sortDataByPmt();
217  if (pmtCount) {
218  out->reserve(pmtCount);
219  const unsigned sz = sortedQIE10Infos_.size();
220  HcalDetId previousBaseId(sortedQIE10Infos_[0].first.first);
221  unsigned nFound = 1;
222  for (unsigned i = 1; i <= sz; ++i) {
223  bool appendData = i == sz;
224  if (i < sz) {
225  const HcalDetId baseId(sortedQIE10Infos_[i].first.first);
226  if (baseId == previousBaseId)
227  ++nFound;
228  else {
229  appendData = true;
230  previousBaseId = baseId;
231  }
232  }
233 
234  if (appendData) {
235  // If we have found more than two QIE10 with the same base id,
236  // there is a bug somewhere in the dataframe. We can't do
237  // anything useful about it here. Once we make sure that
238  // everything works as expected, this assertion can be removed.
239  assert(nFound <= 2);
240 
241  const HFQIE10Info* first = nullptr;
242  const HFQIE10Info* second = sortedQIE10Infos_[i - 1].second;
243 
244  if (nFound >= 2)
245  first = sortedQIE10Infos_[i - 2].second;
246  else if (sortedQIE10Infos_[i - 1].first.second < 3) {
247  // Only one QIE10 readout found for this PMT.
248  // Arrange for depth 1 and 2 to be "first".
249  first = second;
250  second = nullptr;
251  }
252 
253  out->push_back(HFPreRecHit(sortedQIE10Infos_[i - nFound].first.first, first, second));
254 
255  // Reset the QIE find count for this base id
256  nFound = 1;
257  }
258  }
259 
260  assert(out->size() == pmtCount);
261  }
262 
263  // Add the output collection to the event record
264  e.put(std::move(out));
265 }
266 
267 // ------------ method fills 'descriptions' with the allowed parameters for the module ------------
270 
271  desc.add<edm::InputTag>("digiLabel");
272  desc.add<int>("forceSOI", -1);
273  desc.add<int>("soiShift", 0);
274  desc.add<bool>("dropZSmarkedPassed");
275  desc.add<bool>("tsFromDB");
276  desc.add<bool>("sumAllTimeSlices");
277 
278  descriptions.addDefault(desc);
279 }
280 
281 //define this as a plug-in
HcalChannelProperties::channelCoder
const HcalQIECoder * channelCoder
Definition: HcalChannelProperties.h:50
HFPreReconstructor::tok_hfQIE10_
edm::EDGetTokenT< QIE10DigiCollection > tok_hfQIE10_
Definition: HFPreReconstructor.cc:75
HcalChannelProperties::shape
const HcalQIEShape * shape
Definition: HcalChannelProperties.h:51
HFPreRecAlgo::reconstruct
HFQIE10Info reconstruct(const QIE10DataFrame &digi, int tsToUse, const HcalCoder &coder, const HcalChannelProperties &prop) const
Definition: HFPreRecAlgo.cc:12
HcalChannelProperties.h
electrons_cff.bool
bool
Definition: electrons_cff.py:393
mps_fire.i
i
Definition: mps_fire.py:428
HFPreReconstructor::reco_
HFPreRecAlgo reco_
Definition: HFPreReconstructor.cc:74
edm::DataFrameContainer::const_iterator
boost::transform_iterator< IterHelp, boost::counting_iterator< int > > const_iterator
Definition: DataFrameContainer.h:61
HFQIE10Info
Definition: HFQIE10Info.h:15
edm::Run
Definition: Run.h:45
edm::EDGetTokenT
Definition: EDGetToken.h:33
edm
HLT enums.
Definition: AlignableModifier.h:19
HcalChannelProperties::paramTs
const HcalRecoParam * paramTs
Definition: HcalChannelProperties.h:49
HcalTopology
Definition: HcalTopology.h:26
HLT_FULL_cff.InputTag
InputTag
Definition: HLT_FULL_cff.py:85964
HFPreReconstructor::soiShift_
int soiShift_
Definition: HFPreReconstructor.cc:69
HFPreReconstructor::htopoToken_
edm::ESGetToken< HcalTopology, HcalRecNumberingRecord > htopoToken_
Definition: HFPreReconstructor.cc:86
edm::ParameterSetDescription
Definition: ParameterSetDescription.h:52
HFPreReconstructor::qie10Infos_
std::vector< HFQIE10Info > qie10Infos_
Definition: HFPreReconstructor.cc:76
cms::cuda::assert
assert(be >=bs)
HFPreReconstructor::HFPreReconstructor
HFPreReconstructor(const edm::ParameterSet &)
Definition: HFPreReconstructor.cc:93
EDProducer.h
edm::second
U second(std::pair< T, U > const &p)
Definition: ParameterSet.cc:222
HFPreReconstructor::produce
void produce(edm::Event &, const edm::EventSetup &) override
Definition: HFPreReconstructor.cc:208
info
static const TGPicture * info(bool iBackgroundIsBlack)
Definition: FWCollectionSummaryWidget.cc:153
HcalRecNumberingRecord.h
HcalChannelPropertiesVec
std::vector< HcalChannelProperties > HcalChannelPropertiesVec
Definition: HcalChannelProperties.h:57
HFPreReconstructor::beginRun
void beginRun(const edm::Run &, const edm::EventSetup &) override
Definition: HFPreReconstructor.cc:205
edm::Handle
Definition: AssociativeIterator.h:50
dqmdumpme.first
first
Definition: dqmdumpme.py:55
ESGetToken.h
HcalChannelPropertiesRecord.h
HcalCoderDb.h
HcalChannelProperties
Definition: HcalChannelProperties.h:18
HFPreReconstructor::fillDescriptions
static void fillDescriptions(edm::ConfigurationDescriptions &descriptions)
Definition: HFPreReconstructor.cc:268
HFPreRecAlgo
Definition: HFPreRecAlgo.h:10
MakerMacros.h
DEFINE_FWK_MODULE
#define DEFINE_FWK_MODULE(type)
Definition: MakerMacros.h:16
HFPreReconstructor
Definition: HFPreReconstructor.cc:52
HFPreReconstructor::fillInfos
void fillInfos(const edm::Event &e, const edm::EventSetup &eventSetup)
Definition: HFPreReconstructor.cc:147
HcalDigiCollections.h
HFPreReconstructor::QIE10InfoWithId
std::pair< PmtAnodeId, const HFQIE10Info * > QIE10InfoWithId
Definition: HFPreReconstructor.cc:61
HFPreReconstructor::sortedQIE10Infos_
std::vector< QIE10InfoWithId > sortedQIE10Infos_
Definition: HFPreReconstructor.cc:77
HcalTopology::detId2denseId
unsigned int detId2denseId(const DetId &id) const override
return a linear packed id
Definition: HcalTopology.cc:1518
LEDCalibrationChannels.depth
depth
Definition: LEDCalibrationChannels.py:65
edm::ConfigurationDescriptions
Definition: ConfigurationDescriptions.h:28
HFPreReconstructor::propertiesToken_
edm::ESGetToken< HcalChannelPropertiesVec, HcalChannelPropertiesRecord > propertiesToken_
Definition: HFPreReconstructor.cc:87
edm::ParameterSet
Definition: ParameterSet.h:47
Event.h
HFPreReconstructor::dropZSmarkedPassed_
bool dropZSmarkedPassed_
Definition: HFPreReconstructor.cc:70
HFPreReconstructor::inputLabel_
edm::InputTag inputLabel_
Definition: HFPreReconstructor.cc:67
HcalDetId
Definition: HcalDetId.h:12
createfilelist.int
int
Definition: createfilelist.py:10
HFPreReconstructor::~HFPreReconstructor
~HFPreReconstructor() override
Definition: HFPreReconstructor.cc:111
edm::DataFrameContainer::begin
const_iterator begin() const
The iterator returned can not safely be used across threads.
Definition: DataFrameContainer.h:149
edm::stream::EDProducer
Definition: EDProducer.h:38
HFPreReconstructor::tsFromDB_
bool tsFromDB_
Definition: HFPreReconstructor.cc:71
edm::EventSetup
Definition: EventSetup.h:57
HcalRecoParam.h
edm::ESGetToken< HcalTopology, HcalRecNumberingRecord >
edm::EventSetup::getData
bool getData(T &iHolder) const
Definition: EventSetup.h:120
alignCSCRings.r
r
Definition: alignCSCRings.py:93
HcalForward
Definition: HcalAssistant.h:36
HFPreReconstructor::forceSOI_
int forceSOI_
Definition: HFPreReconstructor.cc:68
HcalRecoParam::firstSample
constexpr unsigned int firstSample() const
Definition: HcalRecoParam.h:31
HcalTopology.h
submitPVResolutionJobs.desc
string desc
Definition: submitPVResolutionJobs.py:251
eostools.move
def move(src, dest)
Definition: eostools.py:511
QIE10DataFrame
Definition: QIE10DataFrame.h:11
Frameworkfwd.h
triggerObjects_cff.id
id
Definition: triggerObjects_cff.py:31
amptDefault_cfi.frame
frame
Definition: amptDefault_cfi.py:12
HcalRecHitCollections.h
HFPreReconstructor::PmtAnodeId
std::pair< HcalDetId, int > PmtAnodeId
Definition: HFPreReconstructor.cc:60
HcalCoderDb
Definition: HcalCoderDb.h:15
MillePedeFileConverter_cfg.out
out
Definition: MillePedeFileConverter_cfg.py:31
HFPreRecAlgo.h
ParameterSet.h
edm::Event
Definition: Event.h:73
HFPreReconstructor::sortDataByPmt
unsigned sortDataByPmt()
Definition: HFPreReconstructor.cc:119
edm::ConfigurationDescriptions::addDefault
void addDefault(ParameterSetDescription const &psetDescription)
Definition: ConfigurationDescriptions.cc:99
HFPreRecHit
Definition: HFPreRecHit.h:14
StreamID.h
edm::DataFrameContainer::end
const_iterator end() const
Definition: DataFrameContainer.h:152
edm::InputTag
Definition: InputTag.h:15
edm::DataFrameContainer::size
size_type size() const
Definition: DataFrameContainer.h:162
MillePedeFileConverter_cfg.e
e
Definition: MillePedeFileConverter_cfg.py:37