TriggerSelect Class Reference

Select trigger parameters. More...

#include <TriggerSelect.h>

List of all members.

Public Member Functions
double	GetFrequencyMax (void)
	Returns the maximal frequency value.
double	GetFrequencyMin (void)
	Returns the minimal frequency value.
double	GetFrequencyRange (void)
	Returns the frequency range value.
int	GetFrequencyResolution (void)
	Returns the frequency resolution value.
double	GetQMax (void)
	Returns the maximal Q value.
double	GetQMin (void)
	Returns the minimal Q value.
double	GetQRange (void)
	Returns the Q range value.
int	GetQResolution (void)
	Returns the Q resolution value.
double	GetSNRMax (void)
	Returns the maximal SNR value.
double	GetSNRMin (void)
	Returns the minimal SNR value.
double	GetSNRRange (void)
	Returns the SNR range value.
int	GetSNRResolution (void)
	Returns the SNR resolution value.
TH1D *	GetTH1D (const string aParameter)
	Returns an empty 1-D histogram binned in a given parameter.
TH2D *	GetTH2D (const string aParameterX, const string aParameterY)
	Returns an empty 2-D histogram binned in a given combination of parameters.
double	GetTimeMax (void)
	Returns the maximal time value.
double	GetTimeMin (void)
	Returns the minimal time value.
double	GetTimeRange (void)
	Returns the time range value.
int	GetTimeResolution (void)
	Returns the time resolution value.
void	PrintSelection (void)
	Prints the current selection in the standard output.
void	ResetSelection (void)
	Resets all the selection back to default.
void	SetFrequencyMax (const double aMax)
	Sets the maximal frequency value.
void	SetFrequencyMin (const double aMin)
	Sets the minimal frequency value.
void	SetFrequencyRange (const double aMin, const double aMax)
	Sets the frequency range.
void	SetFrequencyResolution (const int aResolution)
	Sets the frequency resolution.
void	SetFrequencySelection (const int aResolution, const double aMin, const double aMax)
	Sets the frequency selection.
void	SetQMax (const double aMax)
	Sets the maximal Q value.
void	SetQMin (const double aMin)
	Sets the minimal Q value.
void	SetQRange (const double aMin, const double aMax)
	Sets the Q range.
void	SetQResolution (const int aResolution)
	Sets the Q resolution.
void	SetQSelection (const int aResolution, const double aMin, const double aMax)
	Sets the Q selection.
void	SetSNRMax (const double aMax)
	Sets the maximal SNR value.
void	SetSNRMin (const double aMin)
	Sets the minimal SNR value.
void	SetSNRRange (const double aMin, const double aMax)
	Sets the SNR range.
void	SetSNRResolution (const int aResolution)
	Sets the SNR resolution.
void	SetSNRSelection (const int aResolution, const double aMin, const double aMax)
	Sets the SNR selection.
void	SetTimeMax (const double aMax)
	Sets the maximal time value.
void	SetTimeMin (const double aMin)
	Sets the minimal time value.
void	SetTimeRange (const double aMin, const double aMax)
	Sets the time range.
void	SetTimeResolution (const int aResolution)
	Sets the time resolution.
void	SetTimeSelection (const int aResolution, const double aMin, const double aMax)
	Sets the time selection.
Constructors and destructors
	TriggerSelect (ReadTriggers *aTriggers, const int aVerbose=0)
	Constructor of the TriggerSelect class.
	TriggerSelect (const int aVerbose=0)
	Constructor of the TriggerSelect class.
virtual	~TriggerSelect (void)
	Destructor of the TriggerSelect class.

---

Detailed Description

Select trigger parameters.

This class was 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 used to bin a 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.

Author:

Florent Robinet

---

Constructor & Destructor Documentation

TriggerSelect::TriggerSelect

(

const int

aVerbose = 0

)

Constructor of the TriggerSelect class.

The default selection is:

• Time: 700,000,000 --> 2,000,000,000 (1 bins)
• Frequency: 1 --> 10000 (1 bins)
• Q: 1 --> 1000 (1 bins)
• SNR: 1 --> 1e+20 (1 bins)

  Parameters:

  aVerbose

  verbosity level

