HcalHFStatusBitFromRecHits Class Reference

#include <HcalHFStatusBitFromRecHits.h>

Public Member Functions
double	bit ()
	HcalHFStatusBitFromRecHits ()
	HcalHFStatusBitFromRecHits (double shortR, double shortET, double shortE, double longR, double longET, double longE)
void	hfSetFlagFromRecHits (HFRecHitCollection &rec, HcalChannelQuality *myqual, const HcalSeverityLevelComputer *mySeverity)
double	long_energythreshold ()
double	long_ETthreshold ()
double	long_hflongshortratio ()
void	set_long_energythreshold (double x)
void	set_long_ETthreshold (double x)
void	set_long_hflongshortratio (double x)
void	set_short_energythreshold (double x)
void	set_short_ETthreshold (double x)
void	set_short_hflongshortratio (double x)
double	short_energythreshold ()
double	short_ETthreshold ()
double	short_hflongshortratio ()
	~HcalHFStatusBitFromRecHits ()

Private Attributes
double	long_HFlongshortratio_
double	long_thresholdEnergy_
double	long_thresholdET_
double	short_HFlongshortratio_
double	short_thresholdEnergy_
double	short_thresholdET_

Detailed Description

This class sets status bit in the status words for the revised CaloRecHit objets using comparisons between the rec hit energies of long and short fibers for a given HF (ieat, iphi)

Author

J. Temple – University of Maryland and E. Yazgan

Definition at line 18 of file HcalHFStatusBitFromRecHits.h.

Constructor & Destructor Documentation

HcalHFStatusBitFromRecHits() [1/2]

HcalHFStatusBitFromRecHits::HcalHFStatusBitFromRecHits

(

)

Full featured constructor for HB/HE and HO (HPD-based detectors)

Definition at line 9 of file HcalHFStatusBitFromRecHits.cc.

References long_HFlongshortratio_, long_thresholdEnergy_, long_thresholdET_, short_HFlongshortratio_, short_thresholdEnergy_, and short_thresholdET_.

                                                       {
  // use simple values in default constructor
  long_HFlongshortratio_ = 0.99;
  short_HFlongshortratio_ = 0.99;
  long_thresholdET_ = 0.5;  // default energy requirement
  short_thresholdET_ = 0.5;
  long_thresholdEnergy_ = 100;
  short_thresholdEnergy_ = 100;
}

HcalHFStatusBitFromRecHits() [2/2]

HcalHFStatusBitFromRecHits::HcalHFStatusBitFromRecHits	(	double	shortR,
		double	shortET,
		double	shortE,
		double	longR,
		double	longET,
		double	longE
	)

Definition at line 19 of file HcalHFStatusBitFromRecHits.cc.

References long_HFlongshortratio_, long_thresholdEnergy_, long_thresholdET_, short_HFlongshortratio_, short_thresholdEnergy_, and short_thresholdET_.

                                                                                             {
  long_HFlongshortratio_ = longR;
  short_HFlongshortratio_ = shortR;
  long_thresholdET_ = longET;
  short_thresholdET_ = shortET;
  long_thresholdEnergy_ = longE;
  short_thresholdEnergy_ = shortE;
}

~HcalHFStatusBitFromRecHits()

HcalHFStatusBitFromRecHits::~HcalHFStatusBitFromRecHits

(

)

Definition at line 29 of file HcalHFStatusBitFromRecHits.cc.

{}

Member Function Documentation

bit()

double HcalHFStatusBitFromRecHits::bit ( )

inline

Definition at line 40 of file HcalHFStatusBitFromRecHits.h.

References HcalCaloFlagLabels::HFLongShort.

{ return HcalCaloFlagLabels::HFLongShort; }

hfSetFlagFromRecHits()

void HcalHFStatusBitFromRecHits::hfSetFlagFromRecHits	(	HFRecHitCollection &	rec,
		HcalChannelQuality *	myqual,
		const HcalSeverityLevelComputer *	mySeverity
	)

Definition at line 31 of file HcalHFStatusBitFromRecHits.cc.

