Plot triggers. More...

#include <TriggerPlot.h>

Inheritance diagram for TriggerPlot:

[legend]

Collaboration diagram for TriggerPlot:

[legend]

Public Member Functions
unsigned int	GetCollectionN (const unsigned int aCollIndex)
	Returns the number of triggers/clusters in a given collection. More...

TriggerSelect *	GetCollectionSelection (const unsigned int aCollIndex)
	Returns the selection of a given collection. More...

unsigned int	GetN (void)
	Returns the number of collections. More...

TGraph *	GetTGraph (TH1D **aFrame, const string aPlotType, const unsigned int aCollIndex)
	Returns a TGraph copy from a given collection. More...

TH1D *	GetTH1D (const string aPlotType, const unsigned int aCollIndex)
	Returns a TH1D copy from a given collection. More...

double	GetYmax (const string aPlotType, const int aCollIndex)
	Returns the Y max of the plot in the canvas. More...

double	GetYmin (const string aPlotType, const int aCollIndex)
	Returns the Y min of the plot in the canvas. More...

void	MakeCollection (const int aCollIndex=-1, Segments *aInSeg=NULL)
	Builds collection plots. More...

void	PlotLoudestEvent (const bool aFlag=true)
	Plots the loudest event with a star marker. More...

void	PrintPlot (const string aPlotType)
	Prints a given plot type from all collections. More...

void	PrintPlot (const string aPlotType, const unsigned int aCollIndex, const bool aFirst=true)
	Prints a given plot type from a given collection. More...

void	PrintPlot (const string aPlotType, const vector< unsigned int > aCollIndex, const bool aFirst)
	Prints a given plot type from a few collections. More...

void	PrintPlot (TObject *aObj)
	Prints an external object. More...

void	SetCollectionColor (const unsigned int aCollIndex, const unsigned int aColorIndex)
	Assigns a color to a collection. More...

void	SetCollectionLegend (const unsigned int aCollIndex, const string aLegend)
	Sets a legend to a collection. More...

void	SetCollectionMarker (const unsigned int aCollIndex, const unsigned int aMarkerStyleIndex, const double aMarkerSize=1.0)
	Assigns a marker style to a collection. More...

void	SetRateRange (const double aRateMin, const double aRateMax)
	Sets the range for the rate plot. More...

void	SetSelectionSegments (Segments *SelectionSegments)
	Sets selection segments for all collections. More...

Constructors and destructors
	TriggerPlot (const unsigned int aNcoll, const string aPattern, const string aDirectory="", const string aStyleName="GWOLLUM", const unsigned int aVerbose=0)
	Constructor of the TriggerPlot class. More...

virtual	~TriggerPlot (void)
	Destructor of the TriggerPlot class. More...

Public Member Functions inherited from GwollumPlot
void	AddLegendEntry (const TObject *aObj, const string aLabel, const string aStyle="LPF")
	Adds a legend entry. More...

void	AddLegendHeader (const string aLabel)
	Adds a legend header. More...

void	AddText (const string aText, const double aX, const double aY, const double aSize, const int aPadIndex=0)
	Adds text in the plot. More...

void	Clear (const int aPadIndex=0)
	Clear pad. More...

void	DivideCanvas (const unsigned int aNpads)
	Divides current canvas into sub-pads. More...

void	DivideCanvas (const unsigned int aNx, const unsigned int aNy)
	Divides current canvas into sub-pads. More...

void	Draw (TObject *aObj, const string aOptions="", const int aPadIndex=0)
	Draws ROOT object. More...

void	DrawLegend (void)
	Draws current legend box. More...

unsigned int	GetColorPalette (const unsigned int i)
	Returns color number i in current palette. More...

string	GetCurrentStyle (void)
	Returns current style name. More...

int	GetHeight (void)
	Returns the canvas height. More...

unsigned int	GetNumberOfColors (void)
	Returns the number of colors in current palette. More...

int	GetOxColorIndex (unsigned int aColorType)
	Returns the color index for the Ox style. More...

int	GetWidth (void)
	Returns the canvas width. More...

void	Print (const string aFileName)
	Prints current canvas in a file. More...

void	Print (const string aFileName, const double aScaleFactor)
	Prints current canvas in a file with a rescaling factor. More...

void	Print (const string aFileName, const unsigned int aNewWidth, const unsigned int aNewHeight)
	Prints current canvas in a file with a new size. More...

void	RedrawAxis (Option_t *option="", int aPadIndex=0)
	Redraw the frame axis. More...

void	ResetLegend (void)
	Resets and removes current legend box. More...

void	ResizePlot (const unsigned int aWidth, const unsigned int aHeight)
	Resizes the global canvas to new dimensions. More...

void	SetGridx (const int aValue=1, const int aPadIndex=0)
	Set/Unset grid for X. More...

void	SetGridy (const int aValue=1, const int aPadIndex=0)
	Set/Unset grid for Y. More...

void	SetLogx (const int aValue, const int aPadIndex=0)
	Set Lin/Log scale for X. More...

void	SetLogy (const int aValue, const int aPadIndex=0)
	Set Lin/Log scale for Y. More...

