TSmrdReconModule.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.
///
/// current manager is
/// Alexander Izmaylov (izmaylov [*a*t*] inr.ru)

#ifndef _TSmrdReconModule_hxx_seen
#define _TSmrdReconModule_hxx_seen

#include <TClonesArray.h>

#include "TAnalysisReconModuleBase.hxx"
#include "eventAnalysisEnums.hxx"

namespace ND {
class TSmrdReconModule;
}

/// Summary information from smrdRecon output.
// [TW]
class ND::TSmrdReconModule : public TAnalysisReconModuleBase {
 public:
  enum ESMRDWall { kTop = 0, kBottom, kRight, kLeft };

  /// Both-sided SMRD TReconHit that isn't included in any reconstructed track.
  /// It contains Z position calculated according to the time difference
  /// between two sides.
  class TSmrdReconHit : public TObject {
   public:
    virtual ~TSmrdReconHit();

    TLorentzVector Position;     ///< The reconstructed 4-position of the corresponding double ended ND::THit.

    TLorentzVector PositionUncertainty; ///<\brief  The uncertainty on the reconstructed 4-position of the corresponding double ended ND::THit.
    
    double Charge;///< The reconstructed charge of the corresponding double ended ND::THit.


    double dZ;     ///<\short The difference in Z between the combined ND::THit(double ended  bars)  and the first contributor ND::THit.
     ///<\details
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline contrhit1 =
    ///<\skipline reconHit->dZ
 
    double dT; ///<\short The difference between the reconstructed ND::THit times between  the two contributors. 
    ///<\details
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline contrhit1 =
    ///<\skipline contrhit2 =
    ///<\skipline reconHit->dT

    double ContribCharge[2]; ///< The reconstructed charges from each contributor of the double ended bar.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline ContribCharge[0] =
    ///<\skipline ContribCharge[1] =

    int Wall;///< The SMRD wall in which this the corresponding ND::THit resides. Is assigned a value from TSmrdReconModule::ESMRDWall.  Uses ND::TSMRDGeom::IsSMRDTopWall, ND::TSMRDGeom::IsSMRDBotoomWall, ND::TSMRDGeom::IsSMRDLeftWall and ND::TSMRDGeom::IsSMRDRightWall.
    
    int Yoke; ///< The SMRD yoke number. ranges from 1(most upstream) to 8(most downstream). 
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline reconHit->Yoke
    
    
    int Layer; ///< The SMRD ring number.  ranges from 1(most inner) to 6(most outer).
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline reconHit->Layer
   
    int Tower; ///< The SMRD tower number. Tower 1 is left-top and numbers are assigned clockwise.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline reconHit->Tower
    
    
    int Counter; ///< The SMRD scintillator number.  Each yoke has either 20-for vertical(SMRD Left/Right) walls, or 16 for  horizontal walls.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline reconHit->Counter
    
    UInt_t RMM; ///< The RMM Id of the channel corresponding to the first contributor hit.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip ND::TChannelId chan
    ///<\until reconHit->RMM

    UInt_t TFB;     ///< The TFB Id of the channel corresponding to the first contributor hit.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip ND::TChannelId chan
    ///<\until ND::TTFBChannelId tfbid(chan);
    ///<\skipline reconHit->TFB

    bool IsInnerMatched;     ///< Designates if the corresponding ND::THit was matched

    bool IsUsed; ///<Designates if the corresponding ND::THit was used in a  reconstructed object.

    ClassDef(TSmrdReconModule::TSmrdReconHit, 1);
  };

  /// SMRD isolated track.
  class TSmrdIsoTrack : public TObject {
   public:
    virtual ~TSmrdIsoTrack();

    UInt_t UniqueID; ///< The Unique ID of the corresponding ND::TReconTrack, used for  global-subdetector matching.

    std::string AlgorithmName;  ///<Name of the reconstruction algorithm.

    TLorentzVector FrontPos; ///< Position of the 'first' TTrackState of the corresponding  ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip frontState =
    ///<\until ;
    ///<\skipline isoTrack->FrontPos
    ///< where the 'first' state is found by ND::TrackingUtils::GetFirstState
    
    TLorentzVector FrontPosVariance;///<Variance on the position of the 'first' TTrackState of the  corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip frontState =
    ///<\until ;
    ///<\skipline isoTrack->FrontPosVariance
    ///< where the 'first' state is found by ND::TrackingUtils::GetFirstState

    TLorentzVector BackPos; ///< Position of the 'last' TTrackState of the corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip backState =
    ///<\until ;
    ///<\skipline isoTrack->BackPos
    ///< where the 'last' state is found by ND::TrackingUtils::GetLastState

    TLorentzVector BackPosVariance; ///<Variance on the position of the 'last' TTrackState of the  corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip backState =
    ///<\until ;
    ///<\skipline isoTrack->BackPosVariance
    ///< where the 'last' state is found by ND::TrackingUtils::GetLastState

    TVector3 Direction; ///<Direction of the TTrackState which is the state of the  corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline trackState->GetDirection()


    TVector3 DirectionVariance; ///<Variance on the direction the TTrackState which is the state of  the corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline isoTrack->DirectionVariance

