CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
HectorTransport Class Reference

#include <HectorTransport.h>

Inheritance diagram for HectorTransport:
BaseProtonTransport

Public Member Functions

 HectorTransport (const edm::ParameterSet &ps, edm::ConsumesCollector iC)
 
void process (const HepMC::GenEvent *ev, const edm::EventSetup &es, CLHEP::HepRandomEngine *engine) override
 
 ~HectorTransport () override
 
- Public Member Functions inherited from BaseProtonTransport
void addPartToHepMC (const HepMC::GenEvent *, HepMC::GenEvent *)
 
void ApplyBeamCorrection (HepMC::GenParticle *p)
 
void ApplyBeamCorrection (TLorentzVector &p)
 
 BaseProtonTransport (const edm::ParameterSet &iConfig)
 
double beamEnergy ()
 
double beamMomentum ()
 
void clear ()
 
std::vector< LHCTransportLink > & getCorrespondenceMap ()
 
virtual ~BaseProtonTransport ()
 

Private Member Functions

bool setBeamLine ()
 
bool transportProton (const HepMC::GenParticle *)
 propagate the particles through a beamline to PPS More...
 

Private Attributes

const CTPPSBeamParametersbeamParameters_ {nullptr}
 
edm::ESGetToken< CTPPSBeamParameters, CTPPSBeamParametersRcdbeamParametersToken_
 
const BeamSpotObjectsbeamspot_ {nullptr}
 
edm::ESGetToken< BeamSpotObjects, BeamSpotObjectsRcdbeamspotToken_
 
std::unique_ptr< H_BeamLine > m_beamline45
 
std::unique_ptr< H_BeamLine > m_beamline56
 

Static Private Attributes

static constexpr double fPPSBeamLineLength_ = 250.
 

Additional Inherited Members

- Protected Types inherited from BaseProtonTransport
enum  TransportMode { TransportMode::HECTOR, TransportMode::TOTEM, TransportMode::OPTICALFUNCTIONS }
 
- Protected Member Functions inherited from BaseProtonTransport
void setBeamFileNames (const std::string &nam1, const std::string &nam2)
 
void setBeamParameters (double stx, double sty, double sx, double sy, double se)
 
void setCrossingAngles (double cx45, double cx56, double cy45, double cy56)
 
- Protected Attributes inherited from BaseProtonTransport
bool bApplyZShift_
 
std::string beam1Filename_ {""}
 
std::string beam2Filename_ {""}
 
CLHEP::HepRandomEngine * engine_ {nullptr}
 
double etaCut_
 
double fCrossingAngleX_45_ {0.0}
 
double fCrossingAngleX_56_ {0.0}
 
double fCrossingAngleY_45_ {0.0}
 
double fCrossingAngleY_56_ {0.0}
 
double fPPSRegionStart_45_
 
double fPPSRegionStart_56_
 
std::map< unsigned int, TLorentzVector > m_beamPart
 
std::vector< LHCTransportLinkm_CorrespondenceMap
 
std::map< unsigned int, double > m_xAtTrPoint
 
std::map< unsigned int, double > m_yAtTrPoint
 
TransportMode MODE
 
double momentumCut_
 
bool produceHitsRelativeToBeam_
 
bool useBeamPositionFromLHCInfo_
 
bool verbosity_
 

Detailed Description

Definition at line 39 of file HectorTransport.h.

Constructor & Destructor Documentation

◆ HectorTransport()

HectorTransport::HectorTransport ( const edm::ParameterSet ps,
edm::ConsumesCollector  iC 
)

Definition at line 11 of file HectorTransport.cc.

References edm::ParameterSet::getParameter(), BaseProtonTransport::HECTOR, BaseProtonTransport::MODE, BaseProtonTransport::setBeamFileNames(), setBeamLine(), BaseProtonTransport::setBeamParameters(), BaseProtonTransport::setCrossingAngles(), AlCaHLTBitMon_QueryRunRegistry::string, fftjetcommon_cfi::sx, and fftjetcommon_cfi::sy.