void	SetLogz (const int aValue, const int aPadIndex=0)
	Set Lin/Log scale for Z. More...

void	UnDraw (TObject *aObj, const int aPadIndex=0)
	UnDraws a ROOT object. More...

void	UnDrawLegend (void)
	Removes the legend box from the pad. More...

void	UpdateText (const string aText)
	Updates text in the plot. More...

	GwollumPlot (const string aName, const string aStyleName="GWOLLUM")
	Constructor of the GwollumPlot class. More...

virtual	~GwollumPlot (void)
	Destructor of the GwollumPlot class. More...

Public Member Functions inherited from ReadTriggers
	ReadTriggers (const string aPattern, const string aDirectory="", const unsigned int aVerbose=0)
	Constructor of the ReadTriggers class. More...

virtual	~ReadTriggers (void)
	Destructor of the ReadTriggers class. More...

Public Member Functions inherited from ReadTriggerMetaData
double	GetFrequencyMax (void)
	Returns the absolute maximum frequency [Hz]. More...

double	GetFrequencyMin (void)
	Returns the absolute minimum frequency [Hz]. More...

string	GetProcessName (void)
	Returns the process name. More...

string	GetProcessUser (void)
	Returns the process user name. More...

string	GetProcessVersion (void)
	Returns the process version. More...

double	GetQMax (void)
	Returns the absolute maximum Q value. More...

double	GetQMin (void)
	Returns the absolute minimum Q value. More...

double	GetSnrMax (void)
	Returns the absolute maximum SNR value. More...

double	GetSnrMin (void)
	Returns the absolute minimum SNR value. More...

string	Merge (const string aOutputDirectory)
	Merge all input files into one single file. More...

	ReadTriggerMetaData (const string aPattern, const string aDirectory="", const unsigned int aVerbose=0)
	Constructor of the ReadTriggerMetaData class. More...

virtual	~ReadTriggerMetaData (void)
	Destructor of the ReadTriggerMetaData class. More...