TriggerSelect::TriggerSelect	(	ReadTriggers *	aTriggers,
		const 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.

Parameters:

	aTriggers	input triggers
	aVerbose	verbosity level

TriggerSelect::~TriggerSelect

(

void

)

[virtual]

Destructor of the TriggerSelect class.

---

Member Function Documentation

double TriggerSelect::GetFrequencyMax

(

void

)

[inline]

Returns the maximal frequency value.

double TriggerSelect::GetFrequencyMin

(

void

)

[inline]

Returns the minimal frequency value.

double TriggerSelect::GetFrequencyRange

(

void

)

[inline]

Returns the frequency range value.

int TriggerSelect::GetFrequencyResolution

(

void

)

[inline]

Returns the frequency resolution value.

double TriggerSelect::GetQMax

(

void

)

[inline]

Returns the maximal Q value.

double TriggerSelect::GetQMin

(

void

)

[inline]

Returns the minimal Q value.

double TriggerSelect::GetQRange

(

void

)

[inline]

Returns the Q range value.

int TriggerSelect::GetQResolution

(

void

)

[inline]

Returns the Q resolution value.

double TriggerSelect::GetSNRMax

(

void

)

[inline]

Returns the maximal SNR value.

double TriggerSelect::GetSNRMin

(

void

)

[inline]

Returns the minimal SNR value.

double TriggerSelect::GetSNRRange

(

void

)

[inline]

Returns the SNR range value.

int TriggerSelect::GetSNRResolution

(

void

)

[inline]

Returns the SNR resolution value.

TH1D * TriggerSelect::GetTH1D

(

const string

aParameter

)

Returns an empty 1-D histogram binned in a given parameter.

'aParameter' can either be \"Time\", \"Frequency\", \"Q\" or \"SNR\". 'aParameter' is also used to name and title the histogram.

NULL is returned if this function fails.

Parameters:

aParameter

parameter name in which histograming

TH2D * TriggerSelect::GetTH2D	(	const string	aParameterX,
		const string	aParameterY
	)

Returns an empty 2-D histogram binned in a given combination of parameters.

'aParameterX/Y' can either be \"Time\", \"Frequency\", \"Q\" or \"SNR\". 'aParameterX/Y' are also used to name and title the histogram.

NULL is returned if this function fails.

Parameters:

	aParameterX	parameter name in which histograming along the X axis
	aParameterY	parameter name in which histograming along the Y axis

double TriggerSelect::GetTimeMax

(

void

)

[inline]

Returns the maximal time value.

double TriggerSelect::GetTimeMin

(

void

)

[inline]

Returns the minimal time value.

double TriggerSelect::GetTimeRange

(

void

)

[inline]

Returns the time range value.

int TriggerSelect::GetTimeResolution

(

void

)

[inline]

Returns the time resolution value.

void TriggerSelect::PrintSelection

(

void

)

Prints the current selection in the standard output.

void TriggerSelect::ResetSelection

(

void

)

Resets all the selection back to default.

void TriggerSelect::SetFrequencyMax

(

const double

aMax

)

Sets the maximal frequency value.

Parameters:

aMax

maximal value

void TriggerSelect::SetFrequencyMin

(

const double

aMin

)

Sets the minimal frequency value.

Parameters:

aMin

minimal value

void TriggerSelect::SetFrequencyRange	(	const double	aMin,
		const double	aMax
	)

Sets the frequency range.

Parameters:

	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetFrequencyResolution

(

const int

aResolution

)

Sets the frequency resolution.

Parameters:

aResolution

resolution

void TriggerSelect::SetFrequencySelection	(	const int	aResolution,
		const double	aMin,
		const double	aMax
	)

Sets the frequency selection.

Parameters:

	aResolution	resolution
	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetQMax

(

const double

aMax

)

Sets the maximal Q value.

Parameters:

aMax

maximal value

void TriggerSelect::SetQMin

(

const double

aMin

)

Sets the minimal Q value.

Parameters:

aMin

minimal value

void TriggerSelect::SetQRange	(	const double	aMin,
		const double	aMax
	)

Sets the Q range.

Parameters:

	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetQResolution

(

const int

aResolution

)

Sets the Q resolution.

Parameters:

aResolution

resolution

void TriggerSelect::SetQSelection	(	const int	aResolution,
		const double	aMin,
		const double	aMax
	)

Sets the Q selection.

Parameters:

	aResolution	resolution
	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetSNRMax

(

const double

aMax

)

Sets the maximal SNR value.

Parameters:

aMax

maximal value

void TriggerSelect::SetSNRMin

(

const double

aMin

)

Sets the minimal SNR value.

Parameters:

aMin

minimal value

void TriggerSelect::SetSNRRange	(	const double	aMin,
		const double	aMax
	)

Sets the SNR range.

Parameters:

	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetSNRResolution

(

const int

aResolution

)

Sets the SNR resolution.

Parameters:

aResolution

resolution

void TriggerSelect::SetSNRSelection	(	const int	aResolution,
		const double	aMin,
		const double	aMax
	)

Sets the SNR selection.

Parameters:

	aResolution	resolution
	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetTimeMax

(

const double

aMax

)

Sets the maximal time value.

Parameters:

aMax

maximal value

void TriggerSelect::SetTimeMin

(

const double

aMin

)

Sets the minimal time value.

Parameters:

aMin

minimal value

void TriggerSelect::SetTimeRange	(	const double	aMin,
		const double	aMax
	)

Sets the time range.

Parameters:

	aMin	minimal value
	aMax	maximal value

void TriggerSelect::SetTimeResolution

(

const int

aResolution

)

Sets the time resolution.

Parameters:

aResolution

resolution

void TriggerSelect::SetTimeSelection	(	const int	aResolution,
		const double	aMin,
		const double	aMax
	)

Sets the time selection.

Parameters:

	aResolution	resolution
	aMin	minimal value
	aMax	maximal value

---

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

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