12  : BaseProtonTransport(iConfig),
13  m_beamline45(nullptr),
14  m_beamline56(nullptr),
18  std::string s1 = iConfig.getParameter<std::string>("Beam1Filename");
19  std::string s2 = iConfig.getParameter<std::string>("Beam2Filename");
20  setBeamFileNames(s1, s2);
21  double cax45 = iConfig.getParameter<double>("halfCrossingAngleXSector45");
22  double cax56 = iConfig.getParameter<double>("halfCrossingAngleXSector56");
23  double cay45 = iConfig.getParameter<double>("halfCrossingAngleYSector45");
24  double cay56 = iConfig.getParameter<double>("halfCrossingAngleYSector56");
25  setCrossingAngles(cax45, cax56, cay45, cay56);
26  double stx = iConfig.getParameter<double>("BeamDivergenceX");
27  double sty = iConfig.getParameter<double>("BeamDivergenceY");
28  double sx = iConfig.getParameter<double>("BeamSigmaX");
29  double sy = iConfig.getParameter<double>("BeamSigmaY");
30  double se = iConfig.getParameter<double>("BeamEnergyDispersion");
31  setBeamParameters(stx, sty, sx, sy, se);
32  //PPS
33  edm::LogVerbatim("ProtonTransport")
34  << "=============================================================================\n"
35  << " Bulding LHC Proton transporter based on HECTOR model\n"
36  << "=============================================================================\n";
37  setBeamLine();
38 }
Log< level::Info, true > LogVerbatim
BaseProtonTransport(const edm::ParameterSet &iConfig)
void setBeamParameters(double stx, double sty, double sx, double sy, double se)
edm::ESGetToken< CTPPSBeamParameters, CTPPSBeamParametersRcd > beamParametersToken_
void setCrossingAngles(double cx45, double cx56, double cy45, double cy56)
void setBeamFileNames(const std::string &nam1, const std::string &nam2)
std::unique_ptr< H_BeamLine > m_beamline56
std::unique_ptr< H_BeamLine > m_beamline45
edm::ESGetToken< BeamSpotObjects, BeamSpotObjectsRcd > beamspotToken_

◆ ~HectorTransport()

HectorTransport::~HectorTransport ( )
override

Definition at line 39 of file HectorTransport.cc.

39 {}

Member Function Documentation

◆ process()

void HectorTransport::process ( const HepMC::GenEvent ev,
const edm::EventSetup es,
CLHEP::HepRandomEngine *  engine 
)
overridevirtual

Implements BaseProtonTransport.

Definition at line 44 of file HectorTransport.cc.

References beamParameters_, beamParametersToken_, beamspot_, beamspotToken_, BaseProtonTransport::clear(), BaseProtonTransport::engine_, BaseProtonTransport::etaCut_, GenParticle::GenParticle, edm::EventSetup::getData(), mps_splice::line, BaseProtonTransport::m_beamPart, BaseProtonTransport::momentumCut_, and transportProton().

46  {
47  clear();
48  engine_ = engine; // the engine needs to be updated for each event
49 
50  beamspot_ = &iSetup.getData(beamspotToken_);
51  beamParameters_ = &iSetup.getData(beamParametersToken_);
52 
53  for (HepMC::GenEvent::particle_const_iterator eventParticle = evt->particles_begin();
54  eventParticle != evt->particles_end();
55  ++eventParticle) {
56  if (!((*eventParticle)->status() == 1 && (*eventParticle)->pdg_id() == 2212))
57  continue;
58 
59  if (!(fabs((*eventParticle)->momentum().eta()) > etaCut_ && fabs((*eventParticle)->momentum().pz()) > momentumCut_))
60  continue; // discard protons outside kinematic acceptance
61 
62  unsigned int line = (*eventParticle)->barcode();
63  HepMC::GenParticle* gpart = (*eventParticle);
64 
65  if (gpart->pdg_id() != 2212)
66  continue; // only transport stable protons
67  if (gpart->status() != 1)
68  continue;
69  if (m_beamPart.find(line) != m_beamPart.end())
70  continue; // assures this protons has not been already propagated
71 
72  transportProton(gpart);
73  }
74 }
bool transportProton(const HepMC::GenParticle *)
propagate the particles through a beamline to PPS
edm::ESGetToken< CTPPSBeamParameters, CTPPSBeamParametersRcd > beamParametersToken_
const CTPPSBeamParameters * beamParameters_
const BeamSpotObjects * beamspot_
CLHEP::HepRandomEngine * engine_
std::map< unsigned int, TLorentzVector > m_beamPart
edm::ESGetToken< BeamSpotObjects, BeamSpotObjectsRcd > beamspotToken_