Public Member Functions inherited from Segments
bool	AddSegment (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Adds a segment to the list. More...

bool	AddSegments (Segments *aSeg)
	Adds a segment list to the list. More...

bool	Append (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Appends a segment to the list. More...

bool	Append (Segments *aSeg)
	Appends segments to the list. More...

bool	Append (TTree *aSegmentTree)
	Appends segments to the list. More...

bool	Append (vector< double > aGpsStarts, vector< double > aGpsEnds, vector< double > aTags)
	Appends segments to the list. More...

bool	ApplyPadding (const double aPadStart, const double aPadEnd)
	Apply a padding to all segments. More...

void	Dump (unsigned int aNcols=2, const string aTxtFileName="")
	Dumps the current segment list in the standard output or in a file. More...

double	GetDuration (const unsigned int aSegmentIndex=0)
	Returns the duration of a given segment. More...

double	GetEnd (const unsigned int aSegmentIndex=0)
	Returns the ending time of a given segment. More...

vector< double >	GetEnds (void)
	Returns the list of segment ends. More...

double	GetFirst ()
	Returns the starting time of the first segment. More...

TH1I *	GetHisto (const double aOffset=0.0)
	Returns an histogram representing the segments. More...

TH1I *	GetHistogram (const double aGpsStart, const double aGpsEnd, const double aOffset=0.0)
	Returns an histogram representing the segments. More...

double	GetLast ()
	Returns the ending time of the last segment. More...

double	GetLiveTime (const double aGpsStart, const double aGpsEnd)
	Returns the livetime between two GPS times. More...

double	GetLiveTime (const unsigned int aSegmentIndex)
	Returns the livetime of one segment. More...

double	GetLiveTime (void)
	Returns the total livetime. More...

double	GetLiveTimeWithTag (const int aTag)
	Returns the livetime for segments with a given tag. More...

unsigned int	GetN (void)
	Returns the number of time segments in the list. More...

unsigned int	GetNWithTag (const int aTag)
	Returns the number of time segments in the list with a given tag. More...

int	GetSegmentStartBefore (const double aGps)
	Returns the segment starting just before a given GPS time. More...

double	GetStart (const unsigned int aSegmentIndex=0)
	Returns the starting time of a given segment. More...

vector< double >	GetStarts (void)
	Returns the list of segment starts. More...

bool	GetStatus (void) const
	Returns the status of the Segments object. More...

int	GetTag (const unsigned int aSegmentIndex=0)
	Returns the tag of a given segment. More...

vector< int >	GetTags (void)
	Returns the list of segment tags. More...

TTree *	GetTree (const double aGpsStart, const double aGpsEnd)
	Returns a formatted TTree representing the segments. More...

TTree *	GetTree (void)
	Returns a formatted TTree representing the segments. More...

bool	Intersect (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Intersects with a segment. More...

bool	Intersect (Segments *aSeg)
	Intersects with a segment list. More...

bool	IsInsideSegment (const double aGps)
	Checks whether a given GPS time is inside a segment of the list. More...

bool	IsInsideSegment (unsigned int &aSegmentIndex, const double aGps)
	Checks whether a given GPS time is inside a segment of the list. More...

bool	MakeSecond (void)
	Rounds segment boundaries to integer seconds. More...

void	Reset (void)
	Resets the segment list. More...

bool	Reverse (void)
	Reverses the segment list. More...

void	SetTag (const unsigned int aSegmentIndex, const int aTag)
	Tags a given segment. More...

void	SetTags (const int aTag)
	Tags all segments. More...

bool	TruncateAfter (const double aGps)
	Removes segments after a given time. More...

bool	TruncateBefore (const double aGps)
	Removes segments before a given time. More...

	Segments (void)
	Default constructor of the Segments class. More...

	Segments (const string aSegmentFile, const int aDefaultTag=1)
	Constructor of the Segments class. More...

	Segments (TTree *aSegmentTree)
	Constructor of the Segments class. More...

	Segments (const string aFilePattern, const string aDirectory, const string aTreeName)
	Constructor of the Segments class. More...

	Segments (const vector< double > aGpsStarts, const vector< double > aGpsEnds)
	Constructor of the Segments class. More...

	Segments (const double aGpsStart, const double aGpsEnd, const int aTag=1)
	Constructor of the Segments class. More...

virtual	~Segments (void)
	Destructor of the Segments class. More...

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\). More...

unsigned int	GetDetectorIndex (void)
	Returns the detector index for this stream. More...

string	GetDetectorPrefix (void)
	Returns the detector prefix for this stream. More...

string	GetDirectory (const string aOutDir=".")
	Returns the stream directory. More...

double	GetLocalTime (const double aRa, const double aDec, const double aGeocentricTime)
	Converts the geocentric time to the detector local time [s]. More...

string	GetName (void)
	Returns the stream full name. More...

string	GetNameConv (void)
	Returns the stream name using the LIGO-Virgo file name convention. More...

string	GetNamePrefix (void)
	Returns the stream name prefix. More...

string	GetNameSuffix (void)
	Returns the stream name suffix. More...

string	GetNameSuffixUnderScore (void)
	Returns the stream name suffix with only underscores. More...

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. More...

void	SetName (const string aName)
	Sets a new name to the stream. More...

	Streams (const string aName, const unsigned int aVerbose=0)
	Constructor of the Streams class. More...

virtual	~Streams (void)
	Destructor of the Streams class. More...

Public Member Functions inherited from Sample
double	GetHighPassFrequency (void)
	Returns the current highpass frequency. More...

unsigned int	GetNativeFrequency (void)
	Returns the current native sampling frequency [Hz]. More...

unsigned int	GetWindowSize (void)
	Returns the window size (=0 if no windowing). More...

unsigned int	GetWorkingFrequency (void)
	Returns the current working sampling frequency [Hz]. More...

void	SetDCRemoval (const bool aDCremove=true)
	Activates/Deactivates the DC removal. More...

bool	SetFrequencies (const unsigned int aNativeFrequency, const unsigned int aWorkingFrequency, const double aHighPassFrequency=0.0)
	Defines frequencies for the transformation. More...

bool	SetHighPassFrequency (const double aHighPassFrequency)
	Defines a highpass frequency. More...

bool	SetNativeFrequency (const int aNativeFrequency)
	Sets a new native sampling frequency. More...

void	SetWindow (const unsigned int aWindowSize, double *aWindow)
	Defines the window. More...

bool	SetWorkingFrequency (const unsigned int aWorkingFrequency)
	Sets a new working sampling frequency. More...

bool	Transform (const unsigned int aInSize, double aInData, const unsigned int aOutSize, double aOutData)
	Transforms data. More...

	Sample (const unsigned int aVerbosity=0)
	Constructor of the Sample class. More...

virtual	~Sample (void)
	Destructor of the Sample class. More...

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). More...

void	Add (const string aTag, const string aKey, const int aDefaultValue, const unsigned int aSize=0)
	Adds an option to the list (int). More...

void	Add (const string aTag, const string aKey, const string aDefaultValue, const unsigned int aSize=0)
	Adds an option to the list (string). More...

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). More...

void	AddOptionValue (const string aTag, const string aKey, const double aValue)
	Appends a value to a variable-size option (double). More...

void	AddOptionValue (const string aTag, const string aKey, const int aValue)
	Appends a value to a variable-size option (int). More...

void	AddOptionValue (const string aTag, const string aKey, const string aValue)
	Appends a value to a variable-size option (string). More...

void	AddOptionValue (const string aTag, const string aKey, const unsigned int aValue)
	Appends a value to a variable-size option (unsigned int). More...

void	Copy (GwollumOptions *aG)
	Copies an external GwollumOptions object into this. More...

void	FillTree (void)
	Saves options in a TTree. More...

double	GetOptionDefaultD (const unsigned int aOptionIndex)
	Returns an option default value. More...

int	GetOptionDefaultI (const unsigned int aOptionIndex)
	Returns an option default value. More...

string	GetOptionDefaultS (const unsigned int aOptionIndex)
	Returns an option default value. More...

unsigned int	GetOptionDefaultU (const unsigned int aOptionIndex)
	Returns an option default value. More...

unsigned int	GetOptionIndex (const string aTag, const string aKey)
	Returns the option index. More...

