GWOLLUM
4.2.0
Tools for gravitational-wave analyses
|
Select trigger parameters. More...
#include <TriggerSelect.h>
Public Member Functions | |
int | GetClusterTag (void) |
Returns the cluster tag used for the selection. More... | |
double | GetFrequencyMax (void) |
Returns the maximal frequency value. More... | |
double | GetFrequencyMin (void) |
Returns the minimal frequency value. More... | |
double | GetFrequencyRange (void) |
Returns the frequency range value. More... | |
unsigned int | GetFrequencyResolution (void) |
Returns the frequency resolution value. More... | |
double | GetQMax (void) |
Returns the maximal Q value. More... | |
double | GetQMin (void) |
Returns the minimal Q value. More... | |
double | GetQRange (void) |
Returns the Q range value. More... | |
unsigned int | GetQResolution (void) |
Returns the Q resolution value. More... | |
double | GetSnrMax (void) |
Returns the maximal SNR value. More... | |
double | GetSnrMin (void) |
Returns the minimal SNR value. More... | |
double | GetSnrRange (void) |
Returns the SNR range value. More... | |
unsigned int | GetSnrResolution (void) |
Returns the SNR resolution value. More... | |
TH1D * | GetTH1D (const string aParameter) |
Returns an empty 1-D histogram binned in a given parameter. More... | |
TH2D * | GetTH2D (const string aParameterX, const string aParameterY) |
Returns an empty 2-D histogram binned in a given combination of parameters. More... | |
double | GetTimeMax (void) |
Returns the maximal time value. More... | |
double | GetTimeMin (void) |
Returns the minimal time value. More... | |
double | GetTimeRange (void) |
Returns the time range value. More... | |
unsigned int | GetTimeResolution (void) |
Returns the time resolution value. More... | |
string | GetTimeStamp (void) |
Returns the time stamp for this selection. More... | |
void | PrintSelection (void) |
Prints the current selection in the standard output. More... | |
void | ResetSelection (void) |
Resets the selection back to default. More... | |
void | SetFrequencyMax (const double aMax) |
Sets the maximal frequency value. More... | |
void | SetFrequencyMin (const double aMin) |
Sets the minimal frequency value. More... | |
void | SetFrequencyRange (const double aMin, const double aMax) |
Sets the frequency range. More... | |
void | SetFrequencyResolution (const unsigned int aResolution) |
Sets the frequency resolution. More... | |
void | SetFrequencySelection (const unsigned int aResolution, const double aMin, const double aMax) |
Sets the frequency selection. More... | |
void | SetQMax (const double aMax) |
Sets the maximal Q value. More... | |
void | SetQMin (const double aMin) |
Sets the minimal Q value. More... | |
void | SetQRange (const double aMin, const double aMax) |
Sets the Q range. More... | |
void | SetQResolution (const unsigned int aResolution) |
Sets the Q resolution. More... | |
void | SetQSelection (const unsigned int aResolution, const double aMin, const double aMax) |
Sets the Q selection. More... | |
void | SetSnrMax (const double aMax) |
Sets the maximal SNR value. More... | |
void | SetSnrMin (const double aMin) |
Sets the minimal SNR value. More... | |
void | SetSnrRange (const double aMin, const double aMax) |
Sets the SNR range. More... | |
void | SetSnrResolution (const unsigned int aResolution) |
Sets the SNR resolution. More... | |
void | SetSnrSelection (const unsigned int aResolution, const double aMin, const double aMax) |
Sets the SNR selection. More... | |
void | SetTimeMax (const double aMax) |
Sets the maximal time value. More... | |
void | SetTimeMin (const double aMin) |
Sets the minimal time value. More... | |
void | SetTimeRange (const double aMin, const double aMax) |
Sets the time range. More... | |
void | SetTimeResolution (const unsigned int aResolution) |
Sets the time resolution. More... | |
void | SetTimeSelection (const unsigned int aResolution, const double aMin, const double aMax) |
Sets the time selection. More... | |
void | UseClusterTag (unsigned int aTag) |
Use cluster tags. More... | |
void | UseDateTime (void) |
Use a date format for time axes. More... | |
void | UseGpsTime (void) |
Use a GPS format for time axes. More... | |
void | UseTriggers (void) |
Use triggers. More... | |
Constructors and destructors | |
TriggerSelect (const string aName, const unsigned int aVerbose=0) | |
Constructor of the TriggerSelect class. More... | |
TriggerSelect (ReadTriggers *aTriggers, const unsigned int aVerbose=0) | |
Constructor of the TriggerSelect class. More... | |
virtual | ~TriggerSelect (void) |
Destructor of the TriggerSelect class. More... | |
Private Member Functions | |
void | MakeFbins (void) |
Makes frequency binning (log). More... | |
void | MakeQbins (void) |
Makes Q binning (log). More... | |
void | MakeSbins (void) |
Makes SNR binning (log). More... | |
void | MakeTbins (void) |
Makes time binning (linear). More... | |
Private Attributes | |
int | clustertag |
cluster tag: -1 for triggers. More... | |
double * | fbins |
Frequency bins. More... | |
double | fmax |
Frequency max (current). More... | |
double | fmax_0 |
Frequency max (default). More... | |
double | fmin |
Frequency min (current). More... | |
double | fmin_0 |
Frequency min (default). More... | |
string | name |
Name. More... | |
unsigned int | nfbins |
Number of frequency bins (current). More... | |
unsigned int | nfbins_0 |
Number of frequency bins (default). More... | |
unsigned int | nqbins |
Number of Q bins (current). More... | |
unsigned int | nqbins_0 |
Number of Q bins (default). More... | |
unsigned int | nsbins |
Number of SNR bins (current). More... | |
unsigned int | nsbins_0 |
Number of SNR bins (default). More... | |
unsigned int | ntbins |
Number of time bins (current). More... | |
unsigned int | ntbins_0 |
Number of time bins (default). More... | |
double * | qbins |
Q bins. More... | |
double | qmax |
Q max (current). More... | |
double | qmax_0 |
Q max (default). More... | |
double | qmin |
Q min (current). More... | |
double | qmin_0 |
Q min (default). More... | |
double * | sbins |
SNR bins. More... | |
double | smax |
SNR max (current). More... | |
double | smax_0 |
SNR max (default). More... | |
double | smin |
SNR min (current). More... | |
double | smin_0 |
SNR min (default). More... | |
string | sstart |
Start time string. See MakeTbins(). More... | |
double * | tbins |
Time bins. More... | |
double | tmax |
Time max (current). More... | |
double | tmax_0 |
Time max (default). More... | |
double | tmin |
Time min (current). More... | |
double | tmin_0 |
Time min (default). More... | |
bool | usedate |
Flag to use a date format. More... | |
unsigned int | verbose |
Verbosity level. More... | |
Select trigger parameters.
This class is designed to operate a selection over trigger parameters: time, frequency, Q and SNR. For each parameter, the user can select a minimum, a maximum and a resolution. The resolution is the number of bins to cover the parameter range. The time is linearly binned while the other parameters are logarithmically binned. Once a selection is defined, pre-binned histograms can be extracted.
TriggerSelect::TriggerSelect | ( | const string | aName, |
const unsigned int | aVerbose = 0 |
||
) |
Constructor of the TriggerSelect class.
Single-bin selections.
[in] | aName | Selection name. |
[in] | aVerbose | Verbosity level. |
TriggerSelect::TriggerSelect | ( | ReadTriggers * | aTriggers, |
const unsigned int | aVerbose = 0 |
||
) |
Constructor of the TriggerSelect class.
The default selection is defined using the metadata (min/max) of the input ReadTriggers object. For each parameter the resolution is set to 1 bin. The selection is given the input Streams name.
[in] | aTriggers | Input triggers. |
[in] | aVerbose | Verbosity level. |
|
virtual |
Destructor of the TriggerSelect class.
|
inline |
Returns the cluster tag used for the selection.
|
inline |
Returns the maximal frequency value.
|
inline |
Returns the minimal frequency value.
|
inline |
Returns the frequency range value.
|
inline |
Returns the frequency resolution value.
|
inline |
Returns the maximal Q value.
|
inline |
Returns the minimal Q value.
|
inline |
Returns the Q range value.
|
inline |
Returns the Q resolution value.
|
inline |
Returns the maximal SNR value.
|
inline |
Returns the minimal SNR value.
|
inline |
Returns the SNR range value.
|
inline |
Returns the SNR resolution value.
TH1D * TriggerSelect::GetTH1D | ( | const string | aParameter | ) |
Returns an empty 1-D histogram binned in a given parameter.
[in] | aParameter | Parameter name. |
TH2D * TriggerSelect::GetTH2D | ( | const string | aParameterX, |
const string | aParameterY | ||
) |
Returns an empty 2-D histogram binned in a given combination of parameters.
[in] | aParameterX | Parameter name for X axis. |
[in] | aParameterY | Parameter name for Y axis. |
|
inline |
Returns the maximal time value.
|
inline |
Returns the minimal time value.
|
inline |
Returns the time range value.
|
inline |
Returns the time resolution value.
|
inline |
Returns the time stamp for this selection.
The minimum time for this selection is returned.
|
private |
Makes frequency binning (log).
|
private |
Makes Q binning (log).
|
private |
Makes SNR binning (log).
|
private |
Makes time binning (linear).
void TriggerSelect::PrintSelection | ( | void | ) |
Prints the current selection in the standard output.
void TriggerSelect::ResetSelection | ( | void | ) |
Resets the selection back to default.
|
inline |
Sets the maximal frequency value.
[in] | aMax | Maximal value. |
|
inline |
Sets the minimal frequency value.
[in] | aMin | Minimal value. |
|
inline |
Sets the frequency range.
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the frequency resolution.
[in] | aResolution | Resolution (number of bins). |
void TriggerSelect::SetFrequencySelection | ( | const unsigned int | aResolution, |
const double | aMin, | ||
const double | aMax | ||
) |
Sets the frequency selection.
[in] | aResolution | Resolution (number of bins). |
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the maximal Q value.
[in] | aMax | Maximal value. |
|
inline |
Sets the minimal Q value.
[in] | aMin | Minimal value. |
|
inline |
Sets the Q range.
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the Q resolution.
[in] | aResolution | Resolution (number of bins). |
void TriggerSelect::SetQSelection | ( | const unsigned int | aResolution, |
const double | aMin, | ||
const double | aMax | ||
) |
Sets the Q selection.
[in] | aResolution | Resolution (number of bins). |
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the maximal SNR value.
[in] | aMax | Maximal value. |
|
inline |
Sets the minimal SNR value.
[in] | aMin | Minimal value. |
|
inline |
Sets the SNR range.
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the SNR resolution.
[in] | aResolution | Resolution (number of bins). |
void TriggerSelect::SetSnrSelection | ( | const unsigned int | aResolution, |
const double | aMin, | ||
const double | aMax | ||
) |
Sets the SNR selection.
[in] | aResolution | Resolution (number of bins). |
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the maximal time value.
[in] | aMax | Maximal value. |
|
inline |
Sets the minimal time value.
[in] | aMin | Minimal value. |
|
inline |
Sets the time range.
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Sets the time resolution.
[in] | aResolution | Resolution (number of bins). |
void TriggerSelect::SetTimeSelection | ( | const unsigned int | aResolution, |
const double | aMin, | ||
const double | aMax | ||
) |
Sets the time selection.
[in] | aResolution | Resolution (number of bins). |
[in] | aMin | Minimal value. |
[in] | aMax | Maximal value. |
|
inline |
Use cluster tags.
[in] | aTag | Cluster tag. |
|
inline |
Use a date format for time axes.
|
inline |
Use a GPS format for time axes.
|
inline |
Use triggers.
|
private |
cluster tag: -1 for triggers.
|
private |
Frequency bins.
|
private |
Frequency max (current).
|
private |
Frequency max (default).
|
private |
Frequency min (current).
|
private |
Frequency min (default).
|
private |
Name.
|
private |
Number of frequency bins (current).
|
private |
Number of frequency bins (default).
|
private |
Number of Q bins (current).
|
private |
Number of Q bins (default).
|
private |
Number of SNR bins (current).
|
private |
Number of SNR bins (default).
|
private |
Number of time bins (current).
|
private |
Number of time bins (default).
|
private |
Q bins.
|
private |
Q max (current).
|
private |
Q max (default).
|
private |
Q min (current).
|
private |
Q min (default).
|
private |
SNR bins.
|
private |
SNR max (current).
|
private |
SNR max (default).
|
private |
SNR min (current).
|
private |
SNR min (default).
|
private |
Start time string. See MakeTbins().
|
private |
Time bins.
|
private |
Time max (current).
|
private |
Time max (default).
|
private |
Time min (current).
|
private |
Time min (default).
|
private |
Flag to use a date format.
|
private |
Verbosity level.