TP0DECALReconModule.hxx

Go to the documentation of this file.

///
/// For questions or suggestions about this module please contact the
/// current responsible and CC in the eventAnalysis package manager.
///
/// 2014-12-12: Currently responsible for this module is,
/// Luke Pickering (lp208 [*a*t*] ic.ac.uk)

#ifndef TP0DECALReconModule_hxx_seen
#define TP0DECALReconModule_hxx_seen

#include <TNamed.h>
#include <TTree.h>
#include <TIntegerDatum.hxx>
#include <TND280Event.hxx>
#include <TReconCluster.hxx>
#include <string>
#include "TReconPID.hxx"
#include "TReconShower.hxx"
#include "TReconTrack.hxx"

#include "TClonesArray.h"

#include "TAnalysisReconModuleBase.hxx"

namespace ND {
class TP0DECALReconModule;
};

/// Used to summarise the reconstruction of an event in the P0DECal.
/// The primary level store the RunNo, EventID, number of tracks and showers
/// and TCloneArray of TP0DECALTracks and TP0DECALShowers.
class ND::TP0DECALReconModule : public TAnalysisReconModuleBase {
 public:
  /// Summary of reconstruction information held within a TReconTrack
  class TP0DECALReconTrack : public TObject {
   public:
    virtual ~TP0DECALReconTrack();
    UInt_t UniqueID;///< The object UniqueID which can be used to match this object to the Global Recon object.

    // std::string AlgorithmName;// The name of the algorithm that created this reconstruction object.
    double Curvature;///< The curvature around the x axis of the corresponding TReconTrack.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->Curvature
    TVector3 Direction;///< The Direction of the corresponding TReconTrack.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->Direction
    double EDeposit;///< The reconstructed energy deposited by the corresponding TReconTrack.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->EDeposit

    // the full name of this datum. The full name places the datum in the
    // data tree and has the syntax //xxxx/yyyy/zzzz.
    // TString FullName;

