GRSISort "v4.0.0.5"
An extension of the ROOT analysis Framework
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
DirectoryHelper Class Reference

Detailed Description

Definition at line 14 of file DirectoryHelper.hh.

Public Types

using Result_t = std::map<std::string, TList>
 

Public Member Functions

 DirectoryHelper (TList *list)
 
ROOT::RDF::RResultPtr< std::map< std::string, TList > > Book (ROOT::RDataFrame *d) override
 
void CreateHistograms (unsigned int slot) override
 
void EndOfSort (std::shared_ptr< std::map< std::string, TList > > &list) override
 
void Exec (unsigned int slot, TGriffin &grif, TGriffinBgo &grifBgo)
 
void Finalize ()
 
std::string GetActionName () const
 
std::shared_ptr< std::map< std::string, TList > > GetResultPtr () const
 
void Initialize ()
 
void InitTask (TTreeReader *, unsigned int)
 
std::string & Prefix ()
 
std::string Prefix () const
 
void Prefix (const std::string &val)
 
virtual void Setup ()
 

Protected Member Functions

TPPG * Ppg ()
 
TRunInfo * RunInfo ()
 
TUserSettings * UserSettings ()
 

Protected Attributes

std::vector< TGRSIMap< std::string, GCube * > > fCube
 
std::map< std::string, TCutG * > fCuts
 
std::vector< TGRSIMap< std::string, TH1 * > > fH1
 
std::vector< TGRSIMap< std::string, TH2 * > > fH2
 
std::vector< TGRSIMap< std::string, TH3 * > > fH3
 
std::vector< std::shared_ptr< std::map< std::string, TList > > > fLists
 
std::vector< TGRSIMap< std::string, TObject * > > fObject
 
TPPG * fPpg {nullptr}
 
std::string fPrefix {"TGRSIHelper"}
 
TRunInfo * fRunInfo {nullptr}
 
std::vector< TGRSIMap< std::string, GHSym * > > fSym
 
std::vector< TGRSIMap< std::string, TTree * > > fTree
 
TUserSettings * fUserSettings {nullptr}
 

Private Member Functions

void CheckSizes (unsigned int slot, const char *usage)
 

Private Attributes

std::map< std::vector< double > > fLastSuppressedTime
 
std::map< std::vector< double > > fLastSuppressedTimeNoPileup
 
std::map< std::vector< double > > fLastSuppressedTS
 
std::map< std::vector< double > > fLastSuppressedTSNoPileup
 
std::map< std::vector< double > > fLastTime
 
std::map< std::vector< double > > fLastTimeNoPileup
 
std::map< std::vector< double > > fLastTS
 
std::map< std::vector< double > > fLastTSNoPileup
 

Static Private Attributes

static constexpr int fSizeLimit = 1073741822
 
+ Inheritance diagram for DirectoryHelper:
+ Collaboration diagram for DirectoryHelper:

Member Typedef Documentation

◆ Result_t

using TGRSIHelper::Result_t = std::map<std::string, TList>
inherited

This type is a requirement for every helper.

Definition at line 67 of file TGRSIHelper.h.

Constructor & Destructor Documentation

◆ DirectoryHelper()

DirectoryHelper::DirectoryHelper ( TList * list)
inlineexplicit

Definition at line 18 of file DirectoryHelper.hh.

References TGRSIHelper::Prefix(), and TGRSIHelper::Setup().

Member Function Documentation

◆ Book()

ROOT::RDF::RResultPtr< std::map< std::string, TList > > DirectoryHelper::Book ( ROOT::RDataFrame * )
inlineoverridevirtual

This method will call the Book action on the provided dataframe.

Reimplemented from TGRSIHelper.

Definition at line 25 of file DirectoryHelper.hh.

◆ CheckSizes()

void TGRSIHelper::CheckSizes ( unsigned int slot,
const char * usage )
privateinherited

check size of each object in the output list

Definition at line 215 of file TGRSIHelper.cxx.

References DRED, TGRSIHelper::fLists, TGRSIHelper::fSizeLimit, and RESET_COLOR.

Referenced by TGRSIHelper::Finalize(), and TGRSIHelper::Setup().

◆ CreateHistograms()

void DirectoryHelper::CreateHistograms ( unsigned int )
overridevirtual

