JetSampling.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef JETEVENT_JETSAMPLING_H
#define JETEVENT_JETSAMPLING_H
/* ****************************************************************************** 
 *    @file JetSampling.h
 *    @brief Definition of JetSampling class
 *   
 *    JetSampling is a simple data object that holds information used by different jet 
 * weighting schemes. It is difficult to loop over large number of jet objects, 
 * back navigate for calorimeter and other sub system information in one job in 
 * order to build the function that can be minimized to derieve jet weights. In 
 * order to solve that, JetSampling  object is created with the relevant 
 * information for a particular weighting scheme and saved as pool object. It 
 * can then be read back and looped over fairly quickly.  
 * 
 * The interface here is not absolute and duplicates the interfaces used by the 
 * three jet weighting schemes in ATLAS. Therefore there is redundant information 
 * here. It should be tailored to the need of a weighting scheme.
 *
 * Oct. 2006: Expand information for H1:
 * (1) Separate gap into eGap [TileGap1] and eScint [TileGap2,3]. Need
 * to change JetClassifier but not JetSamplingCalibAlg.
 *
 * Dic. 2008: 
 * (1) Finer longitudinal granularity for JetECS
 * (2) Remove members of JetSum, modify methods to calculate them from JetECS
 * (3) Add distance to 1st and 2nd Nearest-Truth-Jet
 * (4) Radial profiles from: Calo Cells and Tracks
 * (5) Adding Doxygen comments
 * 
 * @author A.Gupta
 * @author B.Salvachua
 *
 * ****************************************************************************** */
 
#include "CLHEP/Vector/LorentzVector.h"
 
#include <array>
 
class JetSampling 
{
 public:
  
  JetSampling();  
  virtual ~JetSampling(); 
  
  const CLHEP::HepLorentzVector& hlv_rec() const { return m_pr; }     
  const CLHEP::HepLorentzVector& hlv_pic() const { return m_pt; }     
  const CLHEP::HepLorentzVector& hlv_ntj() const { return m_pn; }     
  const CLHEP::HepLorentzVector& hlv_ref() const { return m_pd; }     
  
  const CLHEP::HepLorentzVector& hlv_h1() const { return m_h1; }      
  const CLHEP::HepLorentzVector& hlv_pisa() const { return m_pisa; }  
  const CLHEP::HepLorentzVector& hlv_samp() const { return m_samp; }  
  
  void set_hlv_rec( const CLHEP::HepLorentzVector& v ) { m_pr = v; } 
  void set_hlv_pic( const CLHEP::HepLorentzVector& v ) { m_pt = v; } 
  void set_hlv_ntj( const CLHEP::HepLorentzVector& v ) { m_pn = v; } 
  void set_hlv_ref( const CLHEP::HepLorentzVector& v ) { m_pd = v; } 
  
  void set_hlv_h1(   const CLHEP::HepLorentzVector& v ) { m_h1 = v; } 
  void set_hlv_pisa( const CLHEP::HepLorentzVector& v ) { m_pisa = v; } 
  void set_hlv_samp( const CLHEP::HepLorentzVector& v ) { m_samp = v; } 
 
  double dR1() { return m_dr1;} 
  double dR2() { return m_dr2;} 
  void set_dR1( double r ) {m_dr1 = r;} 
  void set_dR2( double r ) {m_dr2 = r;} 
  
  // Jet Layers : Used by sampling (or layer)  weighting scheme  //
  
  // Methods to access the values of the layers stored in JetSampling class
  double ejsPreSamplerB() const { return m_ejsPreSamplerB; } 
  double ejsPreSamplerE() const { return m_ejsPreSamplerE; } 
  double ejsEMB1() const { return m_ejsEMB1; } 
  double ejsEME1() const { return m_ejsEME1; } 
  double ejsEMB2() const { return m_ejsEMB2; } 
  double ejsEME2() const { return m_ejsEME2; } 
  double ejsEMB3() const { return m_ejsEMB3; } 
  double ejsEME3() const { return m_ejsEME3; } 
  double ejsTileBar0() const { return m_ejsTileBar0; } 
  double ejsTileExt0() const { return m_ejsTileExt0; } 
  double ejsTileBar1() const { return m_ejsTileBar1; } 
  double ejsTileExt1() const { return m_ejsTileExt1; } 
  double ejsTileBar2() const { return m_ejsTileBar2; } 
  double ejsTileExt2() const { return m_ejsTileExt2; } 
  double ejsHEC0() const { return m_ejsHEC0; } 
  double ejsHEC1() const { return m_ejsHEC1; } 
  double ejsHEC2() const { return m_ejsHEC2; } 
  double ejsHEC3() const { return m_ejsHEC3; } 
  double ejsTileGap1() const { return m_ejsTileGap1; } 
  double ejsTileGap2() const { return m_ejsTileGap2; } 
  double ejsTileGap3() const { return m_ejsTileGap3; } 
  double ejsFCAL0() const { return m_ejsFCAL0; } 
  double ejsFCAL1() const { return m_ejsFCAL1; } 
  double ejsFCAL2() const { return m_ejsFCAL2; } 
  
