Select trigger parameters. More...

#include <TriggerSelect.h>

Collaboration diagram for TriggerSelect:

[legend]

Public Member Functions
int	GetClusterTag (void)
	Returns the cluster tag used for the selection.

double	GetFrequencyMax (void)
	Returns the maximal frequency value.

double	GetFrequencyMin (void)
	Returns the minimal frequency value.

double	GetFrequencyRange (void)
	Returns the frequency range value.

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

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

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

unsigned int	GetTimeResolution (void)
	Returns the time resolution value.

string	GetTimeStamp (void)
	Returns the time stamp for this selection.

void	ResetSelection (void)
	Resets 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 unsigned int aResolution)
	Sets the frequency resolution.

void	SetFrequencySelection (const unsigned 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 unsigned int aResolution)
	Sets the Q resolution.

void	SetQSelection (const unsigned 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 unsigned int aResolution)
	Sets the SNR resolution.

void	SetSnrSelection (const unsigned 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 unsigned int aResolution)
	Sets the time resolution.

void	SetTimeSelection (const unsigned int aResolution, const double aMin, const double aMax)
	Sets the time selection.

void	UseClusterTag (unsigned int aTag)
	Use cluster tags.

void	UseDateTime (void)
	Use a date format for time axes.

void	UseGpsTime (void)
	Use a GPS format for time axes.

void	UseTriggers (void)
	Use triggers.

Constructors and destructors
	TriggerSelect (const string aName, const unsigned int aVerbose=0)
	Constructor of the TriggerSelect class.

	TriggerSelect (ReadTriggers *aTriggers, const unsigned int aVerbose=0)
	Constructor of the TriggerSelect class.

virtual	~TriggerSelect (void)
	Destructor of the TriggerSelect class.

Private Member Functions
void	MakeFbins (void)
	Makes frequency binning (log).

void	MakeQbins (void)
	Makes Q binning (log).

void	MakeSbins (void)
	Makes SNR binning (log).

void	MakeTbins (void)
	Makes time binning (linear).

Private Attributes
int	clustertag
	cluster tag: -1 for triggers.

double *	fbins
	Frequency bins.

double	fmax
	Frequency max (current).

double	fmax_0
	Frequency max (default).

double	fmin
	Frequency min (current).

double	fmin_0
	Frequency min (default).

Monitor *	mon
	Class monitor.

string	name
	Name.

unsigned int	nfbins
	Number of frequency bins (current).

unsigned int	nfbins_0
	Number of frequency bins (default).

unsigned int	nqbins
	Number of Q bins (current).

unsigned int	nqbins_0
	Number of Q bins (default).

unsigned int	nsbins
	Number of SNR bins (current).

unsigned int	nsbins_0
	Number of SNR bins (default).

unsigned int	ntbins
	Number of time bins (current).

unsigned int	ntbins_0
	Number of time bins (default).

double *	qbins
	Q bins.

double	qmax
	Q max (current).

double	qmax_0
	Q max (default).

double	qmin
	Q min (current).

double	qmin_0
	Q min (default).

double *	sbins
	SNR bins.

double	smax
	SNR max (current).

double	smax_0
	SNR max (default).

double	smin
	SNR min (current).

double	smin_0
	SNR min (default).

string	sstart
	Start time string. See MakeTbins().

double *	tbins
	Time bins.

double	tmax
	Time max (current).

double	tmax_0
	Time max (default).

double	tmin
	Time min (current).

double	tmin_0
	Time min (default).

bool	usedate
	Flag to use a date format.

Detailed Description

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.

Author: Florent Robinet

Constructor & Destructor Documentation

◆ TriggerSelect() [1/2]

TriggerSelect::TriggerSelect	(	const string	aName,
		const unsigned int	aVerbose = `0`
	)

Constructor of the TriggerSelect class.

Single-bin selections.

Parameters

[in]	aName	Selection name.
[in]	aVerbose	Verbosity level.

◆ TriggerSelect() [2/2]

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.

Parameters

[in]	aTriggers	Input triggers.
[in]	aVerbose	Verbosity level.