Virtual helper function that the user uses to create their histograms.

Reimplemented from TGRSIHelper.

Definition at line 3 of file DirectoryHelper.cxx.

References TGRSIHelper::fH1, TGRSIHelper::fH2, fLastSuppressedTime, fLastSuppressedTimeNoPileup, fLastSuppressedTS, fLastSuppressedTSNoPileup, fLastTime, fLastTimeNoPileup, fLastTS, and fLastTSNoPileup.

◆ EndOfSort()

void DirectoryHelper::EndOfSort ( std::shared_ptr< std::map< std::string, TList > > & )
overridevirtual

This method gets called at the end of Finalize()

Reimplemented from TGRSIHelper.

Definition at line 104 of file DirectoryHelper.cxx.

◆ Exec()

void DirectoryHelper::Exec ( unsigned int slot,
TGriffin & grif,
TGriffinBgo & grifBgo )

Definition at line 50 of file DirectoryHelper.cxx.

References TGRSIHelper::fH1, TGRSIHelper::fH2, fLastSuppressedTime, fLastSuppressedTimeNoPileup, fLastSuppressedTS, fLastSuppressedTSNoPileup, fLastTime, fLastTimeNoPileup, fLastTS, fLastTSNoPileup, TGriffin::GetAddbackHit(), TGriffin::GetAddbackMultiplicity(), TGriffin::GetGriffinHit(), TGriffin::GetMultiplicity(), TGriffin::GetSuppressedAddbackHit(), TGriffin::GetSuppressedAddbackMultiplicity(), TGriffin::GetSuppressedHit(), and TGriffin::GetSuppressedMultiplicity().

◆ Finalize()

void TGRSIHelper::Finalize ( )
inherited

This required method is called at the end of the event loop. It is used to merge all the internal TLists which were used in each of the data processing slots.

This function merges all maps of lists into the map of the first slot (slot 0)

Definition at line 154 of file TGRSIHelper.cxx.

References TGRSIHelper::CheckSizes(), TGRSIHelper::EndOfSort(), and TGRSIHelper::fLists.

◆ GetActionName()

std::string TGRSIHelper::GetActionName ( ) const
inlineinherited

Definition at line 104 of file TGRSIHelper.h.

References TGRSIHelper::Prefix().

◆ GetResultPtr()

std::shared_ptr< std::map< std::string, TList > > TGRSIHelper::GetResultPtr ( ) const
inlineinherited

Definition at line 92 of file TGRSIHelper.h.

References TGRSIHelper::fLists.

◆ Initialize()

void TGRSIHelper::Initialize ( )
inlineinherited

Definition at line 94 of file TGRSIHelper.h.

◆ InitTask()

void TGRSIHelper::InitTask ( TTreeReader * ,
unsigned int  )
inlineinherited

Definition at line 93 of file TGRSIHelper.h.

◆ Ppg()

TPPG * TGRSIHelper::Ppg ( )
inlineprotectedinherited

Definition at line 43 of file TGRSIHelper.h.

References TGRSIHelper::fPpg.

Referenced by ExampleEventHelper::CreateHistograms().

◆ Prefix() [1/3]

std::string & TGRSIHelper::Prefix ( )
inlineinherited

Definition at line 40 of file TGRSIHelper.h.

References TGRSIHelper::fPrefix.

Referenced by AlphanumericHelper::AlphanumericHelper(), AngularCorrelationHelper::AngularCorrelationHelper(), ComptonPolarimetryHelper::ComptonPolarimetryHelper(), CrossTalkHelper::CrossTalkHelper(), DirectoryHelper(), EfficiencyHelper::EfficiencyHelper(), ExampleEventHelper::ExampleEventHelper(), ExampleFragmentHelper::ExampleFragmentHelper(), ExampleTreeHelper::ExampleTreeHelper(), GriffinKValueHelper::GriffinKValueHelper(), TimeWalkHelper::TimeWalkHelper(), TGRSIHelper::Book(), TGRSIHelper::CreateHistograms(), and TGRSIHelper::GetActionName().

◆ Prefix() [2/3]

std::string TGRSIHelper::Prefix ( ) const
inlineinherited

Definition at line 102 of file TGRSIHelper.h.

References TGRSIHelper::fPrefix.

◆ Prefix() [3/3]

