OxInj Class Reference

Manage injections for Ox analyses. More...

#include <OxInj.h>

Inheritance diagram for OxInj:

Collaboration diagram for OxInj:

Public Member Functions
unsigned int	GetDetectedN (const unsigned int aNameIndex)
	Returns the number of detected injections of a given name. More...
unsigned int	GetValidN (const unsigned int aNameIndex)
	Returns the number of valid injections of a given name. More...
void	Match (const Long64_t aEventEntry, const double aEventRank, const unsigned int aEventStartTime, const unsigned int aEventEndTime)
	Matches injections with an Ox event. More...
void	Process (const double aRankDetectionThreshold)
	Processes injections. More...
void	Reset (void)
	Resets the ijection set. More...
Constructors and destructors
	OxInj (const string aFilePattern, const unsigned int aNbins=20)
	Constructor of the OxInj class. More...
virtual	~OxInj (void)
	Destructor of the OxInj class. More...

Private Attributes
TH1D **	h1_inj_amp_det
	Detected injection amplitude distribution /injection name. More...
TH1D **	h1_inj_amp_tot
	Injection amplitude distribution /injection name. More...
TH1D **	h1_inj_freq_det
	Detected frequency amplitude distribution /injection name. More...
TH1D **	h1_inj_freq_tot
	Injection frequency distribution /injection name. More...
TH1D **	h1_inj_time_det
	Detected time amplitude distribution /injection name. More...
TH1D **	h1_inj_time_tot
	Injection time distribution /injection name. More...
Long64_t *	inj_entry
	List of event entries. More...
double *	inj_rk
	List of event ranks. More...

Detailed Description

Manage injections for Ox analyses.

This class is used to recover injections in a set of Ox events. After constructing the object:

• Call Match() to associate Ox events to injections.
• Call Process() to detect injections, fixing the false-alarm rate threshold.
• Call Print() to print the results.

Constructor & Destructor Documentation

OxInj()

OxInj::OxInj	(	const string	aFilePattern,
		const unsigned int	aNbins = 20
	)

Constructor of the OxInj class.

The list of injections must be provided as a set of ROOT files generated with the GWOLLUM/InjGen class. Injections are loaded and they can be accessed with the GWOLLUM/InjRea class methods.

In this constructor, parameter histograms are initialized for each waveform name:

• Injection amplitude distribution (log scale)
• Injection frequency distribution (log scale)
• Injection time distribution (linear scale)

  Parameters

  [in]	aFilePattern	File pattern pointing to ROOT files with injections (GWOLLUM/InjGen).
  [in]	aNbins	Number of bins in the parameter histograms.

~OxInj()

OxInj::~OxInj ( void  )

virtual

Destructor of the OxInj class.

Member Function Documentation

GetDetectedN()

unsigned int OxInj::GetDetectedN ( const unsigned int  aNameIndex )

inline

Returns the number of detected injections of a given name.

Parameters

[in]

aNameIndex

Injection name index.

Precondition

The injection name index must be valid.

GetValidN()

unsigned int OxInj::GetValidN ( const unsigned int  aNameIndex )

inline

Returns the number of valid injections of a given name.

Parameters

[in]

aNameIndex

Injection name index.

Precondition

The injection name index must be valid.

Match()

void OxInj::Match	(	const Long64_t	aEventEntry,
		const double	aEventRank,
		const unsigned int	aEventStartTime,
		const unsigned int	aEventEndTime
	)

Matches injections with an Ox event.

An injection is set as valid (injection tag = true) if the injection time is found in the event time range. If more than one event matches an injection, the best event rank is associated to the injection.

Warning

The geocentric time of the injection is considered. In other words, we neglect the time propagation to the detector sites.

Parameters

[in]	aEventEntry	Event entry number.
[in]	aEventRank	Event rank.
[in]	aEventStartTime	Event start GPS time [s].
[in]	aEventEndTime	Event end GPS time [s].

Process()

void OxInj::Process

(

const double

aRankDetectionThreshold

)

Processes injections.

After injections have been matched to Ox events with Match(), call this function to detect injections and fill plots.

An injection is detected if the associated event rank value is above the detection threshold.

Parameters

[in]

aRankDetectionThreshold

Detection threshold on the event rank.

Reset()

void OxInj::Reset

(

void

)

Resets the ijection set.

The event matching is reset and all histograms are reset.

Member Data Documentation

h1_inj_amp_det

TH1D** OxInj::h1_inj_amp_det

private

Detected injection amplitude distribution /injection name.

h1_inj_amp_tot

TH1D** OxInj::h1_inj_amp_tot

private

Injection amplitude distribution /injection name.

h1_inj_freq_det

TH1D** OxInj::h1_inj_freq_det

private

Detected frequency amplitude distribution /injection name.

h1_inj_freq_tot

TH1D** OxInj::h1_inj_freq_tot

private

Injection frequency distribution /injection name.

h1_inj_time_det

TH1D** OxInj::h1_inj_time_det

private

Detected time amplitude distribution /injection name.

h1_inj_time_tot

TH1D** OxInj::h1_inj_time_tot

private

Injection time distribution /injection name.

inj_entry

Long64_t* OxInj::inj_entry

private

List of event entries.

inj_rk

double* OxInj::inj_rk

private

List of event ranks.

---

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

• src/OxInj.h
• src/OxInj.cc