HFPreRecHit.h

Go to the documentation of this file.

#ifndef DATAFORMATS_HCALRECHIT_HFPRERECHIT_H
#define DATAFORMATS_HCALRECHIT_HFPRERECHIT_H

#include <utility>

#include "DataFormats/HcalRecHit/interface/HFQIE10Info.h"

class HFPreRecHit {
public:
  typedef HcalDetId key_type;

  constexpr HFPreRecHit() : hasInfo_{false, false} {}

  // In the constructor below, either "first" or "second"
  // pointer can be nullptr
  constexpr HFPreRecHit(const HcalDetId& id, const HFQIE10Info* first, const HFQIE10Info* second)
      : id_(id), hasInfo_{false, false} {
    if (first) {
      hfQIE10Info_[0] = *first;
      hasInfo_[0] = true;
    }
    if (second) {
      hfQIE10Info_[1] = *second;
      hasInfo_[1] = true;
    }
  }

  constexpr HcalDetId id() const { return id_; }

  // Get a pointer to the QIE10 info. nullptr will be returned
  // if the info with the given index does not exist or if the
  // index is out of range.
  constexpr HFQIE10Info const* getHFQIE10Info(unsigned index) const {
    if (index < 2 && hasInfo_[index])
      return &hfQIE10Info_[index];
    else
      return nullptr;
  }

  // Quantities simply added from both anodes
  constexpr float charge() const {
    float q = 0.f;
    for (unsigned i = 0; i < 2; ++i)
      if (hasInfo_[i])
        q += hfQIE10Info_[i].charge();
    return q;
  }
  constexpr float energy() const {
    float e = 0.f;
    for (unsigned i = 0; i < 2; ++i)
      if (hasInfo_[i])
        e += hfQIE10Info_[i].energy();
    return e;
  }

  // The following function returns a pair.
  // The first element of the pair is the charge asymmetry,
  // if calculated. The second element of the pair indicates
  // whether the asymmetry is actually calculated. "true"
  // means yes, it is. The asymmetry is calculated if all
  // of the following conditions are satisfied:
  //
  //   1) The data is available for both PMT anodes.
  //   2) The sum of the charges is positive.
  //   3) The sum of the charges is at least "chargeThreshold".
  //
  // If the asymmetry is not calculated, the first element of
  // the pair is set to 0 and the second to "false".
  //
  std::pair<float, bool> chargeAsymmetry(float chargeThreshold) const;

  // Similar function for the energy asymmetry
  std::pair<float, bool> energyAsymmetry(float energyThreshold) const;

private:
  HcalDetId id_;

  HFQIE10Info hfQIE10Info_[2];
  bool hasInfo_[2];
};

#endif  // DATAFORMATS_HCALRECHIT_HFPRERECHIT_H