◆ setBeamLine()

bool HectorTransport::setBeamLine ( )
private

Definition at line 187 of file HectorTransport.cc.

References b1, b2, BaseProtonTransport::beam1Filename_, BaseProtonTransport::beam2Filename_, fPPSBeamLineLength_, BaseProtonTransport::fPPSRegionStart_45_, BaseProtonTransport::fPPSRegionStart_56_, LogDebug, m_beamline45, m_beamline56, and BaseProtonTransport::verbosity_.

Referenced by HectorTransport().

187  {
190 
191  // construct beam line for PPS (forward 1 backward 2):
192  if (fPPSBeamLineLength_ > 0.) {
193  m_beamline45 = std::make_unique<H_BeamLine>(-1, fPPSBeamLineLength_ + 0.1);
194  m_beamline45->fill(b2.fullPath(), 1, "IP5");
195  m_beamline56 = std::make_unique<H_BeamLine>(1, fPPSBeamLineLength_ + 0.1);
196  m_beamline56->fill(b1.fullPath(), 1, "IP5");
197  } else {
198  if (verbosity_)
199  LogDebug("HectorTransportSetup") << "HectorTransport: WARNING: lengthctpps= " << fPPSBeamLineLength_;
200  return false;
201  }
202  if (verbosity_) {
203  edm::LogInfo("HectorTransportSetup") << "===================================================================\n"
204  << " * * * * * * * * * * * * * * * * * * * * * * * * * * * * \n"
205  << " * * \n"
206  << " * --<--<-- A fast simulator --<--<-- * \n"
207  << " * | --<--<-- of particle --<--<-- * \n"
208  << " * ----HECTOR----< * \n"
209  << " * | -->-->-- transport through-->-->-- * \n"
210  << " * -->-->-- generic beamlines -->-->-- * \n"
211  << " * * \n"
212  << " * JINST 2:P09005 (2007) * \n"
213  << " * X Rouby, J de Favereau, K Piotrzkowski (CP3) * \n"
214  << " * http://www.fynu.ucl.ac.be/hector.html * \n"
215  << " * * \n"
216  << " * Center for Cosmology, Particle Physics and Phenomenology * \n"
217  << " * Universite catholique de Louvain * \n"
218  << " * Louvain-la-Neuve, Belgium * \n"
219  << " * * \n"
220  << " * * * * * * * * * * * * * * * * * * * * * * * * * * * * \n"
221  << " HectorTransport configuration: \n"
222  << " Beam line length = " << fPPSBeamLineLength_ << "\n"
223  << " PPS Region Start 44 = " << fPPSRegionStart_45_ << "\n"
224  << " PPS Region Start 56 = " << fPPSRegionStart_56_ << "\n"
225  << "===================================================================\n";
226  edm::LogVerbatim("HectorTransportSetup") << "===================================================================\n"
227  << " Forward beam line elements \n";
228  m_beamline45->showElements();
229  edm::LogVerbatim("HectorTransportSetup") << "===================================================================\n"
230  << " Backward beam line elements \n";
231  m_beamline56->showElements();
232  }
233  return true;
234 }
Log< level::Info, true > LogVerbatim
weight_default_t b1[25]
Definition: b1.h:9
weight_default_t b2[10]
Definition: b2.h:9
Log< level::Info, false > LogInfo
static constexpr double fPPSBeamLineLength_
std::unique_ptr< H_BeamLine > m_beamline56
std::unique_ptr< H_BeamLine > m_beamline45
#define LogDebug(id)

◆ transportProton()

bool HectorTransport::transportProton ( const HepMC::GenParticle *  gpart)
private

propagate the particles through a beamline to PPS

Definition at line 75 of file HectorTransport.cc.