    int NDOF;///<\short The Number of Degrees of Freedom in the reconstruction of the
    ///<\skipline ecalReconTrack->NDOF
    ///< corresponding ND::TReconTrack.
    ///<\details Retreived from ND::TReconBase::GetNDOF
    ///<\dontinclude TP0DECALReconModule.cxx
    TLorentzVector Position;    ///< The reconstructed starting 4-position of the TReconTrack.  Uses ND::TReconTrack::GetPosition.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->Position
    double Quality;///< The 'quality' of the reconstruction according to the relevant  TReconTrack, from ND::TReconBase::GetQuality.
    ///<\details
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->Quality
    TVector3 Width;///< The 'width' of the corresponding TReconTrack.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->Width
    double AMR;///< PID Variable: Axis Max Ratio - the ratio of primary and secondary  components of a 2D PCA.
    double CWTrackWidth;///<\short PID Variable: Width of the track in bars, weighted by the charge  in each bar.
    double Max_Ratio;///<\short PID Variable: The ratio between highest and lowest hit charges in  the reconstruction cluster.
    double NormChargeSD;///<\short PID Variable: Normalised standard deviation of the contributing  reconstructed hit charges.
    double PathChargeRatio;///<\short The ratio of total hit charges between the front half and back  half of the TReconTrack.
    double TrShval;///<\short PID Variable: The output of the ANN using the other PID Variables  as input. Track-like events have a TrShval close to '1'.
    int NHits;///< The number of THits which contributed to this reconstruction cluster.
    TVector3 BenCWPosition;///< Ben Smith's charge weighted reconstruction position.
    int StackNo;///< The stack in which the TReconTrack resides. Uses  TReconBase::GetDetector.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconTrack->StackNo
    std::string Module;///< The name of the module in which the TReconTrack resides.
    int TrueID;///< For MC events: The Id of the corresponding ND::TG4Trajectory.
    ///<\details Uses the corresponding ND::TReconTrack's ND::THitSelection and
    ///< TrackTruthInfo::GetG4TrajIDHits to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skip if (isMC){
    ///<\skipline trueID
    ///<\until ;
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will not correspond to the correct ND::TG4Trajectory but may
    ///< correspond to a parent ND::TG4Trajectory.
    int TruePDG;///< For MC events: The PDG code of the true particle.
    ///<\details Uses TP0DECALReconTrack::TrueID to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline g4traj->GetPDGEncoding();
    ///<\skipline TruePDG
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will hold a default value of '0'.
    int TrueParentID;///< For MC events: The Id of the true trajectory's parent  ND::TG4Trajectory
    ///<\details Uses TP0DECALReconTrack::TrueID to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline g4traj->GetParentId();
    ///<\skipline TrueParentID
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will hold a default value of '-999'.
    double TrueHitPurity;///<  For MC events: The 'cleanliness' of the ND::THits which make up  the corresponding ND::TReconTrack.
    ///<\details Compares to the ND::TG4Trajectory with Id =
    ///< TP0DECALReconTrack::TrueID via TrackTruthInfo::GetG4TrajIDHits
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skip if (isMC){
    ///<\skipline trueID
    ///<\until ;
    ///<\skipline ->TrueHitPurity
    double TrueHitEfficiency;///< For MC events: The 'completeness' of the ND::THits which make up  the corresponding ND::TReconTrack.
    ///<\details Compares to the ND::TG4Trajectory with Id =
    ///< TP0DECALReconTrack::TrueID via TrackTruthInfo::GetG4TrajIDHits
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skip if (isMC){
    ///<\skipline trueID
    ///<\until ;
    ///<\skipline ->TrueHitEff
    TLorentzVector TrueInitPos; ///< For MC events: The true initial position of the corresponding  ND::TG4Trajectory.
    ///<\details Uses TP0DECALReconTrack::TrueID to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline g4traj->GetInitialPosition();
    ///<\skipline TrueInitPos
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will hold a default value of '{-9999,-9999,-9999,-9999}'.
    TLorentzVector TrueFinalPos;///< For MC events: The true final position of the corresponding  ND::TG4Trajectory.
    ///<\details Uses TP0DECALReconTrack::TrueID to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline g4traj->GetFinalPosition();
    ///<\skipline TrueFinalPos
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will hold a default value of '{-9999,-9999,-9999,-9999}'.
    
        TLorentzVector TrueInitMom;///< For MC events: The true initial momentum of the corresponding  ND::TG4Trajectory.
    ///<\details Uses TP0DECALReconTrack::TrueID to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline g4traj->GetInitialMomentum();
    ///<\skipline TrueInitMom
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will hold a default value of '{-9999,-9999,-9999,-9999}'.

    ClassDef(TP0DECALReconModule::TP0DECALReconTrack, 1);
  };

 public:
  /// Summary of reconstruction information held within a TReconShower
  class TP0DECALReconShower : public TObject {
   public:
    virtual ~TP0DECALReconShower();

    UInt_t UniqueID;    ///< The object UniqueID which can be used to match this object  to the Global Recon object.

    // The name of the algorithm that created this reconstruction object.
    // std::string AlgorithmName;

    TVector3 ConeAngle;    ///< The opening angle of the corresponding TReconShower.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->ConeAngle
    TVector3 Direction;    ///< The Direction of the corresponding TReconShower.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->Direction
    double EDeposit;    ///< The reconstructed energy deposited by the corresponding TReconTrack.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->EDeposit

    // The full name of this datum. The full name places the datum in the
    // data tree and has the syntax //xxxx/yyyy/zzzz.
    // TString FullName;

    int NDOF;    ///<\short The Number of Degrees of Freedom in the reconstruction of the
    ///< corresponding ND::TReconTrack.
    ///<\details Retreived from ND::TReconBase::GetNDOF
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->NDOF

    TLorentzVector Position;    ///< The reconstructed starting 4-position of the TReconTrack.
    ///< Uses ND::TReconShower::GetPosition.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->Position

    double Quality;    ///<\short The 'quality' of the reconstruction according to the relevant
    ///< TReconTrack, from ND::TReconBase::GetQuality.
    ///<\details
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->Quality

    double AMR;    ///< PID Variable: Axis Max Ratio - the ratio of primary and secondary components of a 2D PCA.
    double CWTrackWidth;    ///< PID Variable: Width of the track in bars, weighted by the charge  in each bar.
    double Max_Ratio;    ///< PID Variable: The ratio between highest and lowest hit charges in  the reconstruction cluster.
    double NormChargeSD;    ///< PID Variable: Normalised standard deviation of the contributing  reconstructed hit charges.
    double PathChargeRatio;    ///< The ratio of total hit charges between the front half and back  half of the TReconShower.
    double TrShval;    ///< PID Variable: The output of the ANN using the other PID Variables  as input. Shower-like events have a TrShval close to '0'.
    int NHits;    ///< The number of THits which contributed to this reconstruction cluster.
    TVector3 BenCWPosition;    ///< Ben's charge weighted reconstruction position.
    int StackNo;    ///< The stack in which the TReconTrack resides. Uses
    ///< TReconBase::GetDetector.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skipline ecalReconShower->StackNo
    int TrueID;    ///< For MC events: The Id of the primary corresponding ND::TG4Trajectory.
    ///< Uses the corresponding ND::TReconShower's ND::THitSelection and
    ///<  ND::TShowerTruthInfo to obtain the corresponding primary
    ///< ND::TG4Trajectory.
    ///<\dontinclude TP0DECALReconModule.cxx
    ///<\skip Truth matching info - SHOWERS
    ///<\skip if (isMC){
    ///<\until ecalReconShower->TrueID
    ///< In some cases a given ND::TG4Trajectory may not have been saved in which
    ///< case this will not correspond to the correct ND::TG4Trajectory but may
    ///< correspond to a parent ND::TG4Trajectory.

    std::string Module;    ///< The name of the module in which the TReconTrack resides.


    ClassDef(TP0DECALReconModule::TP0DECALReconShower, 1);
  };

  class TP0DECALLayerCharge : public TObject {
   public:
    virtual ~TP0DECALLayerCharge();

    double FirstTime;  ///< The earliest hit time of the relevant cluster.

    double LastTime;  ///< The latest hit time of the relevant cluster.

  
    double Charge[6];  ///< The total charge deposited in each of 6layers. Index 0  corresponds the innermost layer

    TString module_name;    ///< The name of the module.


    ClassDef(TP0DECALReconModule::TP0DECALLayerCharge, 1);
  };

 public:
  TP0DECALReconModule(const char *name = "P0DECal",
                      const char *title = "P0D ECal Recon Module");
  virtual Bool_t ProcessFirstEvent(ND::TND280Event &event);
  virtual ~TP0DECALReconModule();

 protected:
  virtual void InitializeModule();
  virtual void InitializeBranches();
  virtual bool FillTree(ND::TND280Event &);

 public:
  // Tree Entries
  Int_t fNReconTracks;   ///< Number of objects in clones array.
  Int_t fNReconShowers;  ///< Number of objects in clones array.
  Int_t fNLayerCharge;   ///< Number of objects in clones array.

  TClonesArray *fReconTracks;   ///< TClonesArray of TP0DECALReconTrack Objects
  TClonesArray *fReconShowers;  ///< TClonesArray of TP0DECALReconShower Objects
  TClonesArray *fLayerCharge;   ///< TClonesArray of TP0DECALLayerCharge Objects

 private:
};
#endif