ReadTriggerMetaData Class Reference

Access metadata in trigger files. More...

#include <ReadTriggerMetaData.h>

Inheritance diagram for ReadTriggerMetaData:

Collaboration diagram for ReadTriggerMetaData:

Public Member Functions
double	GetFrequencyMax (void)
	Returns the absolute maximum frequency [Hz].
double	GetFrequencyMin (void)
	Returns the absolute minimum frequency [Hz].
string	GetProcessName (void)
	Returns the process name.
string	GetProcessUser (void)
	Returns the process user name.
string	GetProcessVersion (void)
	Returns the process version.
double	GetQMax (void)
	Returns the absolute maximum Q value.
double	GetQMin (void)
	Returns the absolute minimum Q value.
double	GetSnrMax (void)
	Returns the absolute maximum SNR value.
double	GetSnrMin (void)
	Returns the absolute minimum SNR value.
bool	GetStatus (void)
	Returns the object status.
string	Merge (const string aOutputDirectory, const bool aTestUniform=true)
	Merge all input files into one single file.
Constructors and destructors
	ReadTriggerMetaData (const string aPattern, const string aDirectory="", const unsigned int aVerbose=0)
	Constructor of the ReadTriggerMetaData class.
virtual	~ReadTriggerMetaData (void)
	Destructor of the ReadTriggerMetaData class.
Public Member Functions inherited from GwollumOptions
void	Add (const string aTag, const string aKey, const double aDefaultValue, const unsigned int aSize=0)
	Adds an option to the list (double).
void	Add (const string aTag, const string aKey, const int aDefaultValue, const unsigned int aSize=0)
	Adds an option to the list (int).
void	Add (const string aTag, const string aKey, const string aDefaultValue, const unsigned int aSize=0)
	Adds an option to the list (string).
void	Add (const string aTag, const string aKey, const unsigned int aDefaultValue, const unsigned int aSize=0)
	Adds an option to the list (unsigned int).
void	AddOptionValue (const string aTag, const string aKey, const double aValue)
	Appends a value to a variable-size option (double).
void	AddOptionValue (const string aTag, const string aKey, const int aValue)
	Appends a value to a variable-size option (int).
void	AddOptionValue (const string aTag, const string aKey, const string aValue)
	Appends a value to a variable-size option (string).
void	AddOptionValue (const string aTag, const string aKey, const unsigned int aValue)
	Appends a value to a variable-size option (unsigned int).
void	Copy (GwollumOptions *aG)
	Copies an external GwollumOptions object into this.
void	FillTree (void)
	Saves options in a TTree.
double	GetOptionDefaultD (const unsigned int aOptionIndex)
	Returns an option default value.
int	GetOptionDefaultI (const unsigned int aOptionIndex)
	Returns an option default value.
string	GetOptionDefaultS (const unsigned int aOptionIndex)
	Returns an option default value.
unsigned int	GetOptionDefaultU (const unsigned int aOptionIndex)
	Returns an option default value.
unsigned int	GetOptionIndex (const string aTag, const string aKey)
	Returns the option index.
string	GetOptionKey (const unsigned int aOptionIndex)
	Returns an option key.
unsigned int	GetOptionNumberOfValues (const string aTag, const string aKey)
	Returns the option number of values.
unsigned int	GetOptionSize (const string aTag, const string aKey)
	Returns the option size.
unsigned int	GetOptionSize (const unsigned int aOptionIndex)
	Returns an option size.
unsigned int	GetOptionsN (void)
	Returns the number of options.
string	GetOptionTag (const unsigned int aOptionIndex)
	Returns an option tag.
char	GetOptionType (const string aTag, const string aKey)
	Returns the option type.
char	GetOptionType (const unsigned int aOptionIndex)
	Returns an option type.