    int NHits; ///<Number of ND::THits which are associated with the corresponding  ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline ND::TReconNodeContainer& nodes
    ///<\skipline isoTrack->NHits

    int NNodes; ///<Number of TReconNodes which are constituents of the corresponding  ND::TReconTrack.
    ///<\details
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline ND::THandle<ND::ND::THitSelection> hits = track->GeND::tHits();
    ///<\skipline isoTrack->NNode

    int Status; ///< The reported Status of the corresponding ND::TReconTrack.  Holds kSuccess if the ND::TReconTrack::fStatus has the kSuccess bit set.  Uses ND::TReconBase::CheckStatus to check this.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline isoTrack->Status

    int KalmanStatus; ///< Kalman filter refit result for the corresponding ND::TReconTrack.  Holds '1' if the algorithm was run and has Status kSuccess, otherwise  '0'
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip std::string name("RECPACK_KalmanFilter");
    ///<\until }
    ///<\until }

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

    double EDeposit; ///< The total reconstructed charge of the corresponding ND::TReconTrack.  Defaults to '-9999.0' if no ND::TRealDatum named 'totalCharge' is  found on the corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip isoTrack->EDeposit
    ///<\until }

    double avgtime; ///< Average hit time of the corresponding ND::TReconTrack.  Defaults to '-9999.0' if no ND::TRealDatum named 'averageHitTime'  is found on the corresponding ND::TReconTrack.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skip isoTrack->avgtime
    ///<\until }

    double Range; ///<The spacial distance between TSmrdIsoTrack::FrontPos and  TSmrdIsoTrack::BackPos.
 
    double Chi2; ///<The reported reconstruction 'quality' of the corresponding  ND::TReconTrack.
    ///<\details Uses ND::TReconBase::GetQuality
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline isoTrack->Chi2

    double ThetaAngle; ///< Polar coordinate theta of the TSmrdIsoTrack::Direction. 
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline isoTrack->ThetaAngle
   
    double PhiAngle; ///< Polar coordinate phi of the TSmrdIsoTrack::Direction.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline isoTrack->PhiAngle
    // std::vector<TVector3*> HitPositions;

    // MC Truth information.
    TLorentzVector TrueInitPos; ///<For MC events: The true initial position of the corresponding  ND::TG4Trajectory.
    ///\details Uses TSmrdIsoTrack::TrueId to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline trueInitPos   =
    ///<\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}'.

    int TrueInitDet; ///<For MC events: The subdetector in which  TSmrdIsoTrack::TrueInitPos lies
    ///<\details
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline gGeoManager->FindNode(trueInitPos.X()

    TLorentzVector TrueFinalPos; ///<For MC events: The true final position of the corresponding  ND::TG4Trajectory.
    ///<\details Uses TSmrdIsoTrack::TrueId to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline trueFinalPos  =
    ///<\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}'.

    int TrueFinalDet; ///<For MC events: The subdetector in which  TSmrdIsoTrack::TrueFinalPos lies
    ///<\details
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline isoTrack->TrueFinalDet =
    ///<\until ;

    TLorentzVector TrueInitMom; ///<For MC events: The true initial momentum of the corresponding  ND::TG4Trajectory.
    ///<\details Uses TSmrdIsoTrack::TrueId to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline trueInitMom   =
    ///<\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}'.

    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 TSmrdReconModule.cxx
    ///<\skipline trueId = TrackTruthInfo::GetG4TrajIDHits
    ///< 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 TSmrdIsoTrack::TrueId to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline truePDG   =
    ///<\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 TSmrdIsoTrack::TrueId to obtain the corresponding
    ///< ND::TG4Trajectory.
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline truePDG   =
    ///<\skipline TruePDG
    ///< 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 =
    ///< TSmrdIsoTrack::TrueId via TrackTruthInfo::GetG4TrajIDHits
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline trueId = TrackTruthInfo::GetG4TrajIDHits
    ///<\skipline isoTrack->TrueHitPurity

    double TrueHitEff; ///<For MC events: The 'completeness' of the ND::THits which make up  the corresponding ND::TReconTrack.
    ///<\details Compares to the ND::TG4Trajectory with Id =
    ///< TSmrdIsoTrack::TrueId via TrackTruthInfo::GetG4TrajIDHits
    ///<\dontinclude TSmrdReconModule.cxx
    ///<\skipline trueId = TrackTruthInfo::GetG4TrajIDHits
    ///<\skipline isoTrack->TrueHitEff

    ClassDef(TSmrdReconModule::TSmrdIsoTrack, 1);
  };

 public:
  TSmrdReconModule(const char *name = "SMRD",
                   const char *title = "SMRD Recon Module");
  virtual ~TSmrdReconModule();

  virtual Bool_t ProcessFirstEvent(ND::TND280Event &event);
  virtual Bool_t IsEnabledByDefault() const { return kTRUE; }

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

 public:
  Int_t fNSmrdReconHits;         ///< The number of SMRD TReconHits.
  TClonesArray *fSmrdReconHits;  ///< The SMRD TReconHits.

  Int_t fNSmrdIsoTracks;         ///< The number of SMRD isolated tracks.
  TClonesArray *fSmrdIsoTracks;  ///< The SMRD isolated tracks.

 private:
};

#endif