void TGRSIHelper::Prefix ( const std::string & val)
inlineinherited

Definition at line 103 of file TGRSIHelper.h.

References TGRSIHelper::fPrefix.

◆ RunInfo()

TRunInfo * TGRSIHelper::RunInfo ( )
inlineprotectedinherited

Definition at line 44 of file TGRSIHelper.h.

References TGRSIHelper::fRunInfo.

◆ Setup()

void TGRSIHelper::Setup ( )
virtualinherited

This function builds the vectors of TLists and maps for 1D- and 2D-histograms. It calls the overloaded CreateHistograms functions in which the user can define their histograms. Then it adds all those histograms to the list of the corresponding slot.

Definition at line 71 of file TGRSIHelper.cxx.

References TGRSIHelper::CheckSizes(), TGRSIHelper::CreateHistograms(), TGRSIHelper::fCube, TGRSIHelper::fH1, TGRSIHelper::fH2, TGRSIHelper::fH3, TGRSIHelper::fLists, TGRSIHelper::fObject, TGRSIHelper::fSym, TGRSIHelper::fTree, TGRSIOptions::Get(), and TGRSIOptions::GetMaxWorkers().

Referenced by AlphanumericHelper::AlphanumericHelper(), AngularCorrelationHelper::AngularCorrelationHelper(), ComptonPolarimetryHelper::ComptonPolarimetryHelper(), CrossTalkHelper::CrossTalkHelper(), DirectoryHelper(), EfficiencyHelper::EfficiencyHelper(), ExampleEventHelper::ExampleEventHelper(), ExampleFragmentHelper::ExampleFragmentHelper(), ExampleTreeHelper::ExampleTreeHelper(), GriffinKValueHelper::GriffinKValueHelper(), and TimeWalkHelper::TimeWalkHelper().

◆ UserSettings()

TUserSettings * TGRSIHelper::UserSettings ( )
inlineprotectedinherited

Definition at line 45 of file TGRSIHelper.h.

References TGRSIHelper::fUserSettings.

Member Data Documentation

◆ fCube

std::vector<TGRSIMap<std::string, GCube*> > TGRSIHelper::fCube
protectedinherited

Definition at line 52 of file TGRSIHelper.h.

Referenced by TGRSIHelper::Setup().

◆ fCuts

std::map<std::string, TCutG*> TGRSIHelper::fCuts
protectedinherited

Definition at line 55 of file TGRSIHelper.h.

Referenced by TGRSIHelper::TGRSIHelper().

◆ fH1

std::vector<TGRSIMap<std::string, TH1*> > TGRSIHelper::fH1
protectedinherited

Definition at line 48 of file TGRSIHelper.h.

Referenced by ComptonPolarimetryHelper::CreateHistograms(), CrossTalkHelper::CreateHistograms(), CreateHistograms(), EfficiencyHelper::CreateHistograms(), ExampleEventHelper::CreateHistograms(), ExampleTreeHelper::CreateHistograms(), GriffinKValueHelper::CreateHistograms(), ComptonPolarimetryHelper::Exec(), CrossTalkHelper::Exec(), Exec(), EfficiencyHelper::Exec(), ExampleEventHelper::Exec(), ExampleTreeHelper::Exec(), GriffinKValueHelper::Exec(), and TGRSIHelper::Setup().

◆ fH2

std::vector<TGRSIMap<std::string, TH2*> > TGRSIHelper::fH2
protectedinherited

Definition at line 49 of file TGRSIHelper.h.

Referenced by AlphanumericHelper::CreateHistograms(), AngularCorrelationHelper::CreateHistograms(), ComptonPolarimetryHelper::CreateHistograms(), CrossTalkHelper::CreateHistograms(), CreateHistograms(), EfficiencyHelper::CreateHistograms(), ExampleEventHelper::CreateHistograms(), ExampleFragmentHelper::CreateHistograms(), ExampleTreeHelper::CreateHistograms(), GriffinKValueHelper::CreateHistograms(), TimeWalkHelper::CreateHistograms(), ExampleEventHelper::EndOfSort(), AlphanumericHelper::Exec(), AngularCorrelationHelper::Exec(), ComptonPolarimetryHelper::Exec(), CrossTalkHelper::Exec(), Exec(), EfficiencyHelper::Exec(), ExampleEventHelper::Exec(), ExampleFragmentHelper::Exec(), ExampleTreeHelper::Exec(), GriffinKValueHelper::Exec(), TimeWalkHelper::Exec(), and TGRSIHelper::Setup().