References funct::abs(), edm::SortedCollection< T, SORT >::begin(), hcalRecHitTable_cff::depth, HcalSeverityLevelComputer::dropChannel(), edm::SortedCollection< T, SORT >::end(), HLT_2024v13_cff::eta1, HLT_2024v13_cff::eta2, HcalTopology::etaRange(), EnergyCorrector::etas, HcalChannelStatus::getValue(), HcalCondObjectContainer< Item >::getValues(), HcalForward, HcalCaloFlagLabels::HFLongShort, hcalRecHitTable_cff::ieta, hcalRecHitTable_cff::iphi, long_HFlongshortratio_, long_thresholdEnergy_, long_thresholdET_, particleFlowDisplacedVertex_cfi::ratio, DetId::rawId(), short_HFlongshortratio_, short_thresholdEnergy_, short_thresholdET_, mps_update::status, and HcalCondObjectContainerBase::topo().

                                                                                                   {
  // Compares energies from long & short fibers
  int status;
  float en, en2;
  int ieta, iphi, depth;
  float ratio;  // ratio of (L-S)/(L+S) energy magnitudes
  double coshEta;

  // Is there a faster way to do this than a double loop?
  for (HFRecHitCollection::iterator iHF = rec.begin(); iHF != rec.end(); ++iHF) {
    // skip cells that have already been tagged -- shouldn't happen in current algorithm
    //if (iHF->flagField(HcalCaloFlagLabels::HFLongShort, HcalCaloFlagLabels::HFLongShort+1)) continue;

    ieta = iHF->id().ieta();  // int between 29-41
    // eta = average value between cell eta bounds
    std::pair<double, double> etas = myqual->topo()->etaRange(HcalForward, abs(ieta));
    double eta1 = etas.first;
    double eta2 = etas.second;
    coshEta = fabs(cosh(0.5 * (eta1 + eta2)));

    status = 0;  // status bit for rechit

    en2 = -999;  // dummy starting value for partner energy
    depth = iHF->id().depth();
    en = iHF->energy();  // energy of current rechit

    if (depth == 1)  // check long fiber
    {
      if (en < 1.2)
        continue;  // never flag long rechits < 1.2 GeV
      if (long_thresholdEnergy_ > 0. && en < long_thresholdEnergy_)
        continue;
      if (long_thresholdET_ > 0. && en < long_thresholdET_ * coshEta)
        continue;
    }

    else if (depth == 2)  // check short fiber
    {
      if (en < 1.8)
        continue;  // never flag short rechits < 1.8 GeV
      if (short_thresholdEnergy_ > 0. && en < short_thresholdEnergy_)
        continue;
      if (short_thresholdET_ > 0. && en < short_thresholdET_ * coshEta)
        continue;
    }

    iphi = iHF->id().iphi();

    // Check for cells whose partners have been excluded from the rechit collections
    // Such cells will not get flagged (since we can't make an L vs. S comparison)

    HcalDetId partner(HcalForward, ieta, iphi, 3 - depth);  // if depth=1, 3-depth =2, and vice versa
    DetId detpartner = DetId(partner);
    const HcalChannelStatus* partnerstatus = myqual->getValues(detpartner.rawId());
    if (mySeverity->dropChannel(partnerstatus->getValue()))
      continue;  // partner was dropped; don't set flag

    // inner loop will find 'partner' channel (same ieta, iphi, different depth)
    for (HFRecHitCollection::iterator iHF2 = rec.begin(); iHF2 != rec.end(); ++iHF2) {
      if (iHF2->id().ieta() != ieta)
        continue;  // require ieta match
      if (iHF2->id().iphi() != iphi)
        continue;  // require iphi match
      if (iHF2->id().depth() == depth)
        continue;  // require short/long combo

      en2 = iHF2->energy();

      /* 
         We used to use absolute values of energies for ratios, but I don't think we want to do this any more.
         For example, for a threshold of 0.995, if en=50 and en2=0, the flag would be set.
         But if en=50 and en2<-0.125, the threshold would not be set if using the absolute values.
         I don't think we want to have a range of en2 below which the flag is not set.
         This does mean that we need to be careful not to set the en energy threshold too low,
         so as to not falsely flag fluctuations (en=2, en2=-0.01, for example), but we should never be setting our
         thresholds that low.
      */

      ratio = (en - en2) / (en + en2);

      if (depth == 1 && ratio > long_HFlongshortratio_)
        status = 1;
      else if (depth == 2 && ratio > short_HFlongshortratio_)
        status = 1;
      break;  // once partner channel found, break out of loop
    }         // inner loop

    // Consider the case where only one depth present
    if (en2 ==
        -999)  // outer rechit has already passed energy, ET thresholds above; no partner cell means this looks like isolated energy in one channel -- flag it!
      status = 1;

    // flag rechit as potential PMT window hit
    if (status == 1)
      iHF->setFlagField(status, HcalCaloFlagLabels::HFLongShort, 1);
  }  // outer loop
  return;
}  // void HcalHFStatusBitFromRecHits::hfSetFlagFromRecHits(...)

long_energythreshold()

double HcalHFStatusBitFromRecHits::long_energythreshold ( )

inline

Definition at line 34 of file HcalHFStatusBitFromRecHits.h.

References long_thresholdEnergy_.

{ return long_thresholdEnergy_; }

long_ETthreshold()

double HcalHFStatusBitFromRecHits::long_ETthreshold ( )

inline

Definition at line 35 of file HcalHFStatusBitFromRecHits.h.

References long_thresholdET_.

{ return long_thresholdET_; }

long_hflongshortratio()

double HcalHFStatusBitFromRecHits::long_hflongshortratio ( )

