Reader for diana and apollo root files. More...

Inheritance diagram for MRootFileReader:

Public Member Functions
virtual void	Init (Diana::QEventAssembler &eva)
	Init method is called before event loop. More...

virtual bool	Do (Diana::QEventAssembler &eva)
	Do method is called for each event. More...

virtual void	Done ()
	Done method is called after event loop. More...

const QError &	JumpToEvent (Long64_t event)
	Jump to particular event in the loop. More...

Public Member Functions inherited from QRootFileReaderBase
virtual	~QRootFileReaderBase ()

virtual void	SetBranches (Diana::QEventAssembler &eva)
	Set the branch caches. More...

Private Attributes
TFile *	fRootInput
	Pointer to the currently open ROOT file. More...

TEntryList *	fEntryList
	??? More...

Long64_t	fEntryListEntry
	Entry in the loop if a Cut is specified. More...

Long64_t	fFileCounter
	Variable for storing file counter in order to check if file changes. More...

Friends
class	MLightRootFileReader

Additional Inherited Members
Protected Member Functions inherited from QRootFileReaderBase
virtual void	LoadQChain ()
	Build a QChain. More...

virtual void	AddToEvent (const char brname, Diana::QObject *evData, Diana::QEventAssembler &eva)
	Add an object from a branch to the event. More...

virtual std::vector< TBranch * >	GetBranches (QChain *chain, Diana::QEventAssembler &eva)
	Get a list of the branches needed by the event. More...

Protected Attributes inherited from QRootFileReaderBase
QChain *	fChain
	Pointer to the QChain built by LoadQChain() More...

Long64_t	fEvents
	Total number of events in fChain. More...

Long64_t	fEventNumber
	Current event number in the loop. More...

bool	fDeleteInput
	Flag to delete the input files. More...

bool	fInclusive
	Flag to automatically include ALL branches. More...

std::map< std::string, Diana::QObject ** >	fObjectList
	??? More...

Detailed Description

Reader for diana and apollo root files.

Author: Marco Vignati

Reads single or multiple ROOT data files containing QTrees.

Config example:

  reader RootFileReader
  verbosity = debug
  enable = true
  InputFile= test.root
  EventNumberPrintStep = 10000
  endmod

Parameters (inherited parameters can be found in QReader):

InputFile[string = NODEFAULT]: single input ROOT file (test.root) or file list (test.list). The list file is something like:

   # comment
   DATAPATH /path/to/your/data
   START
   testraw_000810_C_p001.root
   # another comment
   testraw_000810_C_p002.root
   testraw_000810_C_p003.root
   END 
   testraw_000810_C_p004.root

Optional parameters:
- DeleteInputFiles [ bool = false]: delete input files once all events have been read.
- Cut [ string = "" ]: select entries that match the string cut. For example, to select only signal events on channel 1:
```
   Cut = DAQ@PulseInfo.IsSignal && DAQ@PulseInfo.fChannelId == 1
   
```
  or, if aliases are defined in the input files:
```
   Cut = IsSignal && Channel == 1
   
```
- InclusiveMode [ bool = true]: if true all the event QObjects are loaded, if false no event member is loaded. The single QObjects in the QEvent can be loaded/unloaded adding the parameter "MemberLabel = true/false". For example to enable only basic raw data members:
```
   InclusiveMode = false
   DAQ@Header = true
   DAQ@PulseInfo = true
   
```
  or, to enable everything but the raw samples:
```
   InclusiveMode = true
   DAQ@Pulse = false
   
```
All QObjects that are required (see QEvent::Require) by other modules in the sequence are automatically loaded, irrespective of the cfg directives. If all the modules in the sequence require their QObjects one can set InclusiveMode = false without specifying the options MemberLabel = true/false. In this way only needed quantities are loaded from input files, improving the performances. This option can be efficiently combined with the "AppendToInput" option of MRootFileWriter.
Reads:
- ROOT file(s) with QTree named "qtree" and TBranches of QObjects with names (owner@name.). Branches in trees friend of "qtree" are included.
Writes:
- QEvent

Definition at line 84 of file MRootFileReader.hh.

Member Function Documentation

◆ Do()

bool MRootFileReader::Do ( Diana::QEventAssembler & eva )

virtual

Do method is called for each event.

Loads the next entry in the loop. Checks to see if a new file has been opened, and if so calls OpenNewFile().

Definition at line 88 of file MRootFileReader.cc.

◆ Done()

void MRootFileReader::Done ( )

virtual

Done method is called after event loop.

Delete the chain, delete the input if requested.

Definition at line 123 of file MRootFileReader.cc.

◆ Init()

void MRootFileReader::Init ( Diana::QEventAssembler & eva )

virtual

Init method is called before event loop.

Reads the config parameters, calls LoadQChain(). Calls SetBranches(). And then loads the aliases.

Definition at line 25 of file MRootFileReader.cc.

References QAliases::Add(), and QEventAssembler::GetAliases().

◆ JumpToEvent()

const QError & MRootFileReader::JumpToEvent ( Long64_t event )

virtual

Jump to particular event in the loop.

Reimplemented from QRootFileReaderBase.

Definition at line 139 of file MRootFileReader.cc.

References QRootFileReaderBase::JumpToEvent(), and QERR_NOT_IMPLEMENTED.

Friends And Related Function Documentation

◆ MLightRootFileReader

friend class MLightRootFileReader

friend

Definition at line 125 of file MRootFileReader.hh.

Member Data Documentation

◆ fEntryList

TEntryList* MRootFileReader::fEntryList

private

???

Entry list if a custom Cut is specified

Definition at line 119 of file MRootFileReader.hh.

◆ fEntryListEntry

Long64_t MRootFileReader::fEntryListEntry

private

Entry in the loop if a Cut is specified.

Definition at line 121 of file MRootFileReader.hh.

◆ fFileCounter

Long64_t MRootFileReader::fFileCounter

private

Variable for storing file counter in order to check if file changes.

Definition at line 123 of file MRootFileReader.hh.

◆ fRootInput

TFile* MRootFileReader::fRootInput

private

Pointer to the currently open ROOT file.

Definition at line 115 of file MRootFileReader.hh.

The documentation for this class was generated from the following files:

pkg/rootrw/MRootFileReader.hh
pkg/rootrw/MRootFileReader.cc

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Do()

◆ Done()

◆ Init()

◆ JumpToEvent()

Friends And Related Function Documentation

◆ MLightRootFileReader

Member Data Documentation

◆ fEntryList

◆ fEntryListEntry

◆ fFileCounter

◆ fRootInput