ReadTriggerMetaData Class Reference

Access meta-data in trigger files. More...

#include <ReadTriggerMetaData.h>

Inheritance diagram for ReadTriggerMetaData:

[legend]

Collaboration diagram for ReadTriggerMetaData:

[legend]

List of all members.

Public Member Functions
double	GetFrequencyMax (void)
	Returns the upper end of the trigger frequency range.
double	GetFrequencyMin (void)
	Returns the lower end of the trigger frequency range.
double	GetMeta (const string aMname, const double aTime)
	Returns the meta value (double) for a given meta-name and ime.
string	GetProcessName (void)
	Returns the process name.
double	GetQMax (void)
	Returns the upper end of the trigger Q range.
double	GetQMin (void)
	Returns the lower end of the trigger Q range.
double	GetSNRMax (void)
	Returns the upper end of the trigger SNR range.
double	GetSNRMin (void)
	Returns the lower end of the trigger SNR range.
string	GetStreamName (void)
	Returns the stream name.
string	Merge (const string aOutdir=".")
	Merges the trigger files into one.
bool	SetNewPattern (const string aPattern)
	Sets a new input file pattern.
Constructors and destructors
	ReadTriggerMetaData (const string aPattern, const string aDirectory="", const int aVerbose=0)
	Constructor of the ReadTriggerMetaData class.
virtual	~ReadTriggerMetaData (void)
	Destructor of the ReadTriggerMetaData class.
Protected Attributes
bool	Mcomplete
	flag for a complete set of metadata
int	Mdetindex
	detector index
double	Mend
	end time
double	Mfmax_stat
	meta frequency max (static)
double	Mfmin_stat
	meta frequency min (static)
string *	Mprocessname
	process name - DO NOT DELETE
double	Mqmax_stat
	meta Q max (static)
double	Mqmin_stat
	meta Q min (static)
double	Msnrmax_stat
	meta SNR max (static)
double	Msnrmin_stat
	meta SNR min (static)
double	Mstart
	start time
string *	Mstreamname
	stream name - DO NOT DELETE
Chain *	Mtree
	metadata TTree

---

Detailed Description

Access meta-data in trigger files.

This class was designed to read triggers meta-data stored in TTrees saved in ROOT files (following the GWOLLUM convention). It should be used when you're only interested by the meta-data content of trigger files. Only the segment and meta-data 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 to access the trigger meta-characteristics.

Author:

Florent Robinet

---

Constructor & Destructor Documentation

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

Constructor of the ReadTriggerMetaData class.

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

Parameters:

	aPattern	input file pattern
	aDirectory	trigger ROOT directory
	aVerbose	verbosity level

ReadTriggerMetaData::~ReadTriggerMetaData

(

void

)

[virtual]

Destructor of the ReadTriggerMetaData class.

---

Member Function Documentation

double ReadTriggerMetaData::GetFrequencyMax

(

void

)

[inline]

Returns the upper end of the trigger frequency range.

Returns -1.0 if the information is missing.

double ReadTriggerMetaData::GetFrequencyMin

(

void

)

[inline]

Returns the lower end of the trigger frequency range.

Returns 1e20 if the information is missing.

double ReadTriggerMetaData::GetMeta	(	const string	aMname,
		const double	aTime
	)

Returns the meta value (double) for a given meta-name and ime.

Returns 1.0e-20 if this function fails.

Parameters:

	aMname	meta-name
	aTime	input time

string ReadTriggerMetaData::GetProcessName

(

void

)

[inline]

Returns the process name.

Returns "none" if the information is missing.

double ReadTriggerMetaData::GetQMax

(

void

)

[inline]

Returns the upper end of the trigger Q range.

Returns -1.0 if the information is missing.

double ReadTriggerMetaData::GetQMin

(

void

)

[inline]

Returns the lower end of the trigger Q range.

Returns 1e20 if the information is missing.

double ReadTriggerMetaData::GetSNRMax

(

void

)

[inline]

Returns the upper end of the trigger SNR range.

Returns -1.0 if the information is missing.

double ReadTriggerMetaData::GetSNRMin

(

void

)

[inline]

Returns the lower end of the trigger SNR range.

Returns 1e20 if the information is missing.

string ReadTriggerMetaData::GetStreamName

(

void

)

[inline]

Returns the stream name.

string ReadTriggerMetaData::Merge

(

const string

aOutdir = "."

)

Merges the trigger files into one.

Returns the name of the merged trigger file. Returns "none" if this function fails.

Parameters:

aOutdir

output directory

bool ReadTriggerMetaData::SetNewPattern

(

const string

aPattern

)

Sets a new input file pattern.

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

Parameters:

aPattern

new input file pattern

Reimplemented from ReadTriggerSegments.

Reimplemented in ReadTriggers.

---

Member Data Documentation

bool ReadTriggerMetaData::Mcomplete [protected]

flag for a complete set of metadata

int ReadTriggerMetaData::Mdetindex [protected]

detector index

double ReadTriggerMetaData::Mend [protected]

end time

double ReadTriggerMetaData::Mfmax_stat [protected]

meta frequency max (static)

double ReadTriggerMetaData::Mfmin_stat [protected]

meta frequency min (static)

string* ReadTriggerMetaData::Mprocessname [protected]

process name - DO NOT DELETE

double ReadTriggerMetaData::Mqmax_stat [protected]

meta Q max (static)

double ReadTriggerMetaData::Mqmin_stat [protected]

meta Q min (static)

double ReadTriggerMetaData::Msnrmax_stat [protected]

meta SNR max (static)

double ReadTriggerMetaData::Msnrmin_stat [protected]

meta SNR min (static)

double ReadTriggerMetaData::Mstart [protected]

start time

string* ReadTriggerMetaData::Mstreamname [protected]

stream name - DO NOT DELETE

Chain* ReadTriggerMetaData::Mtree [protected]

metadata TTree

---

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

• /afs/in2p3.fr/throng/virgo/virgoDev/SoftFlorent/GWOLLUM/v2r2/src/Triggers/ReadTriggerMetaData.h
• /afs/in2p3.fr/throng/virgo/virgoDev/SoftFlorent/GWOLLUM/v2r2/src/Triggers/ReadTriggerMetaData.cc