References BaseProtonTransport::beamEnergy(), BaseProtonTransport::beamMomentum(), beamParameters_, beamspot_, ALCARECOTkAlJpsiMuMu_cff::charge, cm_to_mm, funct::cos(), MillePedeFileConverter_cfg::e, BaseProtonTransport::fCrossingAngleX_45_, BaseProtonTransport::fCrossingAngleX_56_, BaseProtonTransport::fCrossingAngleY_45_, BaseProtonTransport::fCrossingAngleY_56_, BaseProtonTransport::fPPSRegionStart_45_, BaseProtonTransport::fPPSRegionStart_56_, CTPPSBeamParameters::getVtxOffsetX45(), CTPPSBeamParameters::getVtxOffsetY45(), mps_splice::line, LogDebug, m_beamline45, m_beamline56, BaseProtonTransport::m_beamPart, BaseProtonTransport::m_xAtTrPoint, BaseProtonTransport::m_yAtTrPoint, EgHLTOffHistBins_cfi::mass, mm_to_um, funct::pow(), BaseProtonTransport::produceHitsRelativeToBeam_, ProtonMassSQ, multPhiCorr_741_25nsDY_cfi::px, multPhiCorr_741_25nsDY_cfi::py, mathSSE::sqrt(), funct::tan(), theta(), um_to_mm, urad, BaseProtonTransport::useBeamPositionFromLHCInfo_, BaseProtonTransport::verbosity_, BeamSpotObjects::x(), and BeamSpotObjects::y().

Referenced by process().

75  {
76  edm::LogVerbatim("ProtonTransport") << "Starting proton transport using HECTOR method\n";
77 
78  double px, py, pz, e;
79  unsigned int line = (gpart)->barcode();
80 
81  double mass = gpart->generatedMass();
82  double charge = 1.;
83 
84  // remove the CMS vertex shift
85  double vtxXoffset;
86  double vtxYoffset;
88  vtxXoffset = beamParameters_->getVtxOffsetX45() * cm_to_mm;
89  vtxYoffset = beamParameters_->getVtxOffsetY45() * cm_to_mm;
90  } else {
91  vtxXoffset = beamspot_->x() * cm_to_mm;
92  vtxYoffset = beamspot_->y() * cm_to_mm;
93  }
94 
95  // Momentum in LHC ref. frame
96  px = -gpart->momentum().px();
97  py = gpart->momentum().py();
98  pz = -gpart->momentum().pz();
99  e = gpart->momentum().e();
100 
101  int direction = (pz > 0) ? 1 : -1; // in relation to LHC ref frame
102 
103  double XforPosition = -gpart->production_vertex()->position().x(); //mm in the ref. frame of LHC
104  double YforPosition = gpart->production_vertex()->position().y(); //mm
105  double ZforPosition = -gpart->production_vertex()->position().z(); //mm
106  double fCrossingAngleX = (pz < 0) ? fCrossingAngleX_45_ : fCrossingAngleX_56_;
107  double fCrossingAngleY = (pz < 0) ? fCrossingAngleY_45_ : fCrossingAngleY_56_;
108  //
109  H_BeamParticle h_p(mass, charge);
110  h_p.set4Momentum(px, py, pz, e);
111  //
112  // shift the starting position of the track to Z=0 if configured so (all the variables below are still in cm)
113  XforPosition = XforPosition - ZforPosition * (px / pz + fCrossingAngleX * urad); // theta ~=tan(theta)
114  YforPosition = YforPosition - ZforPosition * (py / pz + fCrossingAngleY * urad);
115  XforPosition -= (-vtxXoffset); // X was already in the LHC ref. frame
116  YforPosition -= vtxYoffset;
117 
118  // set position, but do not invert the coordinate for the angles (TX,TY) because it is done by set4Momentum
119  h_p.setPosition(XforPosition * mm_to_um, YforPosition * mm_to_um, h_p.getTX(), h_p.getTY(), 0.);
120 
121  bool is_stop;
122  float x1_ctpps;
123  float y1_ctpps;
124 
125  H_BeamLine* beamline = nullptr;
126  double targetZ = 0;
127  switch (direction) {
128  case 1:
129  beamline = &*m_beamline56; // negative side propagation
130  targetZ = fPPSRegionStart_56_;
131  break;
132  case -1:
133  beamline = &*m_beamline45;
134  targetZ = fPPSRegionStart_45_;
135  break;
136  }
137  // insert protection for NULL beamlines here
138  h_p.computePath(&*beamline);
139  is_stop = h_p.stopped(&*beamline);
140  if (verbosity_)
141  LogDebug("HectorTransportEventProcessing")
142  << "HectorTransport:filterPPS: barcode = " << line << " is_stop= " << is_stop;
143  if (is_stop) {
144  return false;
145  }
146  //
147  //propagating
148  //
149  h_p.propagate(targetZ);
150  x1_ctpps = h_p.getX();
151  y1_ctpps = h_p.getY();
152 
153  double thx = h_p.getTX();
154  double thy = h_p.getTY();
155 
157  H_BeamParticle p_beam(mass, charge);
158  p_beam.set4Momentum(0., 0., beamMomentum(), beamEnergy());
159  p_beam.setPosition(0., 0., fCrossingAngleX * urad, fCrossingAngleY * urad, 0.);
160  p_beam.computePath(&*beamline);
161  thx -= p_beam.getTX();
162  thy -= p_beam.getTY();
163  x1_ctpps -= p_beam.getX();
164  y1_ctpps -= p_beam.getY();
165  edm::LogVerbatim("HectorTransportEventProcessing")
166  << "Shifting the hit relative to beam : X = " << p_beam.getX() << "(mm) Y = " << p_beam.getY() << "(mm)";
167  }
168 
169  double partP = sqrt(pow(h_p.getE(), 2) - ProtonMassSQ);
170  double theta = sqrt(thx * thx + thy * thy) * urad;
171 
172  // copy the kinematic changing to CMS ref. frame, only the negative Pz needs to be changed
173  TLorentzVector p_out(-tan(thx * urad) * partP * cos(theta),
174  tan(thy * urad) * partP * cos(theta),
175  -direction * partP * cos(theta),
176  h_p.getE());
177 
178  m_beamPart[line] = p_out;
179  m_xAtTrPoint[line] = -x1_ctpps * um_to_mm; // move to CMS ref. frame
180  m_yAtTrPoint[line] = y1_ctpps * um_to_mm;
181  if (verbosity_)
182  LogDebug("HectorTransportEventProcessing")
183  << "HectorTransport:filterPPS: barcode = " << line << " x= " << x1_ctpps << " y= " << y1_ctpps;
184 
185  return true;
186 }
Log< level::Info, true > LogVerbatim
static const double urad
double getVtxOffsetX45() const
const CTPPSBeamParameters * beamParameters_
T sqrt(T t)
Definition: SSEVec.h:19
Cos< T >::type cos(const T &t)
Definition: Cos.h:22
Tan< T >::type tan(const T &t)
Definition: Tan.h:22
double x() const
get X beam position
double getVtxOffsetY45() const
const BeamSpotObjects * beamspot_
static const double um_to_mm
double y() const
get Y beam position
std::map< unsigned int, double > m_xAtTrPoint
static const double mm_to_um
std::map< unsigned int, TLorentzVector > m_beamPart
std::unique_ptr< H_BeamLine > m_beamline56
std::unique_ptr< H_BeamLine > m_beamline45
static const double ProtonMassSQ
std::map< unsigned int, double > m_yAtTrPoint
Geom::Theta< T > theta() const
Power< A, B >::type pow(const A &a, const B &b)
Definition: Power.h:29
static const double cm_to_mm
#define LogDebug(id)