  // Two methods to cross-check the layer values, filled using layer variables content
  double jet_had_sum() { return m_ehad; } 
  double jet_em_sum() { return m_eem; }   
  
  // Methods to set the layer variables content and m_ehad and m_eem
  void set_ejsPreSamplerB(double ejs) { m_ejsPreSamplerB = ejs; m_tot += ejs;  m_eem += ejs; } 
  void set_ejsPreSamplerE(double ejs) { m_ejsPreSamplerE = ejs; m_tot += ejs;  m_eem += ejs; } 
  void set_ejsEMB1(double ejs) { m_ejsEMB1 = ejs; m_tot += ejs; m_eem += ejs; } 
  void set_ejsEME1(double ejs) { m_ejsEME1 = ejs; m_tot += ejs; m_eem += ejs; }
  void set_ejsEMB2(double ejs) { m_ejsEMB2 = ejs; m_tot += ejs; m_eem += ejs; }
  void set_ejsEME2(double ejs) { m_ejsEME2 = ejs; m_tot += ejs; m_eem += ejs; }
  void set_ejsEMB3(double ejs) { m_ejsEMB3 = ejs; m_tot += ejs; m_eem += ejs; }
  void set_ejsEME3(double ejs) { m_ejsEME3 = ejs; m_tot += ejs; m_eem += ejs; }
  void set_ejsTileBar0(double ejs) { m_ejsTileBar0 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileExt0(double ejs) { m_ejsTileExt0 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileBar1(double ejs) { m_ejsTileBar1 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileExt1(double ejs) { m_ejsTileExt1 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileBar2(double ejs) { m_ejsTileBar2 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileExt2(double ejs) { m_ejsTileExt2 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsHEC0(double ejs) { m_ejsHEC0 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsHEC1(double ejs) { m_ejsHEC1 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsHEC2(double ejs) { m_ejsHEC2 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsHEC3(double ejs) { m_ejsHEC3 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileGap1(double ejs) { m_ejsTileGap1 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileGap2(double ejs) { m_ejsTileGap2 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsTileGap3(double ejs) { m_ejsTileGap3 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsFCAL0(double ejs) { m_ejsFCAL0 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsFCAL1(double ejs) { m_ejsFCAL1 = ejs; m_tot += ejs; m_ehad += ejs; }
  void set_ejsFCAL2(double ejs) { m_ejsFCAL2 = ejs; m_tot += ejs; m_ehad += ejs; }
  
  // JetSums Interface : As used in H1-style weighting //
  
  // Methods to access the JetSums, the return values have been calculated using JetECS variables
  double eEMBCell(const int ireg) const;                
  double eEMBCell(const int ireg, const int ie) const;  
  double eEMECell(const int ireg) const;                
  double eEMECell(const int ireg, const int ie) const;  
  double eTileCell(const int ireg, const int ie) const; 
  double eHecCell(const int ireg, const int ie) const;  
  double eFCalCell(const int ireg, const int ie) const; 
  //
  //
  double eCryo() const { return m_eCryo; }   
  double eGap() const { return m_eGap; }     
  double eScint() const { return m_eScint; } 
  double eNull() const { return m_eNull; }
 
  // Set JetSum have been removed, not needed, substitue call to JetECS
  //
  void set_eCryo(double e) { m_eCryo = e; }   
  void set_eGap(double e) { m_eGap = e; }     
  void set_eScint(double e) { m_eScint = e; } 
  void set_eNull(double e) { m_eNull = e; }

  // JetECS Interface : As used in H1-style with finer granularity (H1-layer method)
 
  // Access functions
  double ePreSamBCell(const int ireg) const { return m_ePreSamBCell.at(ireg);} 
  double ePreSamECell(const int ireg) const { return m_ePreSamECell.at(ireg);} 
  //
  double eEMB1Cell(const int ireg) const { return m_eEMB1Cell.at(ireg); } 
  double eEME1Cell(const int ireg) const { return m_eEME1Cell.at(ireg); } 
  //
  double eEMB2Cell1(const int ireg) const { return m_eEMB2Cell1.at(ireg); } 
  double eEMB2Cell2(const int ireg) const { return m_eEMB2Cell2.at(ireg); } 
  // 
  double eEMB3Cell1(const int ireg) const { return m_eEMB3Cell1.at(ireg); } 
  double eEMB3Cell2(const int ireg) const { return m_eEMB3Cell2.at(ireg); } 
  //
  double eEME2Cell1(const int ireg) const { return m_eEME2Cell1.at(ireg); } 
  double eEME2Cell2(const int ireg) const { return m_eEME2Cell2.at(ireg); } 
  //
  double eEME3Cell1(const int ireg) const { return m_eEME3Cell1.at(ireg); } 
  double eEME3Cell2(const int ireg) const { return m_eEME3Cell2.at(ireg); } 
  //
  double eTileBar0Cell(const int ireg) const { return m_eTileBar0Cell.at(ireg); } 
  double eTileBar1Cell(const int ireg) const { return m_eTileBar1Cell.at(ireg); } 
  double eTileBar2Cell(const int ireg) const { return m_eTileBar2Cell.at(ireg); } 
  //
  double eTileExt0Cell(const int ireg) const { return m_eTileExt0Cell.at(ireg); } 
  double eTileExt1Cell(const int ireg) const { return m_eTileExt1Cell.at(ireg); } 
  double eTileExt2Cell(const int ireg) const { return m_eTileExt2Cell.at(ireg); } 
  //
  double eHec0Cell1(const int ireg) const { return m_eHec0Cell1.at(ireg); } 
  double eHec1Cell1(const int ireg) const { return m_eHec1Cell1.at(ireg); } 
  double eHec2Cell1(const int ireg) const { return m_eHec2Cell1.at(ireg); } 
  double eHec3Cell1(const int ireg) const { return m_eHec3Cell1.at(ireg); } 
  //
  double eHec0Cell2(const int ireg) const { return m_eHec0Cell2.at(ireg); } 
  double eHec1Cell2(const int ireg) const { return m_eHec1Cell2.at(ireg); } 
  double eHec2Cell2(const int ireg) const { return m_eHec2Cell2.at(ireg); } 
  double eHec3Cell2(const int ireg) const { return m_eHec3Cell2.at(ireg); } 
  //
  double eFCal0Cell(const int ireg) const {return m_eFCal0Cell.at(ireg); } 
  double eFCal1Cell(const int ireg) const {return m_eFCal1Cell.at(ireg); } 
  double eFCal2Cell(const int ireg) const {return m_eFCal2Cell.at(ireg); } 
 
  // Set functions
  void set_ePreSamBCell(const int ireg, double e) { m_ePreSamBCell.at(ireg) = e; }
  void set_ePreSamECell(const int ireg, double e) { m_ePreSamECell.at(ireg) = e; }
  // 
  void set_eEMB1Cell(const int ireg, double e) { m_eEMB1Cell.at(ireg) = e; }
  void set_eEME1Cell(const int ireg, double e) { m_eEME1Cell.at(ireg) = e; }
  //
  void set_eEMB2Cell1(const int ireg, double e) { m_eEMB2Cell1.at(ireg) = e; }
  void set_eEMB2Cell2(const int ireg, double e) { m_eEMB2Cell2.at(ireg) = e; }
  //
  void set_eEMB3Cell1(const int ireg, double e) { m_eEMB3Cell1.at(ireg) = e; }
  void set_eEMB3Cell2(const int ireg, double e) { m_eEMB3Cell2.at(ireg) = e; }
  //
  void set_eEME2Cell1(const int ireg, double e) { m_eEME2Cell1.at(ireg) = e; }
  void set_eEME2Cell2(const int ireg, double e) { m_eEME2Cell2.at(ireg) = e; }
  //
  void set_eEME3Cell1(const int ireg, double e) { m_eEME3Cell1.at(ireg) = e; }
  void set_eEME3Cell2(const int ireg, double e) { m_eEME3Cell2.at(ireg) = e; }
  //
  void set_eTileBar0Cell(const int ireg, double e) { m_eTileBar0Cell.at(ireg)=e; }
  void set_eTileBar1Cell(const int ireg, double e) { m_eTileBar1Cell.at(ireg)=e; }
  void set_eTileBar2Cell(const int ireg, double e) { m_eTileBar2Cell.at(ireg)=e; }
  void set_eTileExt0Cell(const int ireg, double e) { m_eTileExt0Cell.at(ireg)=e; }
  void set_eTileExt1Cell(const int ireg, double e) { m_eTileExt1Cell.at(ireg)=e; }
  void set_eTileExt2Cell(const int ireg, double e) { m_eTileExt2Cell.at(ireg)=e; }
  //
  void set_eHec0Cell1(const int ireg, double e) { m_eHec0Cell1.at(ireg) = e; }
  void set_eHec1Cell1(const int ireg, double e) { m_eHec1Cell1.at(ireg) = e; }
  void set_eHec2Cell1(const int ireg, double e) { m_eHec2Cell1.at(ireg) = e; }
  void set_eHec3Cell1(const int ireg, double e) { m_eHec3Cell1.at(ireg) = e; }
  //
  void set_eHec0Cell2(const int ireg, double e) { m_eHec0Cell2.at(ireg) = e; }
  void set_eHec1Cell2(const int ireg, double e) { m_eHec1Cell2.at(ireg) = e; }
  void set_eHec2Cell2(const int ireg, double e) { m_eHec2Cell2.at(ireg) = e; }
  void set_eHec3Cell2(const int ireg, double e) { m_eHec3Cell2.at(ireg) = e; }
  //
 
  void set_eFCal0Cell(const int ireg, double e) {m_eFCal0Cell.at(ireg) = e; }
  void set_eFCal1Cell(const int ireg, double e) {m_eFCal1Cell.at(ireg) = e; }
  void set_eFCal2Cell(const int ireg, double e) {m_eFCal2Cell.at(ireg) = e; }
 
  // Fill energy in raddi around a jet, 10 radii max. Using Calo Cells
  void set_erad(const int i, double e) {m_erad_cells.at(i) += e; } 
  double get_erad( int i ) { return m_erad_cells.at(i); } 
 
  // Fill eneryg in radii around a jet, 10 radii max. Using tracks 
  // FIXME: fill these values inside JetClassifier, now filled with zeros
  void set_erad_tracks(const int i, double e){m_erad_tracks.at(i) += e;} 
  double get_erad_tracks( int i) { return m_erad_tracks.at(i); } 
 
 private:
  friend class JetSamplingCnv_p1;
  friend class JetSamplingCnv_p2;
 
  void init(); //>! Initializes to zero all private members

  CLHEP::HepLorentzVector m_pr;

  CLHEP::HepLorentzVector m_pt;

  CLHEP::HepLorentzVector m_pn;

  CLHEP::HepLorentzVector m_pd;
 
  // Calibrated Jet kinematics.
  CLHEP::HepLorentzVector m_h1;  
  CLHEP::HepLorentzVector m_pisa;
  CLHEP::HepLorentzVector m_samp;
 
  double m_dr1; 
  double m_dr2; 
 
  // Jet sampling layer info
  double m_ejsPreSamplerB;
  double m_ejsPreSamplerE;
  double m_ejsEMB1;
  double m_ejsEME1;  
  double m_ejsEMB2;
  double m_ejsEME2;
  double m_ejsEMB3;
  double m_ejsEME3;
  double m_ejsTileBar0;
  double m_ejsTileExt0;
  double m_ejsTileBar1;
  double m_ejsTileExt1;
  double m_ejsTileBar2;
  double m_ejsTileExt2;  
  double m_ejsHEC0;
  double m_ejsHEC1;
  double m_ejsHEC2;
  double m_ejsHEC3;
  double m_ejsTileGap1;
  double m_ejsTileGap2;
  double m_ejsTileGap3;
  double m_ejsFCAL0;
  double m_ejsFCAL1;
  double m_ejsFCAL2;
 
  double m_tot;
  double m_ctot;
  double m_ehad; 
  double m_eem; 
 
  typedef         std::array<double,16>    double_array16;
  typedef         std::array<double,10>    double_array10;
 
  double m_eCryo;
  double m_eGap;
  double m_eScint;
  double m_eNull;
  
  // JetECS: Energy in each cell energy density bin, up to 16 bins
  double_array16  m_ePreSamBCell;
  double_array16  m_ePreSamECell;
  double_array16  m_eEMB1Cell;
  double_array16  m_eEME1Cell;
  double_array16  m_eEMB2Cell1;
  double_array16  m_eEMB2Cell2;
  double_array16  m_eEMB3Cell1;
  double_array16  m_eEMB3Cell2;
  double_array16  m_eEME2Cell1;
  double_array16  m_eEME2Cell2;
  double_array16  m_eEME3Cell1;
  double_array16  m_eEME3Cell2;
  double_array16  m_eTileBar0Cell;
  double_array16  m_eTileBar1Cell;
  double_array16  m_eTileBar2Cell;
  double_array16  m_eTileExt0Cell;
  double_array16  m_eTileExt1Cell;
  double_array16  m_eTileExt2Cell;
  double_array16  m_eHec0Cell1;
  double_array16  m_eHec1Cell1;
  double_array16  m_eHec2Cell1;
  double_array16  m_eHec3Cell1;
  double_array16  m_eHec0Cell2;
  double_array16  m_eHec1Cell2;
  double_array16  m_eHec2Cell2;
  double_array16  m_eHec3Cell2;
  double_array16  m_eFCal0Cell;
  double_array16  m_eFCal1Cell;
  double_array16  m_eFCal2Cell;
 
  // Energy in cone radii from Calo cells
  double_array10  m_erad_cells;
 
  // Energy in cone radii from tracks
  double_array10 m_erad_tracks;
 
};
#endif //JETEVENT_JETSAMPLING_H