◆ ~TriggerSelect()

TriggerSelect::~TriggerSelect ( void )

virtual

Destructor of the TriggerSelect class.

Member Function Documentation

◆ GetClusterTag()

int TriggerSelect::GetClusterTag ( void )

inline

Returns the cluster tag used for the selection.

Returns: -1 if triggers are used.

◆ GetFrequencyMax()

double TriggerSelect::GetFrequencyMax ( void )

inline

Returns the maximal frequency value.

◆ GetFrequencyMin()

double TriggerSelect::GetFrequencyMin ( void )

inline

Returns the minimal frequency value.

◆ GetFrequencyRange()

double TriggerSelect::GetFrequencyRange ( void )

inline

Returns the frequency range value.

◆ GetFrequencyResolution()

unsigned int TriggerSelect::GetFrequencyResolution ( void )

inline

Returns the frequency resolution value.

◆ GetQMax()

double TriggerSelect::GetQMax ( void )

inline

Returns the maximal Q value.

◆ GetQMin()

double TriggerSelect::GetQMin ( void )

inline

Returns the minimal Q value.

◆ GetQRange()

double TriggerSelect::GetQRange ( void )

inline

Returns the Q range value.

◆ GetQResolution()

unsigned int TriggerSelect::GetQResolution ( void )

inline

Returns the Q resolution value.

◆ GetSnrMax()

double TriggerSelect::GetSnrMax ( void )

inline

Returns the maximal SNR value.

◆ GetSnrMin()

double TriggerSelect::GetSnrMin ( void )

inline

Returns the minimal SNR value.

◆ GetSnrRange()

double TriggerSelect::GetSnrRange ( void )

inline

Returns the SNR range value.

◆ GetSnrResolution()

unsigned int TriggerSelect::GetSnrResolution ( void )

inline

Returns the SNR resolution value.

◆ GetTH1D()

TH1D * TriggerSelect::GetTH1D ( const string aParameter )

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

"Time",
"Frequency",
"Q",
"SNR".

Note: The user must delete the returned histogram.

Parameters

[in] aParameter Parameter name.

◆ GetTH2D()

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

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

"Time",
"Frequency",
"Q",
"SNR".

Note: The user must delete the returned histogram.

Parameters

[in]	aParameterX	Parameter name for X axis.
[in]	aParameterY	Parameter name for Y axis.

◆ GetTimeMax()

double TriggerSelect::GetTimeMax ( void )

inline

Returns the maximal time value.

◆ GetTimeMin()

double TriggerSelect::GetTimeMin ( void )

inline

Returns the minimal time value.

◆ GetTimeRange()

double TriggerSelect::GetTimeRange ( void )

inline

Returns the time range value.

◆ GetTimeResolution()

unsigned int TriggerSelect::GetTimeResolution ( void )

inline

Returns the time resolution value.

◆ GetTimeStamp()

string TriggerSelect::GetTimeStamp ( void )

inline

Returns the time stamp for this selection.

The minimum time for this selection is returned.

Returns: A date is returned if UseDateTime() was called, a GPS time is returned otherwise.

◆ MakeFbins()

void TriggerSelect::MakeFbins ( void )

private

Makes frequency binning (log).

◆ MakeQbins()

void TriggerSelect::MakeQbins ( void )

private

Makes Q binning (log).

◆ MakeSbins()

void TriggerSelect::MakeSbins ( void )

private

Makes SNR binning (log).

◆ MakeTbins()

void TriggerSelect::MakeTbins ( void )

private

Makes time binning (linear).

◆ ResetSelection()

void TriggerSelect::ResetSelection ( void )

Resets the selection back to default.

◆ SetFrequencyMax()

void TriggerSelect::SetFrequencyMax ( const double aMax )

inline

Sets the maximal frequency value.

Parameters

[in] aMax Maximal value.

◆ SetFrequencyMin()

void TriggerSelect::SetFrequencyMin ( const double aMin )

inline

Sets the minimal frequency value.

Parameters

[in] aMin Minimal value.

◆ SetFrequencyRange()

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

inline

Sets the frequency range.

Parameters