Member Data Documentation

◆ beamParameters_

const CTPPSBeamParameters* HectorTransport::beamParameters_ {nullptr}
private

Definition at line 62 of file HectorTransport.h.

Referenced by process(), and transportProton().

◆ beamParametersToken_

edm::ESGetToken<CTPPSBeamParameters, CTPPSBeamParametersRcd> HectorTransport::beamParametersToken_
private

Definition at line 59 of file HectorTransport.h.

Referenced by process().

◆ beamspot_

const BeamSpotObjects* HectorTransport::beamspot_ {nullptr}
private

Definition at line 63 of file HectorTransport.h.

Referenced by process(), and transportProton().

◆ beamspotToken_

edm::ESGetToken<BeamSpotObjects, BeamSpotObjectsRcd> HectorTransport::beamspotToken_
private

Definition at line 60 of file HectorTransport.h.

Referenced by process().

◆ fPPSBeamLineLength_

constexpr double HectorTransport::fPPSBeamLineLength_ = 250.
staticprivate

Definition at line 47 of file HectorTransport.h.

Referenced by setBeamLine().

◆ m_beamline45

std::unique_ptr<H_BeamLine> HectorTransport::m_beamline45
private

Definition at line 56 of file HectorTransport.h.

Referenced by setBeamLine(), and transportProton().

◆ m_beamline56

std::unique_ptr<H_BeamLine> HectorTransport::m_beamline56
private

Definition at line 57 of file HectorTransport.h.

Referenced by setBeamLine(), and transportProton().