double	GetOptionValueD (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (double).
bool	GetOptionValueD (double &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (double).
int	GetOptionValueI (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (int).
bool	GetOptionValueI (int &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (int).
string	GetOptionValueS (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (string).
bool	GetOptionValueS (string &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (string).
vector< double >	GetOptionValuesD (const string aTag, const string aKey)
	Returns the list of option values (double).
vector< int >	GetOptionValuesI (const string aTag, const string aKey)
	Returns the list of option values (int).
vector< string >	GetOptionValuesS (const string aTag, const string aKey)
	Returns the list of option values (string).
vector< unsigned int >	GetOptionValuesU (const string aTag, const string aKey)
	Returns the list of option values (unsigned int).
unsigned int	GetOptionValueU (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (unsigned int).
bool	GetOptionValueU (unsigned int &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (unsigned int).
bool	Is (const string aTag, const string aKey)
	Checks whether an option exists.
bool	IsProvided (const string aTag, const string aKey)
	Checks whether an option was provided.
bool	IsTheSame (GwollumOptions *aG)
	Checks whether two GwollumOptions objects are identical.
bool	ReadChain (bool &aIsUniform, TChain *aChain)
	Reads options from a TChain.
unsigned int	ReadTextFile (const string aOptionFile)
	Reads an option file and extract the list of options.
bool	ReadTree (const string aRootFileName, const string aTreeName)
	Reads options from a TTree in a ROOT file.
bool	ReadTree (TTree *aTree)
	Reads options from a TTree.
void	RemoveOption (const string aTag, const string aKey)
	Removes an option.
void	Reset (void)
	Resets the list of options.
void	ResetOption (const string aTag, const string aKey)
	Resets the list of option values.
void	SetDefault (const string aTag, const string aKey)
	Sets an option to default value.
void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const double aValue)
	Sets a value of an option (double).
void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const int aValue)
	Sets a value of an option (int).
void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const string aValue)
	Sets a value of an option (string).
void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const unsigned int aValue)
	Sets a value of an option (unsigned int).
void	WriteH5 (H5::H5File *aFile, H5::DataSpace &aDataSpace)
	Writes the options as attributes in a hdf5 file.
void	WriteTextFile (const string aFileName)
	Writes all options in a text file.
void	WriteTree (const string aTreeName)
	Writes the option TTree in a TFile.
void	WriteTree (const string aTreeName, const string aRootFileName, const string aSubDirectory="")
	Writes the option TTree in a TFile.
	GwollumOptions (void)
	Constructor of the GwollumOptions class.
virtual	~GwollumOptions (void)
	Destructor of the GwollumOptions class.
Public Member Functions inherited from Segments
bool	AddSegment (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Adds a segment to the list.
bool	AddSegments (Segments *aSeg)
	Adds a segment list to the list.
bool	Append (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Appends a segment to the list.
bool	Append (Segments *aSeg)
	Appends segments to the list.
bool	Append (TTree *aSegmentTree)
	Appends segments to the list.
bool	Append (vector< double > aGpsStarts, vector< double > aGpsEnds, vector< double > aTags)
	Appends segments to the list.
bool	ApplyPadding (const double aPadStart, const double aPadEnd)
	Apply a padding to all segments.
void	Dump (unsigned int aNcols=2, const string aTxtFileName="")
	Dumps the current segment list in the standard output or in a file.
double	GetDuration (const unsigned int aSegmentIndex=0)
	Returns the duration of a given segment.
double	GetEnd (const unsigned int aSegmentIndex=0)
	Returns the ending time of a given segment.
vector< double >	GetEnds (void)
	Returns the list of segment ends.
double	GetFirst ()
	Returns the starting time of the first segment.
TH1I *	GetHisto (const double aOffset=0.0)
	Returns an histogram representing the segments.
TH1I *	GetHistogram (const double aGpsStart, const double aGpsEnd, const double aOffset=0.0)
	Returns an histogram representing the segments.
double	GetLast ()
	Returns the ending time of the last segment.
double	GetLiveTime (const double aGpsStart, const double aGpsEnd)
	Returns the livetime between two GPS times.
double	GetLiveTime (const unsigned int aSegmentIndex)
	Returns the livetime of one segment.
double	GetLiveTime (void)
	Returns the total livetime.
double	GetLiveTimeWithTag (const int aTag)
	Returns the livetime for segments with a given tag.
unsigned int	GetN (void)
	Returns the number of time segments in the list.
unsigned int	GetNWithTag (const int aTag)
	Returns the number of time segments in the list with a given tag.
int	GetSegmentStartBefore (const double aGps)
	Returns the segment starting just before a given GPS time.
double	GetStart (const unsigned int aSegmentIndex=0)
	Returns the starting time of a given segment.
vector< double >	GetStarts (void)
	Returns the list of segment starts.
bool	GetStatus (void)
	Returns the class status.
int	GetTag (const unsigned int aSegmentIndex=0)
	Returns the tag of a given segment.
vector< int >	GetTags (void)
	Returns the list of segment tags.
TTree *	GetTree (const double aGpsStart, const double aGpsEnd)
	Returns a formatted TTree representing the segments.
TTree *	GetTree (void)
	Returns a formatted TTree representing the segments.
bool	Intersect (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Intersects with a segment.
bool	Intersect (Segments *aSeg)
	Intersects with a segment list.
bool	IsInsideSegment (const double aGps)
	Checks whether a given GPS time is inside a segment of the list.
bool	IsInsideSegment (unsigned int &aSegmentIndex, const double aGps)
	Checks whether a given GPS time is inside a segment of the list.
bool	MakeSecond (void)
	Rounds segment boundaries to integer seconds.
void	Reset (void)
	Resets the segment list.
bool	Reverse (void)
	Reverses the segment list.
void	SetTag (const unsigned int aSegmentIndex, const int aTag)
	Tags a given segment.
void	SetTags (const int aTag)
	Tags all segments.
bool	TruncateAfter (const double aGps)
	Removes segments after a given time.
bool	TruncateBefore (const double aGps)
	Removes segments before a given time.
	Segments (void)
	Default constructor of the Segments class.
	Segments (const string aSegmentFile, const int aDefaultTag=1)
	Constructor of the Segments class.
	Segments (TTree *aSegmentTree)
	Constructor of the Segments class.
	Segments (const string aFilePattern, const string aDirectory, const string aTreeName)
	Constructor of the Segments class.
	Segments (const vector< double > aGpsStarts, const vector< double > aGpsEnds)
	Constructor of the Segments class.
	Segments (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Constructor of the Segments class.
virtual	~Segments (void)
	Destructor of the Segments class.
Public Member Functions inherited from Streams
void	GetDetectorAMResponse (double &aFplus, double &aFcross, const double aRa, const double aDec, const double aPsi, const double aGmst)
	Computes antenna factors \(F_+\) and \(F_\times\).
unsigned int	GetDetectorIndex (void)
	Returns the detector index for this stream.
string	GetDetectorPrefix (void)
	Returns the detector prefix for this stream.
string	GetDirectory (const string aOutDir=".")
	Returns the stream directory.
double	GetLocalTime (const double aRa, const double aDec, const double aGeocentricTime)
	Converts the geocentric time to the detector local time [s].
string	GetName (void)
	Returns the stream full name.
string	GetNameConv (void)
	Returns the stream name using the LIGO-Virgo file name convention.
string	GetNamePrefix (void)
	Returns the stream name prefix.
string	GetNameSuffix (void)
	Returns the stream name suffix.
string	GetNameSuffixUnderScore (void)
	Returns the stream name suffix with only underscores.
TH2D *	GetSkyAntennaFactor (const unsigned int aGpsTime)
	Returns the sky map of the detector antenna factor for a given time.
bool	GetSkyRingPoint (double &aThetaS, double &aPhiS, const double aGmst, const double aDeltaT, const double aOmegaS, Streams *aDprime)
	Returns the sky position of a GW signal when detected by two detectors.
bool	GetSkyRingPointRaDec (double &aDecS, double &aRaS, const double aGmst, const double aDeltaT, const double aOmegaS, Streams *aDprime)
	Returns the sky position of a GW signal when detected by two detectors (radec).
string	GetTriggerFileName (const unsigned int aGpsStart, const unsigned int aDuration, const string aFileFormat="root", const string aProcessName="PROC", const string aOutDir=".")
	Returns the stream trigger file name.
void	SetName (const string aName)
	Sets a new name to the stream.
	Streams (const string aName, const unsigned int aVerbose=0)
	Constructor of the Streams class.
virtual	~Streams (void)
	Destructor of the Streams class.
Public Member Functions inherited from Sample
double	GetHighPassFrequency (void)
	Returns the current highpass frequency.
unsigned int	GetNativeFrequency (void)
	Returns the current native sampling frequency [Hz].
bool	GetStatus (void)
	Returns the class status.
unsigned int	GetWindowSize (void)
	Returns the window size (=0 if no windowing).
unsigned int	GetWorkingFrequency (void)
	Returns the current working sampling frequency [Hz].
void	SetDCRemoval (const bool aDCremove=true)
	Activates/Deactivates the DC removal.
bool	SetFrequencies (const unsigned int aNativeFrequency, const unsigned int aWorkingFrequency, const double aHighPassFrequency=0.0)
	Defines frequencies for the transformation.
bool	SetHighPassFrequency (const double aHighPassFrequency)
	Defines a highpass frequency.
bool	SetNativeFrequency (const int aNativeFrequency)
	Sets a new native sampling frequency.
void	SetWindow (const unsigned int aWindowSize, double *aWindow)
	Defines the window.
bool	SetWorkingFrequency (const unsigned int aWorkingFrequency)
	Sets a new working sampling frequency.
bool	Transform (const unsigned int aInSize, double *aInData, const unsigned int aOutSize, double *aOutData)
	Transforms data.
	Sample (const unsigned int aVerbosity=0)
	Constructor of the Sample class.
virtual	~Sample (void)
	Destructor of the Sample class.

Private Attributes
bool	go_uniform
	true if the Gwollum options are uniform.
double *	Mend
	End time.
double *	Mfmax
	Meta frequency max.
double	Mfmax_stat
	Meta frequency max (static).
double *	Mfmin
	Meta frequency min.
double	Mfmin_stat
	Meta frequency min (static).
unsigned int	Mn
	Number of entries.
string	Mprocessname
	Process name.
string	Mprocessuser
	User name.
string	Mprocessversion
	Process version.
double *	Mqmax
	Meta Q max.
double	Mqmax_stat
	Meta Q max (static).
double *	Mqmin
	Meta Q min.
double	Mqmin_stat
	Meta Q min (static).
double *	Msnrmax
	Meta SNR max.
double	Msnrmax_stat
	Meta SNR max (static).
double *	Msnrmin
	Meta SNR min.
double	Msnrmin_stat
	Meta SNR min (static).
double *	Mstart
	Start time.
string	pattern
	Input file pattern.
string	subdir
	Input file subdirectory.

Additional Inherited Members
Protected Attributes inherited from Streams
string	Name
	Stream name.
Protected Attributes inherited from Sample
double	fHighPassFrequency
	Cutoff frequency.
unsigned int	fNativeFrequency
	Native sampling frequency.
bool	fRemoveDC
	DC removal flag.
double *	fWindow
	Window.
unsigned int	fWindowSize
	Window size.
unsigned int	fWorkingFrequency
	Working sampling frequency.
Monitor *	mon
	Class monitor.

Detailed Description

Access metadata in trigger files.

This class is designed to read triggers metadata stored in TTrees saved in ROOT files. It should be used when you are only interested by the metadata content of trigger files. Only the segment and metadata contents of the files are 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.

Author

Florent Robinet

Constructor & Destructor Documentation

ReadTriggerMetaData()

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

Constructor of the ReadTriggerMetaData class.

The segment tree and the metadata tree in ROOT files designated by a file pattern are scanned.

The metadata parameters (frequency, Q, and SNR) are scanned and the absolute minimum/maximum is found.

The metadata may also include a list of options. The options are downloaded as a GwollumOptions object.

The segment tree in the input files are also downloaded. These segments can be accessed using the methods of the Segments class from which this class inherits.

The stream name in the metadata is used to initiate the Streams object.

Warning

When scanning the files, the reference process name and stream name are determined from the first file. Then, if, for the next files, the process name or the stream name changes, files are skipped.

Note

The process version and the username are extracted from the last file.

Parameters

[in]	aPattern	Input file pattern.
[in]	aDirectory	ROOT subdirectory. Use "" if none.
[in]	aVerbose	Verbosity level.

~ReadTriggerMetaData()

ReadTriggerMetaData::~ReadTriggerMetaData ( void  )

virtual

Destructor of the ReadTriggerMetaData class.

Member Function Documentation

GetFrequencyMax()

double ReadTriggerMetaData::GetFrequencyMax ( void  )

inline

Returns the absolute maximum frequency [Hz].

GetFrequencyMin()

double ReadTriggerMetaData::GetFrequencyMin ( void  )

inline

Returns the absolute minimum frequency [Hz].

GetProcessName()

string ReadTriggerMetaData::GetProcessName ( void  )

inline

Returns the process name.

GetProcessUser()

string ReadTriggerMetaData::GetProcessUser ( void  )

inline

Returns the process user name.

GetProcessVersion()

string ReadTriggerMetaData::GetProcessVersion ( void  )

inline

Returns the process version.

GetQMax()

double ReadTriggerMetaData::GetQMax ( void  )

inline

Returns the absolute maximum Q value.

GetQMin()

double ReadTriggerMetaData::GetQMin ( void  )

inline

Returns the absolute minimum Q value.

GetSnrMax()

double ReadTriggerMetaData::GetSnrMax ( void  )

inline

Returns the absolute maximum SNR value.

GetSnrMin()

double ReadTriggerMetaData::GetSnrMin ( void  )

inline

Returns the absolute minimum SNR value.

GetStatus()

bool ReadTriggerMetaData::GetStatus ( void  )

inline

Returns the object status.

Combines Segments::GetStatus() and Streams::GetStatus().

Merge()

string ReadTriggerMetaData::Merge	(	const string	aOutputDirectory,
		const bool	aTestUniform = true
	)

Merge all input files into one single file.

Warning

By default, the merge operation can only happen if the set of option is uniform accross the multiple files. It is possible to by-pass this requirement with a dedicated flag. In that case, the first input file is considered as a reference for the option list.

Returns

The path to the output file. "" is returned if the merge fails.

Parameters

[in]

aOutputDirectory

Output directory.

Member Data Documentation

go_uniform

bool ReadTriggerMetaData::go_uniform

private

true if the Gwollum options are uniform.

Mend

double* ReadTriggerMetaData::Mend

private

End time.

Mfmax

double* ReadTriggerMetaData::Mfmax

private

Meta frequency max.

Mfmax_stat

double ReadTriggerMetaData::Mfmax_stat

private

Meta frequency max (static).

Mfmin

double* ReadTriggerMetaData::Mfmin

private

Meta frequency min.

Mfmin_stat

double ReadTriggerMetaData::Mfmin_stat

private

Meta frequency min (static).

Mn

unsigned int ReadTriggerMetaData::Mn

private

Number of entries.

Mprocessname

string ReadTriggerMetaData::Mprocessname

private

Process name.

Mprocessuser

string ReadTriggerMetaData::Mprocessuser

private

User name.

Mprocessversion

string ReadTriggerMetaData::Mprocessversion

private

Process version.

Mqmax

double* ReadTriggerMetaData::Mqmax

private

Meta Q max.

Mqmax_stat

double ReadTriggerMetaData::Mqmax_stat

private

Meta Q max (static).

Mqmin

double* ReadTriggerMetaData::Mqmin

private

Meta Q min.

Mqmin_stat

double ReadTriggerMetaData::Mqmin_stat

private

Meta Q min (static).

Msnrmax

double* ReadTriggerMetaData::Msnrmax

private

Meta SNR max.

Msnrmax_stat

double ReadTriggerMetaData::Msnrmax_stat

private

Meta SNR max (static).

Msnrmin

double* ReadTriggerMetaData::Msnrmin

private

Meta SNR min.

Msnrmin_stat

double ReadTriggerMetaData::Msnrmin_stat

private

Meta SNR min (static).

Mstart

double* ReadTriggerMetaData::Mstart

private

Start time.

pattern

string ReadTriggerMetaData::pattern

private

Input file pattern.

subdir

string ReadTriggerMetaData::subdir

private

Input file subdirectory.

---

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

• src/Triggers/ReadTriggerMetaData.h
• src/Triggers/ReadTriggerMetaData.cc