[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetFrequencyResolution()

void TriggerSelect::SetFrequencyResolution ( const unsigned int aResolution )

inline

Sets the frequency resolution.

Parameters

[in] aResolution Resolution (number of bins).

◆ SetFrequencySelection()

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

Sets the frequency selection.

Parameters

[in]	aResolution	Resolution (number of bins).
[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetQMax()

void TriggerSelect::SetQMax ( const double aMax )

inline

Sets the maximal Q value.

Parameters

[in] aMax Maximal value.

◆ SetQMin()

void TriggerSelect::SetQMin ( const double aMin )

inline

Sets the minimal Q value.

Parameters

[in] aMin Minimal value.

◆ SetQRange()

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

inline

Sets the Q range.

Parameters

[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetQResolution()

void TriggerSelect::SetQResolution ( const unsigned int aResolution )

inline

Sets the Q resolution.

Parameters

[in] aResolution Resolution (number of bins).

◆ SetQSelection()

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

Sets the Q selection.

Parameters

[in]	aResolution	Resolution (number of bins).
[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetSnrMax()

void TriggerSelect::SetSnrMax ( const double aMax )

inline

Sets the maximal SNR value.

Parameters

[in] aMax Maximal value.

◆ SetSnrMin()

void TriggerSelect::SetSnrMin ( const double aMin )

inline

Sets the minimal SNR value.

Parameters

[in] aMin Minimal value.

◆ SetSnrRange()

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

inline

Sets the SNR range.

Parameters

[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetSnrResolution()

void TriggerSelect::SetSnrResolution ( const unsigned int aResolution )

inline

Sets the SNR resolution.

Parameters

[in] aResolution Resolution (number of bins).

◆ SetSnrSelection()

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

Sets the SNR selection.

Parameters

[in]	aResolution	Resolution (number of bins).
[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetTimeMax()

void TriggerSelect::SetTimeMax ( const double aMax )

inline

Sets the maximal time value.

Parameters

[in] aMax Maximal value.

◆ SetTimeMin()

void TriggerSelect::SetTimeMin ( const double aMin )

inline

Sets the minimal time value.

Parameters

[in] aMin Minimal value.

◆ SetTimeRange()

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

inline

Sets the time range.

Parameters

[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ SetTimeResolution()

void TriggerSelect::SetTimeResolution ( const unsigned int aResolution )

inline

Sets the time resolution.

Parameters

[in] aResolution Resolution (number of bins).

◆ SetTimeSelection()

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

Sets the time selection.

Parameters

[in]	aResolution	Resolution (number of bins).
[in]	aMin	Minimal value.
[in]	aMax	Maximal value.

◆ UseClusterTag()

void TriggerSelect::UseClusterTag ( unsigned int aTag )

inline

Use cluster tags.

Warning: Only positive tags can be considered.

Parameters

[in] aTag Cluster tag.

◆ UseDateTime()

void TriggerSelect::UseDateTime ( void )

inline

Use a date format for time axes.

◆ UseGpsTime()

void TriggerSelect::UseGpsTime ( void )

inline

Use a GPS format for time axes.

◆ UseTriggers()

void TriggerSelect::UseTriggers ( void )

inline

Use triggers.

Member Data Documentation

◆ clustertag

int TriggerSelect::clustertag

private

cluster tag: -1 for triggers.

◆ fbins

double* TriggerSelect::fbins

private

Frequency bins.

◆ fmax

double TriggerSelect::fmax

private

Frequency max (current).

◆ fmax_0

double TriggerSelect::fmax_0

private

Frequency max (default).

◆ fmin

double TriggerSelect::fmin

private

Frequency min (current).

◆ fmin_0

double TriggerSelect::fmin_0

private

Frequency min (default).

◆ mon

Monitor* TriggerSelect::mon

private

Class monitor.

◆ name

string TriggerSelect::name

private

Name.

◆ nfbins

unsigned int TriggerSelect::nfbins

private

Number of frequency bins (current).

◆ nfbins_0

unsigned int TriggerSelect::nfbins_0

private

Number of frequency bins (default).

◆ nqbins

unsigned int TriggerSelect::nqbins

private

Number of Q bins (current).

◆ nqbins_0

unsigned int TriggerSelect::nqbins_0

private

Number of Q bins (default).

◆ nsbins

unsigned int TriggerSelect::nsbins

private

Number of SNR bins (current).

◆ nsbins_0

unsigned int TriggerSelect::nsbins_0

private

Number of SNR bins (default).

◆ ntbins

unsigned int TriggerSelect::ntbins

private

Number of time bins (current).

◆ ntbins_0

unsigned int TriggerSelect::ntbins_0

private

Number of time bins (default).

◆ qbins

double* TriggerSelect::qbins

private

Q bins.

◆ qmax

double TriggerSelect::qmax

private

Q max (current).

◆ qmax_0

double TriggerSelect::qmax_0

private

Q max (default).

◆ qmin

double TriggerSelect::qmin

private

Q min (current).

◆ qmin_0

double TriggerSelect::qmin_0

private

Q min (default).

◆ sbins

double* TriggerSelect::sbins

private

SNR bins.

◆ smax

double TriggerSelect::smax

private

SNR max (current).

◆ smax_0

double TriggerSelect::smax_0

private

SNR max (default).

◆ smin

double TriggerSelect::smin

private

SNR min (current).

◆ smin_0

double TriggerSelect::smin_0

private

SNR min (default).

◆ sstart

string TriggerSelect::sstart

private

Start time string. See MakeTbins().

◆ tbins

double* TriggerSelect::tbins

private

Time bins.

◆ tmax

double TriggerSelect::tmax

private

Time max (current).

◆ tmax_0

double TriggerSelect::tmax_0

private

Time max (default).

◆ tmin

double TriggerSelect::tmin

private

Time min (current).

◆ tmin_0

double TriggerSelect::tmin_0

private

Time min (default).

◆ usedate

bool TriggerSelect::usedate

private

Flag to use a date format.

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

src/Triggers/TriggerSelect.h
src/Triggers/TriggerSelect.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TriggerSelect() [1/2]

◆ TriggerSelect() [2/2]

◆ ~TriggerSelect()

Member Function Documentation

◆ GetClusterTag()

◆ GetFrequencyMax()

◆ GetFrequencyMin()

◆ GetFrequencyRange()

◆ GetFrequencyResolution()

◆ GetQMax()

◆ GetQMin()

◆ GetQRange()

◆ GetQResolution()

◆ GetSnrMax()

◆ GetSnrMin()

◆ GetSnrRange()

◆ GetSnrResolution()

◆ GetTH1D()

◆ GetTH2D()

◆ GetTimeMax()

◆ GetTimeMin()

◆ GetTimeRange()

◆ GetTimeResolution()

◆ GetTimeStamp()

◆ MakeFbins()

◆ MakeQbins()

◆ MakeSbins()

◆ MakeTbins()

◆ ResetSelection()

◆ SetFrequencyMax()

◆ SetFrequencyMin()

◆ SetFrequencyRange()

◆ SetFrequencyResolution()

◆ SetFrequencySelection()

◆ SetQMax()

◆ SetQMin()

◆ SetQRange()

◆ SetQResolution()

◆ SetQSelection()

◆ SetSnrMax()

◆ SetSnrMin()

◆ SetSnrRange()

◆ SetSnrResolution()

◆ SetSnrSelection()

◆ SetTimeMax()

◆ SetTimeMin()

◆ SetTimeRange()

◆ SetTimeResolution()

◆ SetTimeSelection()

◆ UseClusterTag()

◆ UseDateTime()

◆ UseGpsTime()

◆ UseTriggers()

Member Data Documentation

◆ clustertag

◆ fbins

◆ fmax

◆ fmax_0

◆ fmin

◆ fmin_0

◆ mon

◆ name

◆ nfbins

◆ nfbins_0

◆ nqbins

◆ nqbins_0

◆ nsbins

◆ nsbins_0

◆ ntbins

◆ ntbins_0

◆ qbins

◆ qmax

◆ qmax_0

◆ qmin

◆ qmin_0