ReadTriggerSegments Class Reference

Access segments in trigger files. More...

#include <ReadTriggerSegments.h>

Inheritance diagram for ReadTriggerSegments:
Inheritance graph
[legend]
Collaboration diagram for ReadTriggerSegments:
Collaboration graph
[legend]

List of all members.

Public Member Functions

double * GetFileStarts (void)
 Returns the list of file time starts.
double * GetFileStops (void)
 Returns the list of file time stops.
int GetNFiles (void)
 Returns the number of input files.
int GetNTrees (void)
 Returns the number of input segments trees.
SegmentsGetSegments (void)
 Returns the list of trigger segments.
bool GetStatus (void)
 Returns the general status of the ReadTriggerSegments object.
double GetTimeMax (void)
 Returns the ending time.
double GetTimeMin (void)
 Returns the starting time.
double * GetTreeStarts (void)
 Returns the list of file time starts.
double * GetTreeStops (void)
 Returns the list of file time stops.
string GetTriggerFiles (Segments *aSegSelect)
 Returns the list of input files which contain data in a given segment list.
string GetTriggerFiles (const double aTimeMin, const double aTimeMax)
 Returns the list of input files which contain data in a given time range.
int GetTriggerID (void)
 Returns a unique ID for this trigger set.
string GetTriggerStringID (void)
 Returns a unique ID for this trigger set.
bool SetNewPattern (const string aPattern)
 Sets a new input file pattern.
void SetVerbose (const int aVerbose)
 Sets verbosity level.
Constructors and destructors



 ReadTriggerSegments (const string aPattern, const string aDirectory="", const int aVerbose=0)
 Constructor of the ReadTriggerSegments class.
virtual ~ReadTriggerSegments (void)
 Destructor of the ReadTriggerSegments class.

Protected Attributes

string Dir
 directory
string Pattern
 pattern of input root files
int randid
 random integer id
SegmentsSeg
 trigger segments
string srandid
 random string id
bool status_OK
 status
vector< string > triggerfilename
 root file names (paths)
double * Tstart
 file starts (min start)
double * Tstop
 file stops (max end)
int Verbose
 verbosity level

Detailed Description

Access segments in trigger files.

This class is a sub-product of the ReadTriggers class. It should be used when you're only interested by the segment content of trigger files. Only the segment content of the files is loaded so this class is much faster than the ReadTriggers class since the triggers are never loaded. This is quite useful when hundreds of files need to be scanned only to access the timing information.

IMPORTANT: the input files in 'apattern' should be time-sorted and with NO overlap

IMPORTANT_2: the segments in the trigger files must follow the GWOLLUM convention for triggers.

Author:
Florent Robinet

Constructor & Destructor Documentation

ReadTriggerSegments::ReadTriggerSegments ( const string  aPattern,
const string  aDirectory = "",
const int  aVerbose = 0 
)

Constructor of the ReadTriggerSegments class.

The segments in files designated by the file pattern 'aPattern' are loaded. The segment tree is accessed in the root directory 'aDirectory'. The verbosity level, set by 'aVerbose', follows the GWOLLUM convention for verbosity.

IMPORTANT: the input files in 'aPattern' should be time-sorted and with NO overlap

Parameters:
aPattern input file pattern
aDirectory trigger ROOT directory
aVerbose verbosity level
ReadTriggerSegments::~ReadTriggerSegments ( void   )  [virtual]

Destructor of the ReadTriggerSegments class.


Member Function Documentation

double* ReadTriggerSegments::GetFileStarts ( void   )  [inline]

Returns the list of file time starts.

DO NOT DELETE OR MODIFY

double* ReadTriggerSegments::GetFileStops ( void   )  [inline]

Returns the list of file time stops.

DO NOT DELETE OR MODIFY

int ReadTriggerSegments::GetNFiles ( void   )  [inline]

Returns the number of input files.

int ReadTriggerSegments::GetNTrees ( void   )  [inline]

Returns the number of input segments trees.

Segments* ReadTriggerSegments::GetSegments ( void   )  [inline]

Returns the list of trigger segments.

DO NOT DELETE OR MODIFY

bool ReadTriggerSegments::GetStatus ( void   )  [inline]

Returns the general status of the ReadTriggerSegments object.

double ReadTriggerSegments::GetTimeMax ( void   )  [inline]

Returns the ending time.

double ReadTriggerSegments::GetTimeMin ( void   )  [inline]

Returns the starting time.

double* ReadTriggerSegments::GetTreeStarts ( void   )  [inline]

Returns the list of file time starts.

DO NOT DELETE OR MODIFY

double* ReadTriggerSegments::GetTreeStops ( void   )  [inline]

Returns the list of file time stops.

DO NOT DELETE OR MODIFY

string ReadTriggerSegments::GetTriggerFiles ( Segments aSegSelect  ) 

Returns the list of input files which contain data in a given segment list.

The returned list is a string where file paths are separated by a white space. If no file is found, "none" is returned.

Parameters:
aSegSelect segment list
string ReadTriggerSegments::GetTriggerFiles ( const double  aTimeMin,
const double  aTimeMax 
)

Returns the list of input files which contain data in a given time range.

This list is a string where file paths are separated by a white space. If no file is found, "none" is returned.

Parameters:
aTimeMin starting time
aTimeMax ending time
int ReadTriggerSegments::GetTriggerID ( void   )  [inline]

Returns a unique ID for this trigger set.

string ReadTriggerSegments::GetTriggerStringID ( void   )  [inline]

Returns a unique ID for this trigger set.

bool ReadTriggerSegments::SetNewPattern ( const string  aPattern  ) 

Sets a new input file pattern.

This function resets the ReadTriggerSegments object to introduce a new list of files given by 'aPattern'.

Parameters:
aPattern new input file pattern

Reimplemented in ReadTriggerMetaData, and ReadTriggers.

void ReadTriggerSegments::SetVerbose ( const int  aVerbose  )  [inline]

Sets verbosity level.

Parameters:
averbose new verbosity level

Member Data Documentation

string ReadTriggerSegments::Dir [protected]

directory

string ReadTriggerSegments::Pattern [protected]

pattern of input root files

int ReadTriggerSegments::randid [protected]

random integer id

trigger segments

string ReadTriggerSegments::srandid [protected]

random string id

status

vector<string> ReadTriggerSegments::triggerfilename [protected]

root file names (paths)

double* ReadTriggerSegments::Tstart [protected]

file starts (min start)

double* ReadTriggerSegments::Tstop [protected]

file stops (max end)

verbosity level


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Friends Defines

Generated on 29 Sep 2016 by  doxygen 1.6.1