inline

Definition at line 33 of file HcalHFStatusBitFromRecHits.h.

References long_HFlongshortratio_.

{ return long_HFlongshortratio_; }

set_long_energythreshold()

void HcalHFStatusBitFromRecHits::set_long_energythreshold ( double  x )

inline

Definition at line 47 of file HcalHFStatusBitFromRecHits.h.

References long_thresholdEnergy_, and x.

                                          {
    long_thresholdEnergy_ = x;
    return;
  }

set_long_ETthreshold()

void HcalHFStatusBitFromRecHits::set_long_ETthreshold ( double  x )

inline

Definition at line 51 of file HcalHFStatusBitFromRecHits.h.

References long_thresholdET_, and x.

                                      {
    long_thresholdET_ = x;
    return;
  }

set_long_hflongshortratio()

void HcalHFStatusBitFromRecHits::set_long_hflongshortratio ( double  x )

inline

Definition at line 43 of file HcalHFStatusBitFromRecHits.h.

References long_HFlongshortratio_, and x.

                                           {
    long_HFlongshortratio_ = x;
    return;
  }

set_short_energythreshold()

void HcalHFStatusBitFromRecHits::set_short_energythreshold ( double  x )

inline

Definition at line 59 of file HcalHFStatusBitFromRecHits.h.

References short_thresholdEnergy_, and x.

                                           {
    short_thresholdEnergy_ = x;
    return;
  }

set_short_ETthreshold()

void HcalHFStatusBitFromRecHits::set_short_ETthreshold ( double  x )

inline

Definition at line 63 of file HcalHFStatusBitFromRecHits.h.

References short_thresholdET_, and x.

                                       {
    short_thresholdET_ = x;
    return;
  }

set_short_hflongshortratio()

void HcalHFStatusBitFromRecHits::set_short_hflongshortratio ( double  x )

inline

Definition at line 55 of file HcalHFStatusBitFromRecHits.h.

References short_HFlongshortratio_, and x.

                                            {
    short_HFlongshortratio_ = x;
    return;
  }

short_energythreshold()

double HcalHFStatusBitFromRecHits::short_energythreshold ( )

inline

Definition at line 37 of file HcalHFStatusBitFromRecHits.h.

References short_thresholdEnergy_.

{ return short_thresholdEnergy_; }

short_ETthreshold()

double HcalHFStatusBitFromRecHits::short_ETthreshold ( )

inline

Definition at line 38 of file HcalHFStatusBitFromRecHits.h.

References short_thresholdET_.

{ return short_thresholdET_; }

short_hflongshortratio()

double HcalHFStatusBitFromRecHits::short_hflongshortratio ( )

inline

Definition at line 36 of file HcalHFStatusBitFromRecHits.h.

References short_HFlongshortratio_.

{ return short_HFlongshortratio_; }

Member Data Documentation

long_HFlongshortratio_

double HcalHFStatusBitFromRecHits::long_HFlongshortratio_

private

Definition at line 70 of file HcalHFStatusBitFromRecHits.h.

Referenced by HcalHFStatusBitFromRecHits(), hfSetFlagFromRecHits(), long_hflongshortratio(), and set_long_hflongshortratio().

long_thresholdEnergy_

double HcalHFStatusBitFromRecHits::long_thresholdEnergy_

private

Definition at line 72 of file HcalHFStatusBitFromRecHits.h.

Referenced by HcalHFStatusBitFromRecHits(), hfSetFlagFromRecHits(), long_energythreshold(), and set_long_energythreshold().

long_thresholdET_

double HcalHFStatusBitFromRecHits::long_thresholdET_

private

Definition at line 71 of file HcalHFStatusBitFromRecHits.h.

Referenced by HcalHFStatusBitFromRecHits(), hfSetFlagFromRecHits(), long_ETthreshold(), and set_long_ETthreshold().

short_HFlongshortratio_

double HcalHFStatusBitFromRecHits::short_HFlongshortratio_

private

Definition at line 73 of file HcalHFStatusBitFromRecHits.h.

Referenced by HcalHFStatusBitFromRecHits(), hfSetFlagFromRecHits(), set_short_hflongshortratio(), and short_hflongshortratio().

short_thresholdEnergy_

double HcalHFStatusBitFromRecHits::short_thresholdEnergy_

private

Definition at line 75 of file HcalHFStatusBitFromRecHits.h.

Referenced by HcalHFStatusBitFromRecHits(), hfSetFlagFromRecHits(), set_short_energythreshold(), and short_energythreshold().

short_thresholdET_

double HcalHFStatusBitFromRecHits::short_thresholdET_

private

Definition at line 74 of file HcalHFStatusBitFromRecHits.h.

Referenced by HcalHFStatusBitFromRecHits(), hfSetFlagFromRecHits(), set_short_ETthreshold(), and short_ETthreshold().