FSimTrack.h

Go to the documentation of this file.

#ifndef FastSimulation_Event_FSimTrack_H
#define FastSimulation_Event_FSimTrack_H

// HepPDT Headers
#include "SimGeneral/HepPDTRecord/interface/ParticleDataTable.h"

// CMSSW Headers
#include "SimDataFormats/Track/interface/SimTrack.h"
#include "SimDataFormats/Vertex/interface/SimVertex.h"

// FAMOS headers
#include "CommonTools/BaseParticlePropagator/interface/RawParticle.h"

#include <vector>

class FSimVertex;
class FBaseSimEvent;

namespace HepMC {
  class GenParticle;
  class GenVertex;
}  // namespace HepMC

class FSimTrack : public SimTrack {
public:
  FSimTrack();

  FSimTrack(const RawParticle* p, int iv, int ig, int id, FBaseSimEvent* mom, double dt = -1.);

  FSimTrack(int ipart,
            const math::XYZTLorentzVector& p,
            int iv,
            int ig,
            int id,
            double charge,
            const math::XYZTLorentzVector& tkp,
            const math::XYZTLorentzVector& tkm,
            const SimVertex& tkv);

  virtual ~FSimTrack();

  inline const HepPDT::ParticleData* particleInfo() const { return info_; }

  inline float charge() const {
    if (particleInfo() == nullptr)
      return charge_;
    return particleInfo()->charge();
  }

  inline const FSimVertex vertex() const;

  inline const FSimVertex& endVertex() const;

  inline const FSimTrack& mother() const;

  inline const FSimTrack& daughter(int i) const;

  inline int nDaughters() const;

  inline const std::vector<int>& daughters() const;

  inline bool noEndVertex() const;

  bool notYetToEndVertex(const XYZTLorentzVector& pos) const;

  inline bool noMother() const;

  inline bool noDaughter() const;

  inline const HepMC::GenParticle* genParticle() const;

  inline int id() const { return id_; }

  inline int onLayer1() const { return layer1; }

  inline int onLayer2() const { return layer2; }

  inline int onEcal() const { return ecal; }

  inline int onHcal() const { return hcal; }

  inline int onVFcal() const { return vfcal; }

  inline int outHcal() const { return hcalexit; }

  //The particle was propagated to the HO front face
  inline int onHO() const { return hoentr; }

  inline bool propagated() const { return prop; }

  inline const RawParticle& layer1Entrance() const { return Layer1_Entrance; }

  inline const RawParticle& layer2Entrance() const { return Layer2_Entrance; }

  inline const RawParticle& ecalEntrance() const { return ECAL_Entrance; }

  inline const RawParticle& hcalEntrance() const { return HCAL_Entrance; }

  inline const RawParticle& vfcalEntrance() const { return VFCAL_Entrance; }

  inline const RawParticle& hcalExit() const { return HCAL_Exit; }

  inline const RawParticle& hoEntrance() const { return HO_Entrance; }

  inline bool isGlobal() const { return isGlobal_; }

  inline void setGlobal() { isGlobal_ = true; }

  inline void setOriginVertex(const SimVertex& v) { vertex_ = v; }

  inline void setEndVertex(int endv) { endv_ = endv; }

  void setPropagate();

  void setLayer1(const RawParticle& pp, int success);

  void setLayer2(const RawParticle& pp, int success);

  void setEcal(const RawParticle& pp, int success);

  void setHcal(const RawParticle& pp, int success);

  void setVFcal(const RawParticle& pp, int success);

  void setHcalExit(const RawParticle& pp, int success);

  void setHO(const RawParticle& pp, int success);

  //  void addRecHit(const FamosBasicRecHit* hit, unsigned layer);

  //  void addSimHit(const RawParticle& pp, unsigned layer);

  inline void addDaughter(int i) { daugh_.push_back(i); }

  inline void setClosestDaughterId(int id) { closestDaughterId_ = id; }

  inline int closestDaughterId() const { return closestDaughterId_; }

  const XYZTLorentzVector& momentum() const { return momentum_; }

  inline void setMomentum(const math::XYZTLorentzVector& newMomentum) { momentum_ = newMomentum; }

  inline const SimTrack& simTrack() const { return *this; }

  inline double decayTime() const { return properDecayTime; }

private:
  //  HepMC::GenParticle* me_;
  SimVertex vertex_;

  FBaseSimEvent* mom_;
  //  int embd_;   // The index in the SimTrack vector
  int id_;         // The index in the FSimTrackVector
  double charge_;  // Charge of the particle

  int endv_;  // The index of the end vertex in FSimVertex

  int layer1;    // 1 if the particle was propagated to preshower layer1
  int layer2;    // 1 if the particle was propagated to preshower layer2
  int ecal;      // 1 if the particle was propagated to ECAL/HCAL barrel
  int hcal;      // 2 if the particle was propagated to ECAL/HCAL endcap
  int vfcal;     // 1 if the particle was propagated to VFCAL
  int hcalexit;  // 2 if the particle was propagated to HCAL Exit point
  int hoentr;    // 1 if the particle was propagated to HO

  bool prop;  // true if the propagation to the calorimeters was done

  RawParticle Layer1_Entrance;  // the particle at preshower Layer1
  RawParticle Layer2_Entrance;  // the particle at preshower Layer2
  RawParticle ECAL_Entrance;    // the particle at ECAL entrance
  RawParticle HCAL_Entrance;    // the particle at HCAL entrance
  RawParticle VFCAL_Entrance;   // the particle at VFCAL entrance
  RawParticle HCAL_Exit;        // the particle at HCAL ezit point
  RawParticle HO_Entrance;      // the particle at HO entrance

  std::vector<int> daugh_;  // The indices of the daughters in FSimTrack
  int closestDaughterId_;   // The index of the closest daughter id

  const HepPDT::ParticleData* info_;  // The PDG info

  XYZTLorentzVector momentum_;

  double properDecayTime;  // The proper decay time  (default is -1)

  bool isGlobal_;  // needed for interfacing the new particle propagator with the old muon sim hit code
};

#include <iosfwd>
std::ostream& operator<<(std::ostream& o, const FSimTrack& t);

#include "FastSimulation/Event/interface/FSimTrack.icc"

#endif  // FSimTrack_H