◆ fH3

std::vector<TGRSIMap<std::string, TH3*> > TGRSIHelper::fH3
protectedinherited

Definition at line 50 of file TGRSIHelper.h.

Referenced by TimeWalkHelper::CreateHistograms(), TimeWalkHelper::Exec(), and TGRSIHelper::Setup().

◆ fLastSuppressedTime

std::map<std::vector<double> > DirectoryHelper::fLastSuppressedTime
private

Definition at line 42 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastSuppressedTimeNoPileup

std::map<std::vector<double> > DirectoryHelper::fLastSuppressedTimeNoPileup
private

Definition at line 46 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastSuppressedTS

std::map<std::vector<double> > DirectoryHelper::fLastSuppressedTS
private

Definition at line 40 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastSuppressedTSNoPileup

std::map<std::vector<double> > DirectoryHelper::fLastSuppressedTSNoPileup
private

Definition at line 44 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastTime

std::map<std::vector<double> > DirectoryHelper::fLastTime
private

Definition at line 41 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastTimeNoPileup

std::map<std::vector<double> > DirectoryHelper::fLastTimeNoPileup
private

Definition at line 45 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastTS

std::map<std::vector<double> > DirectoryHelper::fLastTS
private

Definition at line 39 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLastTSNoPileup

std::map<std::vector<double> > DirectoryHelper::fLastTSNoPileup
private

Definition at line 43 of file DirectoryHelper.hh.

Referenced by CreateHistograms(), and Exec().

◆ fLists

std::vector<std::shared_ptr<std::map<std::string, TList> > > TGRSIHelper::fLists
protectedinherited

Definition at line 47 of file TGRSIHelper.h.

Referenced by TGRSIHelper::CheckSizes(), TGRSIHelper::Finalize(), TGRSIHelper::GetResultPtr(), and TGRSIHelper::Setup().

◆ fObject

std::vector<TGRSIMap<std::string, TObject*> > TGRSIHelper::fObject
protectedinherited

Definition at line 54 of file TGRSIHelper.h.

Referenced by AngularCorrelationHelper::CreateHistograms(), and TGRSIHelper::Setup().

◆ fPpg

TPPG* TGRSIHelper::fPpg {nullptr}
protectedinherited

Definition at line 56 of file TGRSIHelper.h.

Referenced by TGRSIHelper::Ppg().

◆ fPrefix

std::string TGRSIHelper::fPrefix {"TGRSIHelper"}
protectedinherited

Definition at line 59 of file TGRSIHelper.h.

Referenced by TGRSIHelper::Prefix(), TGRSIHelper::Prefix(), and TGRSIHelper::Prefix().

◆ fRunInfo

TRunInfo* TGRSIHelper::fRunInfo {nullptr}
protectedinherited

Definition at line 57 of file TGRSIHelper.h.

Referenced by TGRSIHelper::RunInfo().

◆ fSizeLimit

int TGRSIHelper::fSizeLimit = 1073741822
staticconstexprprivateinherited

! 1 GiB size limit for objects in ROOT

Definition at line 62 of file TGRSIHelper.h.

Referenced by TGRSIHelper::CheckSizes().

◆ fSym

std::vector<TGRSIMap<std::string, GHSym*> > TGRSIHelper::fSym
protectedinherited

Definition at line 51 of file TGRSIHelper.h.

Referenced by TGRSIHelper::Setup().

◆ fTree

std::vector<TGRSIMap<std::string, TTree*> > TGRSIHelper::fTree
protectedinherited

Definition at line 53 of file TGRSIHelper.h.

Referenced by ExampleTreeHelper::CreateHistograms(), ExampleTreeHelper::Exec(), and TGRSIHelper::Setup().

◆ fUserSettings

TUserSettings* TGRSIHelper::fUserSettings {nullptr}
protectedinherited

Definition at line 58 of file TGRSIHelper.h.

Referenced by AngularCorrelationHelper::AngularCorrelationHelper(), ComptonPolarimetryHelper::ComptonPolarimetryHelper(), and TGRSIHelper::UserSettings().