TBasicHeaderModule.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.
///
/// 23-May-2014: Current responsible for this module is,
/// Luke Pickering (lp208 [*a*t*] ic.ac.uk)
#ifndef TBasicHeaderModule_hxx_seen
#define TBasicHeaderModule_hxx_seen
#include <TNamed.h>
#include <TRef.h>
#include <TTree.h>
#include <TFieldManager.hxx>
#include <TND280Event.hxx>
#include <TOAMagneticField.hxx>
#include <string>
#include "TAnalysisHeaderModuleBase.hxx"
#include "TG4PrimaryParticle.hxx"
#include "TGeomInfo.hxx"
namespace ND {
  class TBasicHeaderModule;
};
/// An analysis module which carries some simple event-level header
/// information. It contains the RunID, EventNumber, and a TRef reference
/// back to the original event file. The latter does not work at this time.
class ND::TBasicHeaderModule : public TAnalysisHeaderModuleBase {
public:
  TBasicHeaderModule(const char *name = "BasicHeader",
    const char *title = "Basic Header Module");
  virtual ~TBasicHeaderModule();
  virtual Bool_t IsEnabledByDefault() const { return kTRUE; }
  void SayAvailableOpts(std::string indent = "") {
    std::cout << indent
              << "={software_version}: Will save software version as determined by\n"
              << indent << "\t$ND280ROOT (cmt) \n"
              << indent << "\t or \n "
              << indent << "\t$ND280SOFTWAREMASTERROOT (cmake) \n"
              << indent << "=noVersion: Will not save software version\n"
              << indent << "=OverrideSWVersion_<n>: Will save software version as\n"
              << indent
              << "\tn, useful for developing versioned upstream \n"
              << indent << "\tcode. This overrides TBasicHeaderModule=software_version"
              << std::endl;
  }
  UInt_t GetEventTime() { return fEventTime; }
  virtual Bool_t ProcessFirstEvent(ND::TND280Event &);
  Bool_t P0DWaterStatus();
  Bool_t Configure(std::string &);
protected:
  virtual void InitializeBranches();
  virtual bool FillTree(ND::TND280Event &);
public:
//*******************Tree Entries********************
///\short Time of the relevant ND::TND280Event's last GPS pulse in Unix time.
///\details Revtrieved from the ND::TND280Event header like
///\dontinclude TBasicHeaderModule.cxx
///\skipline GetMCMSecond
  UInt_t fEventTime; ///< Time of the relevant ND::TND280Events last GPS pulse in Unix time.
///\short Bits containing various information from the MCMs including
/// event/spill numbers and trigger flags.
///\details For bit definitions see ND::TND280Event::Header::GetTriggerWord
///\dontinclude TBasicHeaderModule.cxx
///\skipline GetTriggerWord
  ULong64_t fTriggerWord; ///< Information from the MCMs 
/// FGD Cosmic trigger flag.
/// Uses bits from TBasicHeaderModule::fTriggerWord
///\dontinclude TBasicHeaderModule.cxx
///\skipline ULong64_t shift
///\skipline shift&fTriggerWord
  Bool_t fFGDCosmicEvent; ///< FGD Cosmic trigger flag.
/// TRIP-t Cosmic trigger flag.
/// Uses bits from TBasicHeaderModule::fTriggerWord
///\dontinclude TBasicHeaderModule.cxx
///\skip shift&fTriggerWord
///\skip shift =
///\until shift&fTriggerWord
  Bool_t fTripTCosmicEvent; ///< TRIP-t Cosmic trigger flag.
/// Contains the bit patterns from the cosmic trigger module.
///\dontinclude TBasicHeaderModule.cxx
///\skip ULong64_t shift
///\skip for
///\until }
  ULong64_t fCTMTriggerPattern[3]; ///< Bit patterns from the cosmic trigger module.
/// TripT Cosmic Trigger type: trigger codes from 0-14, -1 means off.
///\dontinclude TBasicHeaderModule.cxx
///\skip fTripTCosmicTriggerType =
///\skip if
///\until }
/// From comments in <b>cosmicTriggerGeant4Sim/src/TTripTTrigger.cxx:1196</b>\n
/// Value corresponds to which "detector walls" were hit:
///  <ul><li>-1. Unused</li>
///  <li>0. Top and Bottom</li>
///  <li>1. Top and Left</li>
///  <li>2. Top and Right</li>
///  <li>3. Left and Bottom</li>
///  <li>4. Top and Bottom</li>
///  <li>5. Left and Right</li>
///  <li>6. Top and Front(P0D)</li>
///  <li>7. Top and End(DsECal)</li>
///  <li>8. Left and Front(P0D)</li>
///  <li>9. Left and End(DsECal)</li>
///  <li>10. Right and Front(P0D)</li>
///  <li>11. Right and End(DsECal)</li>
///  <li>12. Front and Bottom</li>
///  <li>13. End(DsECal) and Back</li>
///  <li>14. Front(P0D) and End(DsECal)</li></ul>
  Int_t fTripTCosmicTriggerType; ///< TripT Cosmic Trigger type:
/// If cosmic muon is detmined to be *upward going*, 0 or 1.
///\dontinclude TBasicHeaderModule.cxx
///\skip fTripTCosmicTriggerUpward =
///\skip if
///\until ;
  Int_t fTripTCosmicTriggerUpward; ///< If cosmic muon is detmined to be *upward going*, 0 or 1.
/// MC event weighting to correct for differences between cosmic MC and data.
/// Weights individual cosmic trigger configurations, e.g. SMRD Primitive 5 +
/// DsECal Primitive 32.
/// See
/// http://www.t2k.org/nd280/physics/cosmics/meetings/May09/Clarkprescale
/// for detailed explanation.
///\dontinclude TBasicHeaderModule.cxx
///\skip fCosmicPrescaleWeight =
///\until }
  Double_t fCosmicPrescaleWeight; ///< MC event weighting to correct for differences between cosmic MC and data.
/// Event Spill number.
/// Retrieved from ND::TND280Context::GetSpill
  Int_t fSpill; ///< Spill number
/// The subdetector configuration in which the data was taken
/// Valid values are defined in ND::TND280Context as
/// <ul><li>kGlobalPartition = 1</li>
/// <li>kP0DClockPresent = 1<<1</li>
/// <li>kTPCClockPresent = 1<<2</li>
/// <li>kFGDClockPresent = 1<<3</li>
/// <li>kECalClockPresent = 1<<4</li>
/// <li>kSMRDClockPresent = 1<<5</li>
/// <li>kINGRIDClockPresent = 1<<6</li>
/// <li>kMCData = 1<<16</li> </ul>
  Int_t fPartition; ///< subdetector configuration 
/// The unix time stamp of the event context.
/// Retrieved from ND::TND280Context::GetTimeStamp
  Int_t fTimeStamp; ///< unix time stamp of the event 
/// Whether this is detector data.
/// Retrieved from ND::TND280Context::IsDetector
  Bool_t fIsDetector; ///< Whether this is detector data.
/// Whether this is an MC event.
/// Retrieved from ND::TND280Context::IsMC
  Bool_t fIsMC; ///< Whether this is an MC event
/// Whether this is a Sand Muon MC event.
/// Calculated from the run number, assumes that it of the form described in
/// http://www.t2k.org/nd280/datacomp/production005/mcp/sand_mc\n
/// Run Number 9ABCDEEE, where <tt>IsSand = true</tt> if
///<tt>fIsMC == true</tt> and <tt>D == 7</tt>.
///\warning This is no longer definite as the Gas Interaction control sample
/// uses <tt>D == 7</tt>. This branch will be turned off for now. 2015-3-30
  Bool_t fIsSand; ///<  Whether this is a Sand Muon MC event.
/// Whether the P0D is filled with water or not.
/// Ascertained by querying the geometry.
///\dontinclude TBasicHeaderModule.cxx
///\skip bool ND::TBasicHeaderModule::P0DWaterStatus
///\until else
///\until }
  Bool_t fP0DWaterStatus; ///< Whether the P0D is filled with water or not.
/// Event Geometry SHA1 Hash (ID)
  UInt_t fGeometryHash[5]; ///< Event Geometry SHA1 Hash
/// Event Alignment SHA1 Hash (ID)
/// The alignment identifier is a SHA1 hash code of the alignment constants
/// plus a documentation string.
  UInt_t fAlignmentId[5]; ///< Event Alignment SHA1 Hash (ID)
/// MC "intensity", will be 0 if unused.
/// The intensity corresponds to Protons/Spill for Beam MC.
  Float_t fMCIntensity; ///<The intensity corresponds to Protons/Spill for Beam MC.
/// The software version string.
/// If -O TBasicHeaderModule=*version* is passed on the CLI then this will get
/// its value from the envvar $ND280ROOT
/// If -O TBasicHeadModule=OverrideSWVersion_v123r456p789 is passed on the CLI
/// then this will be set to v123r456p789.
///\note The OverrideVersion version will take precedence.
  Char_t fSoftwareVersion[50]; ///< The  nd280  software version
/// Holder for the Software Override Version String
  std::string fSoftwareOverrideVersionString; ///< Software Override Version
/// The magnetic field strength at the center of TPC1.
///\dontinclude TBasicHeaderModule.cxx
///\skip fMagneticFieldStrength =
///\until ;
  Double_t fMagneticFieldStrength; ///< magnetic field strength at the center of TPC1.
private:
/// Whether we are saving the software version from $ND280ROOT.
  bool fSoftware;
/// Whether we are using a supplied software version. Will override fSoftware.
  Bool_t fSoftwareUseOverrideVersion;
/// Whether we have found the version already, so no need to do it again.
  bool fFoundSoftwareVersion;
};
#endif