string	GetOptionKey (const unsigned int aOptionIndex)
	Returns an option key. More...

unsigned int	GetOptionNumberOfValues (const string aTag, const string aKey)
	Returns the option number of values. More...

unsigned int	GetOptionSize (const string aTag, const string aKey)
	Returns the option size. More...

unsigned int	GetOptionSize (const unsigned int aOptionIndex)
	Returns an option size. More...

unsigned int	GetOptionsN (void)
	Returns the number of options. More...

string	GetOptionTag (const unsigned int aOptionIndex)
	Returns an option tag. More...

char	GetOptionType (const string aTag, const string aKey)
	Returns the option type. More...

char	GetOptionType (const unsigned int aOptionIndex)
	Returns an option type. More...

double	GetOptionValueD (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (double). More...

bool	GetOptionValueD (double &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (double). More...

int	GetOptionValueI (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (int). More...

bool	GetOptionValueI (int &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (int). More...

string	GetOptionValueS (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (string). More...

bool	GetOptionValueS (string &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (string). More...

vector< double >	GetOptionValuesD (const string aTag, const string aKey)
	Returns the list of option values (double). More...

vector< int >	GetOptionValuesI (const string aTag, const string aKey)
	Returns the list of option values (int). More...

vector< string >	GetOptionValuesS (const string aTag, const string aKey)
	Returns the list of option values (string). More...

vector< unsigned int >	GetOptionValuesU (const string aTag, const string aKey)
	Returns the list of option values (unsigned int). More...

unsigned int	GetOptionValueU (const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (unsigned int). More...

bool	GetOptionValueU (unsigned int &aValue, const string aTag, const string aKey, const unsigned int aValIndex)
	Returns an option value (unsigned int). More...

bool	Is (const string aTag, const string aKey)
	Checks whether an option exists. More...

bool	IsProvided (const string aTag, const string aKey)
	Checks whether an option was provided. More...

bool	IsTheSame (GwollumOptions *aG)
	Checks whether two GwollumOptions objects are identical. More...

bool	ReadChain (bool &aIsUniform, TChain *aChain)
	Reads options from a TChain. More...

unsigned int	ReadTextFile (const string aOptionFile)
	Reads an option file and extract the list of options. More...

bool	ReadTree (const string aRootFileName, const string aTreeName)
	Reads options from a TTree in a ROOT file. More...

bool	ReadTree (TTree *aTree)
	Reads options from a TTree. More...

void	RemoveOption (const string aTag, const string aKey)
	Removes an option. More...

void	Reset (void)
	Resets the list of options. More...

void	ResetOption (const string aTag, const string aKey)
	Resets the list of option values. More...

void	SetDefault (const string aTag, const string aKey)
	Sets an option to default value. More...

void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const double aValue)
	Sets a value of an option (double). More...

void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const int aValue)
	Sets a value of an option (int). More...

void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const string aValue)
	Sets a value of an option (string). More...

void	SetOptionValue (const string aTag, const string aKey, const unsigned int aValIndex, const unsigned int aValue)
	Sets a value of an option (unsigned int). More...

void	WriteH5 (H5::H5File *aFile, H5::DataSpace &aDataSpace)
	Writes the options as attributes in a hdf5 file. More...

void	WriteTextFile (const string aFileName)
	Writes all options in a text file. More...

void	WriteTree (const string aTreeName)
	Writes the option TTree in a TFile. More...

void	WriteTree (const string aTreeName, const string aRootFileName, const string aSubDirectory="")
	Writes the option TTree in a TFile. More...

	GwollumOptions (void)
	Constructor of the GwollumOptions class. More...

virtual	~GwollumOptions (void)
	Destructor of the GwollumOptions class. More...

Public Member Functions inherited from Triggers
bool	AddTrigger (const double aTime, const double aFrequency, const double aSNR, const double aQ, const double aTstart, const double aTend, const double aFstart, const double aFend, const double aAmplitude, const double aPhase)
	Adds a trigger to the Triggers object (only available in write-mode). More...

bool	Clusterize (const int aTag=1)
	Clusters the triggers. More...

double	GetClusterAmplitude (const unsigned int aClusterIndex)
	Returns the amplitude of a given cluster. More...

double	GetClusterBandwidth (const unsigned int aClusterIndex)
	Returns the bandwidth of a given cluster [Hz]. More...

double	GetClusterDuration (const unsigned int aClusterIndex)
	Returns the duration of a given cluster [s]. More...

Long64_t	GetClusterFirstTrigger (const unsigned int aClusterIndex)
	Returns the index of the first trigger in a given cluster. More...

double	GetClusterFrequency (const unsigned int aClusterIndex)
	Returns the frequency of a given cluster [Hz]. More...

double	GetClusterFrequencyEnd (const unsigned int aClusterIndex)
	Returns the end frequency of a given cluster [Hz]. More...

double	GetClusterFrequencyStart (const unsigned int aClusterIndex)
	Returns the start frequency of a given cluster [Hz]. More...

int	GetClusterIndex (const double aTime)
	Returns the index of cluster overlapping a given GPS time. More...

double	GetClusterizeDt (void)
	Gets the clustering \(\delta t\) parameter. More...

unsigned int	GetClusterizeSizeMin (void)
	Gets the cluster minimal size: \(M_{min}\). More...

double	GetClusterizeSnrThr (void)
	Gets the SNR threshold for clustering. More...

double	GetClusterMaxDuration (void)
	Returns the maximal duration of clusters [s]. More...

double	GetClusterMeanDuration (void)
	Returns the mean duration of clusters [s]. More...

unsigned int	GetClusterN (void)
	Returns the current number of clusters in memory. More...

double	GetClusterPhase (const unsigned int aClusterIndex)
	Returns the phase of a given cluster [rad]. More...

double	GetClusterQ (const unsigned int aClusterIndex)
	Returns the quality factor of a given cluster. More...

unsigned int	GetClusterSize (const unsigned int aClusterIndex)
	Returns the size (number of triggers) a given cluster. More...

double	GetClusterSnr (const unsigned int aClusterIndex)
	Returns the signal-to-noise ratio of a given cluster. More...

int	GetClusterTag (const unsigned int aClusterIndex)
	Returns the tag of a given cluster. More...

double	GetClusterTime (const unsigned int aClusterIndex)
	Returns the time of a given cluster [s]. More...

double	GetClusterTimeEnd (const unsigned int aClusterIndex)
	Returns the end time of a given cluster [s]. More...

double	GetClusterTimeStart (const unsigned int aClusterIndex)
	Returns the start time of a given cluster [s]. More...

double	GetClusterTotalDuration (void)
	Returns the total duration of clusters [s]. More...

double	GetTriggerAmplitude (const Long64_t aTriggerIndex)
	Returns the amplitude of a given trigger. More...

double	GetTriggerBandwidth (const Long64_t aTriggerIndex)
	Returns the bandwidth of a given trigger [Hz]. More...

double	GetTriggerDuration (const Long64_t aTriggerIndex)
	Returns the duration of a given trigger [s]. More...

double	GetTriggerFrequency (const Long64_t aTriggerIndex)
	Returns the frequency of a given trigger [Hz]. More...

double	GetTriggerFrequencyEnd (const Long64_t aTriggerIndex)
	Returns the end frequency of a given trigger [Hz]. More...

double	GetTriggerFrequencyStart (const Long64_t aTriggerIndex)
	Returns the start frequency of a given trigger [Hz]. More...

Long64_t	GetTriggerN (void)
	Returns the current number of triggers in memory. More...

double	GetTriggerPhase (const Long64_t aTriggerIndex)
	Returns the phase of a given trigger [rad]. More...

double	GetTriggerQ (const Long64_t aTriggerIndex)
	Returns the quality factor of a given trigger. More...

double	GetTriggerSnr (const Long64_t aTriggerIndex)
	Returns the signal-to-noise ratio of a given trigger. More...

double	GetTriggerTime (const Long64_t aTriggerIndex)
	Returns the time of a given trigger [s]. More...

double	GetTriggerTimeEnd (const Long64_t aTriggerIndex)
	Returns the end time of a given trigger [s]. More...

double	GetTriggerTimeStart (const Long64_t aTriggerIndex)
	Returns the start time of a given trigger [s]. More...

bool	ReadTriggerFiles (const string aPattern, const string aDirectory="")
	Reads a set of trigger files. More...

void	Reset (void)
	Resets the Triggers object. More...

void	ResetClusters (void)
	Resets the list of clusters. More...

void	SetClusterizeDt (const double aDt)
	Sets a new clustering \(\delta t\) parameter. More...

void	SetClusterizeSizeMin (const unsigned int aSizeMin)
	Sets the cluster minimal size: \(M_{min}\). More...

void	SetClusterizeSnrThr (const double aSnrThr)
	Sets the SNR threshold for clustering: \(\rho_{min}\). More...

void	SetClusterTag (const int aTag)
	Sets a new tag value for all clusters. More...

void	SetClusterTag (const unsigned int aClusterIndex, const int aTag)
	Sets a new cluster tag value. More...

bool	SetTriggerBranchStatus (const string aBname, const bool aStatus=true)
	Modifies the branch status of the trigger tree. More...

bool	SortTriggers (void)
	Sort triggers by increasing values of tstart (only available in write-mode). More...

	Triggers (const unsigned int aVerbose=0)
	Constructor of the Triggers class. More...

virtual	~Triggers (void)
	Destructor of the Triggers class. More...

Private Member Functions
void	ResetCollection (const unsigned int aCollIndex)
	Resets a collection. More...

void	ResetParameters (const unsigned int aCollIndex)
	Resets collection parameters to default values. More...

Private Attributes
TriggerSelect **	Collection
	Collection selection. More...

TGraph **	Gfreqtime
	Freq vs. time. More...

TGraph *	Gfreqtimeloud
	Freq vs. time (loudest event). More...

TGraph *	Gfreqtimeloud2
	Freq vs. time (loudest event). More...

TGraph **	Gsnrfreq
	SNR vs. freq. More...

TGraph **	Gsnrtime
	SNR vs. time. More...

TH1D **	Hfreq
	Frequency. More...

TH2D **	Hfreqtime
	Freq vs. time container. More...

TH1D **	Hsnr
	SNR. More...

TH2D **	Hsnrfreq
	SNR vs. freq container. More...

TH2D **	Hsnrtime
	SNR vs. time container. More...

TH1D **	Htime
	Time (rate). More...

string *	legend
	Collection legend. More...

unsigned int	Ncoll
	Number of plot collections. More...

unsigned int	nonbox
	Number of on-boxes. More...

unsigned int	nselbox
	Number of selected-boxes. More...

TPave **	OnBox
	ON segments. More...

bool	plotstar
	Flag to plot the loudest event. More...

double	rate_max
	Maximum value to plot the rate [Hz]. More...

double	rate_min
	Minimum value to plot the rate [Hz]. More...

TPave *	SegBox
	Time box. More...

TPave **	SelBox
	Selected segments. More...

Segments *	selseg
	Selection segments for all collections. More...

Additional Inherited Members
Protected Attributes inherited from GwollumPlot
string	name
	Name. More...

int	oxcolindex [4]
	TColor indices for Ox. More...

TColor *	oxcolor [4]
	TColor for Ox. 0=background, 1=middleground/plots, 2=foreground, 3=grid. More...

int	randid
	Random integer id. More...

string	srandid
	Random string id. More...

string	stylename
	Style name. More...

TCanvas *	Wcan
	Working canvas. More...

TLegend *	Wleg
	Plot legends. More...

TPad *	Wpad
	Working pad. More...

TText *	Wtext
	Additional text. More...

Protected Attributes inherited from ReadTriggerMetaData
unsigned int	Verbose
	Verbosity level. More...

Protected Attributes inherited from Streams
string	Name
	Stream name. More...

Protected Attributes inherited from Sample
double	fHighPassFrequency
	Cutoff frequency. More...

unsigned int	fNativeFrequency
	Native sampling frequency. More...

bool	fRemoveDC
	DC removal flag. More...

unsigned int	fVerbosity
	Verbosity level. More...

double *	fWindow
	Window. More...

unsigned int	fWindowSize
	Window size. More...

unsigned int	fWorkingFrequency
	Working sampling frequency. More...

Protected Attributes inherited from Triggers
int	randid
	Random integer to identify the class object. More...

string	srandid
	Random integer (string) to identify the class object. More...

double	Tamp
	Trigger amplitude. More...

double	Tfend
	Trigger ending frequency [Hz]. More...

double	Tfreq
	Trigger frequency [Hz]. More...

double	Tfstart
	Trigger starting frequency [Hz]. More...

Long64_t *	Toffsets
	Tree offsets in the chain (read-mode) - DO NOT DELETE. More...

double	Tph
	Trigger phase [rad]. More...

double	Tq
	Trigger Q. More...

double	Tsnr
	Trigger SNR. More...

double	Ttend
	Trigger GPS ending time. More...

double	Ttime
	Trigger GPS time. More...

TTree *	Ttree
	Pointer to active Ttree. More...

TChain *	Ttree_read
	Trigger tree read-mode. More...

TTree *	Ttree_write
	Trigger tree write-mode. More...

double	Ttstart
	Trigger GPS starting time. More...

int	Ttstart_us
	Trigger starting time (us). More...

int	Verbose
	verbosity level More...

Detailed Description

Plot triggers.

This class was designed to produce and display a 'collection' of plots representing a set of triggers. A collection is composed of several plot types:

"rate": trigger rate as a function of time
"frequency": frequency distribution
"snr": SNR distribution
"freqtime": frequency versus time
"snrtime": SNR vs time
"snrfreq": SNR vs frequency

A collection is defined by a 'selection' which is a set of criteria used to select the triggers to be plotted. This way, several collections can be defined and plotted in the same time.

Author: Florent Robinet

Constructor & Destructor Documentation

◆ TriggerPlot()

TriggerPlot::TriggerPlot	(	const unsigned int	aNcoll,
		const string	aPattern,
		const string	aDirectory = `""`,
		const string	aStyleName = `"GWOLLUM"`,
		const unsigned int	aVerbose = `0`
	)

Constructor of the TriggerPlot class.

A set of plot collections is initialized.

Parameters

[in]	aNcoll	Number of collections.
[in]	aPattern	Input trigger file pattern.
[in]	aDirectory	Trigger ROOT directory.
[in]	aStyleName	GWOLLUM style name.
[in]	aVerbose	Verbosity level.

◆ ~TriggerPlot()

TriggerPlot::~TriggerPlot ( void )

virtual

Destructor of the TriggerPlot class.

Member Function Documentation

◆ GetCollectionN()

unsigned int TriggerPlot::GetCollectionN ( const unsigned int aCollIndex )

inline

Returns the number of triggers/clusters in a given collection.

Parameters

[in] aCollIndex Collection index.

Precondition: The collection index must be valid.

◆ GetCollectionSelection()

TriggerSelect* TriggerPlot::GetCollectionSelection ( const unsigned int aCollIndex )

inline

Returns the selection of a given collection.

Parameters

[in] aCollIndex Collection index.

Precondition: The collection index must be valid.

◆ GetN()

unsigned int TriggerPlot::GetN ( void )

inline

Returns the number of collections.

◆ GetTGraph()

TGraph * TriggerPlot::GetTGraph	(	TH1D **	aFrame,
		const string	aPlotType,
		const unsigned int	aCollIndex
	)

Returns a TGraph copy from a given collection.

Parameters

[out]	aFrame	Frame histogram for that TGraph. To be deleted by the user!
[in]	aPlotType	Plot type: "freqtime", "snrtime", or "snrfreq".
[in]	aCollIndex	Collection index.

Precondition: The collection index must be valid.

◆ GetTH1D()

TH1D * TriggerPlot::GetTH1D	(	const string	aPlotType,
		const unsigned int	aCollIndex
	)

Returns a TH1D copy from a given collection.

Parameters

[in]	aPlotType	Plot type: "rate", "frequency", or "snr".
[in]	aCollIndex	Collection index.

Precondition: The collection index must be valid.

◆ GetYmax()

double TriggerPlot::GetYmax	(	const string	aPlotType,
		const int	aCollIndex
	)

inline

Returns the Y max of the plot in the canvas.

Parameters

[in]	aPlotType	Plot type: "freqtime", "snrtime", "snrfreq", "rate", "frequency", or "snr".
[in]	aCollIndex	Collection index.

Precondition: The collection index must be valid.

◆ GetYmin()

double TriggerPlot::GetYmin	(	const string	aPlotType,
		const int	aCollIndex
	)

inline

Returns the Y min of the plot in the canvas.

Parameters

[in]	aPlotType	Plot type: "freqtime", "snrtime", "snrfreq", "rate", "frequency", or "snr".
[in]	aCollIndex	Collection index.

Precondition: The collection index must be valid.

◆ MakeCollection()

void TriggerPlot::MakeCollection	(	const int	aCollIndex = `-1`,
		Segments *	aInSeg = `NULL`
	)

Builds collection plots.

Once the selection is ready, use this function to build the plots for a given selection.

Parameters

[in]	aCollIndex	Collection index. Use a negative value to make all collections.
[in]	aInSeg	Input segments (optional). This object is used to make selecton time boxes. It is not used to select triggers!!!

◆ PlotLoudestEvent()

void TriggerPlot::PlotLoudestEvent ( const bool aFlag = true )

inline

Plots the loudest event with a star marker.

Parameters

[in] aFlag Set to true to plot a star.

◆ PrintPlot() [1/4]

void TriggerPlot::PrintPlot ( const string aPlotType )

inline

Prints a given plot type from all collections.

Parameters

[in] aPlotType Plot type: "freqtime", "snrtime", "snrfreq", "rate", "frequency", or "snr".

◆ PrintPlot() [2/4]

void TriggerPlot::PrintPlot	(	const string	aPlotType,
		const unsigned int	aCollIndex,
		const bool	aFirst = `true`
	)

inline

Prints a given plot type from a given collection.

Parameters

[in]	aPlotType	Plot type: "freqtime", "snrtime", "snrfreq", "rate", "frequency", or "snr".
[in]	aCollIndex	Collection index.
[in]	aFirst	If set to false, the plot is printed over the existing canvas.

◆ PrintPlot() [3/4]

void TriggerPlot::PrintPlot	(	const string	aPlotType,
		const vector< unsigned int >	aCollIndex,
		const bool	aFirst
	)

Prints a given plot type from a few collections.

If aFirst is set to false, the plots are printed on the existing print.

Parameters

[in]	aPlotType	Plot type: "freqtime", "snrtime", "snrfreq", "rate", "frequency", or "snr".
[in]	aCollIndex	Collection indices.
[in]	aFirst	If set to false, the plots are printed over the existing canvas.

◆ PrintPlot() [4/4]

void TriggerPlot::PrintPlot ( TObject * aObj )

inline

Prints an external object.

Parameters

[in] aObj Object to plot.

◆ ResetCollection()

void TriggerPlot::ResetCollection ( const unsigned int aCollIndex )

private

Resets a collection.

All the plots in a collection are reset. If the style has changed, the new style is applied.

Parameters

[in] aCollIndex Collection index.

◆ ResetParameters()

void TriggerPlot::ResetParameters ( const unsigned int aCollIndex )

private

Resets collection parameters to default values.

Reset trigger selection (TriggerSelect::ResetSelection()).
Plot range: use the trigger min/max.
Use GPS to measure time
Use triggers

Parameters

[in] aCollIndex Collection index.

◆ SetCollectionColor()

void TriggerPlot::SetCollectionColor	(	const unsigned int	aCollIndex,
		const unsigned int	aColorIndex
	)

inline

Assigns a color to a collection.

Parameters

[in]	aCollIndex	Collection index.
[in]	aColorIndex	Color index (ROOT conventions).

Precondition: The collection index must be valid.

◆ SetCollectionLegend()

void TriggerPlot::SetCollectionLegend	(	const unsigned int	aCollIndex,
		const string	aLegend
	)

inline

Sets a legend to a collection.

Parameters

[in]	aCollIndex	Collection index.
[in]	aLegend	Legend label.

Precondition: The collection index must be valid.

◆ SetCollectionMarker()

void TriggerPlot::SetCollectionMarker	(	const unsigned int	aCollIndex,
		const unsigned int	aMarkerStyleIndex,
		const double	aMarkerSize = `1.0`
	)

inline

Assigns a marker style to a collection.

Parameters

[in]	aCollIndex	Collection index.
[in]	aMarkerStyleIndex	Marker style index (ROOT conventions).
[in]	aMarkerSize	Marker size (ROOT conventions).

Precondition: The collection index must be valid.

◆ SetRateRange()

void TriggerPlot::SetRateRange	(	const double	aRateMin,
		const double	aRateMax
	)

inline

Sets the range for the rate plot.

Use a negative value for auto-scaling.

Parameters

[in]	aRateMin	Minimum range [Hz].
[in]	aRateMax	Maximum range [Hz].

◆ SetSelectionSegments()

void TriggerPlot::SetSelectionSegments ( Segments * SelectionSegments )

Sets selection segments for all collections.

Collection triggers/clusters can be selected using a segment list. If the trigger/cluster peak time is not in the selection segment list, it is rejected. Specific blue strips are plotted to indicate the selection segments.

When calling this function with a pointer to NULL or an invalid segment list, no selection is performed.

Warning: The Segments object is NOT copied, only the pointer is. As a result, do not modify the segment list while using this class.

Parameters

[in] SelectionSegments Pointer to a valid segment list.

Member Data Documentation

◆ Collection

TriggerSelect** TriggerPlot::Collection

private

Collection selection.

◆ Gfreqtime

TGraph** TriggerPlot::Gfreqtime

private

Freq vs. time.

◆ Gfreqtimeloud

TGraph* TriggerPlot::Gfreqtimeloud

private

Freq vs. time (loudest event).

◆ Gfreqtimeloud2

TGraph* TriggerPlot::Gfreqtimeloud2

private

Freq vs. time (loudest event).

◆ Gsnrfreq

TGraph** TriggerPlot::Gsnrfreq

private

SNR vs. freq.

◆ Gsnrtime

TGraph** TriggerPlot::Gsnrtime

private

SNR vs. time.

◆ Hfreq

TH1D** TriggerPlot::Hfreq

private

Frequency.

◆ Hfreqtime

TH2D** TriggerPlot::Hfreqtime

private

Freq vs. time container.

◆ Hsnr

TH1D** TriggerPlot::Hsnr

private

SNR.

◆ Hsnrfreq

TH2D** TriggerPlot::Hsnrfreq

private

SNR vs. freq container.

◆ Hsnrtime

TH2D** TriggerPlot::Hsnrtime

private

SNR vs. time container.

◆ Htime

TH1D** TriggerPlot::Htime

private

Time (rate).

◆ legend

string* TriggerPlot::legend

private

Collection legend.

◆ Ncoll

unsigned int TriggerPlot::Ncoll

private

Number of plot collections.

◆ nonbox

unsigned int TriggerPlot::nonbox

private

Number of on-boxes.

◆ nselbox

unsigned int TriggerPlot::nselbox

private

Number of selected-boxes.

◆ OnBox

TPave** TriggerPlot::OnBox

private

ON segments.

◆ plotstar

bool TriggerPlot::plotstar

private

Flag to plot the loudest event.

◆ rate_max

double TriggerPlot::rate_max

private

Maximum value to plot the rate [Hz].

◆ rate_min

double TriggerPlot::rate_min

private

Minimum value to plot the rate [Hz].

◆ SegBox

TPave* TriggerPlot::SegBox

private

Time box.

◆ SelBox

TPave** TriggerPlot::SelBox

private

Selected segments.

◆ selseg

Segments* TriggerPlot::selseg

private

Selection segments for all collections.

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

src/Triggers/TriggerPlot.h
src/Triggers/TriggerPlot.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TriggerPlot()

◆ ~TriggerPlot()

Member Function Documentation

◆ GetCollectionN()

◆ GetCollectionSelection()

◆ GetN()

◆ GetTGraph()

◆ GetTH1D()

◆ GetYmax()

◆ GetYmin()

◆ MakeCollection()

◆ PlotLoudestEvent()

◆ PrintPlot() [1/4]

◆ PrintPlot() [2/4]

◆ PrintPlot() [3/4]

◆ PrintPlot() [4/4]

◆ ResetCollection()

◆ ResetParameters()

◆ SetCollectionColor()

◆ SetCollectionLegend()

◆ SetCollectionMarker()

◆ SetRateRange()

◆ SetSelectionSegments()

Member Data Documentation

◆ Collection

◆ Gfreqtime

◆ Gfreqtimeloud

◆ Gfreqtimeloud2

◆ Gsnrfreq

◆ Gsnrtime

◆ Hfreq

◆ Hfreqtime

◆ Hsnr

◆ Hsnrfreq

◆ Hsnrtime

◆ Htime

◆ legend

◆ Ncoll

◆ nonbox

◆ nselbox

◆ OnBox

◆ plotstar

◆ rate_max

◆ rate_min

◆ SegBox

◆ SelBox

◆ selseg