Read a set of injections. More...

#include <InjRea.h>

Inheritance diagram for InjRea:

Collaboration diagram for InjRea:

[legend]

Public Member Functions
Long64_t	GetFirstInjectionIndexEndAfter (const double aTime)
	Returns the index of the first injection ending after a given time.

double	GetInjectionAmplitude (void)
	Returns the current injection amplitude.

double	GetInjectionAmplitudeMax (const unsigned int aNameIndex)
	Returns the maximum injection amplitude.

double	GetInjectionAmplitudeMin (const unsigned int aNameIndex)
	Returns the minimum injection amplitude.

double	GetInjectionDec (void)
	Returns the current injection declination [rad].

double	GetInjectionEccentricity (void)
	Returns the current injection eccentricity.

double	GetInjectionFrequency (void)
	Returns the current injection frequency [Hz].

double	GetInjectionFrequencyMax (const unsigned int aNameIndex)
	Returns the maximum injection frequency [Hz].

double	GetInjectionFrequencyMin (const unsigned int aNameIndex)
	Returns the minimum injection frequency [Hz].

Long64_t	GetInjectionIndex (void)
	Returns the index of the current injection.

Long64_t	GetInjectionIndexAfter (const double aTime)
	Returns the index of the first injection after a given time.

string	GetInjectionName (const unsigned int aNameIndex)
	Returns a given injection name in the list.

string	GetInjectionName (void)
	Returns the current injection name.

unsigned int	GetInjectionNameIndex (void)
	Returns the current injection name index.

unsigned int	GetInjectionNameN (void)
	Returns the number of injection names.

TH1D *	GetInjectionParamDist (const string aParamName, const unsigned int aNbins=1, const string aBinType="UNIFORM")
	Returns the 1D distribution of an injection parameter.

double	GetInjectionPolarization (void)
	Returns the current injection polarization [rad].

double	GetInjectionRa (void)
	Returns the current injection right-ascension [rad].

double	GetInjectionSigma (void)
	Returns the current injection sigma [s].

double	GetInjectionSigmaMax (const unsigned int aNameIndex)
	Returns the maximum injection sigma [s].

double	GetInjectionSigmaMin (const unsigned int aNameIndex)
	Returns the minimum injection sigma [s].

bool	GetInjectionTag (const Long64_t aInjIndex)
	Returns an injection tag.

bool	GetInjectionTag (void)
	Returns the current injection tag.

double	GetInjectionTime (void)
	Returns the current injection GPS time [s].

double	GetInjectionTimeEnd (void)
	Returns the GPS ending time of the injection [s] at the center of the Earth.

double	GetInjectionTimeMax (const unsigned int aNameIndex)
	Returns the maximum injection GPS time.

double	GetInjectionTimeMin (const unsigned int aNameIndex)
	Returns the minimum injection GPS time.

double	GetInjectionTimeStart (void)
	Returns the GPS starting time of the injection [s] at the center of the Earth.

injtype	GetInjectionType (void)
	Returns the current injection type.

string	GetInputFilePattern (void)
	Returns the input file pattern provided in the constructor.

Long64_t	GetLastInjectionIndexStartBefore (const double aTime)
	Returns the index of the last injection starting before a given time.

Long64_t	GetN (const unsigned int aNameIndex)
	Returns the number of injections of a given name.

Long64_t	GetN (void)
	Returns the number of injections.

double	GetSineGaussh0cross (void)
	Returns the SineGauss \(h_{\times rss}\) peak amplitude of current injection.

double	GetSineGaussh0plus (void)
	Returns the SineGauss \(h_{+rss}\) peak amplitude of current injection.

int	LoadInjection (const Long64_t aInjIndex)
	Loads a given injection.

void	SetInjectionTag (const bool aTag)
	Sets a new tag value to the current injection.

void	SetInjectionTag (const Long64_t aInjIndex, const bool aTag)
	Sets a new tag value to an injection.

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

virtual	~InjRea ()
	Destructor of the InjRea class.

Protected Attributes
TChain *	InjTree
	Injection tree.

Monitor *	mon
	Class monitor.

TGraph *	wave_hcross
	Waveform \(h_{\times}(t)\).

TGraph *	wave_hplus
	Waveform \(h_{+}(t)\).

Private Attributes
double	inj_amp
	Injection amplitude.

double *	inj_ampmax
	Amplitude max.

double *	inj_ampmin
	Amplitude min.

double	inj_dec
	Injection declination.

double	inj_durmax_m
	Maximum injection duration before inj_time.

double	inj_durmax_p
	Maximum injection duration after inj_time.

double	inj_ecc
	Injection eccentricity.

double	inj_f0
	Injection frequency.

double *	inj_f0max
	Frequency max.

double *	inj_f0min
	Frequency min.

Long64_t	inj_index
	Current injection index.

double	inj_psi
	Injection polarization angle.

double	inj_ra
	Injection right ascension.

double	inj_sigma
	Injection sigma.

double *	inj_sigmamax
	Sigma max.

double *	inj_sigmamin
	Sigma min.

bool *	inj_tag
	Injection tags.

double	inj_time
	Injection time.

double *	inj_timemax
	Time max.

double *	inj_timemin
	Time min.

string	pattern
	Input file pattern.

TTreeIndex *	sort_index
	TTree index.

string *	wave_name
	Waveform name.

Long64_t *	wave_name_n

vector< string >	wave_names
	List of waveform names.

UInt_t	wave_type
	Waveform type: see InjTyp.h.

TChain *	WaveTree
	Waveform tree.

Detailed Description

Read a set of injections.

Injection parameters, generated with the InjGen class, are loaded.

Author: Florent Robinet

Constructor & Destructor Documentation

◆ InjRea()

InjRea::InjRea	(	const string	aPattern,
		const unsigned int	aVerbose = `0`
	)

Constructor of the InjRea class.

Injections in ROOT files designated by a file pattern are loaded. Each injection is tagged to 'true' by default. Injection files must be generated with the InjGen class.

Parameters

aPattern	Injection file pattern.
aVerbose	Verbosity level.

◆ ~InjRea()

InjRea::~InjRea ( void )

virtual

Destructor of the InjRea class.

Member Function Documentation

◆ GetFirstInjectionIndexEndAfter()

Long64_t InjRea::GetFirstInjectionIndexEndAfter ( const double aTime )

inline

Returns the index of the first injection ending after a given time.

This function is meant to be used for optimizing for loops over injections overlapping a given time segment. It returns the index of the first injection to consider to cover a time segment. This is an approximation as it considers the maximum duration of all injections to find the first injection: the user must test the injection boundaries (with GetInjectionTimeStart() and GetInjectionTimeEnd()) before injecting in the segment.

Note: The found injection is loaded.

See also: GetLastInjectionIndexStartBefore().

Returns: If no injections are found, the first injection is returned.

Parameters

[in] aTime Reference time [s].

◆ GetInjectionAmplitude()

double InjRea::GetInjectionAmplitude ( void )

inline

Returns the current injection amplitude.

◆ GetInjectionAmplitudeMax()

double InjRea::GetInjectionAmplitudeMax ( const unsigned int aNameIndex )

inline

Returns the maximum injection amplitude.

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global maximum is returned.

◆ GetInjectionAmplitudeMin()

double InjRea::GetInjectionAmplitudeMin ( const unsigned int aNameIndex )

inline

Returns the minimum injection amplitude.

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global minimum is returned.

◆ GetInjectionDec()

double InjRea::GetInjectionDec ( void )

inline

Returns the current injection declination [rad].

◆ GetInjectionEccentricity()

double InjRea::GetInjectionEccentricity ( void )

inline

Returns the current injection eccentricity.

◆ GetInjectionFrequency()

double InjRea::GetInjectionFrequency ( void )

inline

Returns the current injection frequency [Hz].

◆ GetInjectionFrequencyMax()

double InjRea::GetInjectionFrequencyMax ( const unsigned int aNameIndex )

inline

Returns the maximum injection frequency [Hz].

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global maximum is returned.

◆ GetInjectionFrequencyMin()

double InjRea::GetInjectionFrequencyMin ( const unsigned int aNameIndex )

inline

Returns the minimum injection frequency [Hz].

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global minimum is returned.

◆ GetInjectionIndex()

Long64_t InjRea::GetInjectionIndex ( void )

inline

Returns the index of the current injection.

◆ GetInjectionIndexAfter()

Long64_t InjRea::GetInjectionIndexAfter ( const double aTime )

Returns the index of the first injection after a given time.

Note: The found injection is loaded.

Returns: If no injections are found after the reference time, the number of injections is returned and the last injection is loaded.

Parameters

[in] aTime Reference time [s].

◆ GetInjectionName() [1/2]

string InjRea::GetInjectionName ( const unsigned int aNameIndex )

inline

Returns a given injection name in the list.

Parameters

[in] aNameIndex Index in the list of names.

Precondition: The input index must be smaller than GetInjectionNameN().

◆ GetInjectionName() [2/2]

string InjRea::GetInjectionName ( void )

inline

Returns the current injection name.

◆ GetInjectionNameIndex()

unsigned int InjRea::GetInjectionNameIndex ( void )

inline

Returns the current injection name index.

◆ GetInjectionNameN()

unsigned int InjRea::GetInjectionNameN ( void )

inline

Returns the number of injection names.

◆ GetInjectionParamDist()

TH1D * InjRea::GetInjectionParamDist	(	const string	aParamName,
		const unsigned int	aNbins = `1`,
		const string	aBinType = `"UNIFORM"`
	)

Returns the 1D distribution of an injection parameter.

Note: The returned histograms must be deleted by the user.

Warning: Only injections tagged to true are considered.

Parameters

[in]	aParamName	Parameter name. Currently supported: "amplitude" and "f0".
[in]	aNbins	Number of bins (must be >0).
[in]	aBinType	Binning type. Currently supported: "UNIFORM" and "LOG".

◆ GetInjectionPolarization()

double InjRea::GetInjectionPolarization ( void )

inline

Returns the current injection polarization [rad].

◆ GetInjectionRa()

double InjRea::GetInjectionRa ( void )

inline

Returns the current injection right-ascension [rad].

◆ GetInjectionSigma()

double InjRea::GetInjectionSigma ( void )

inline

Returns the current injection sigma [s].

◆ GetInjectionSigmaMax()

double InjRea::GetInjectionSigmaMax ( const unsigned int aNameIndex )

inline

Returns the maximum injection sigma [s].

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global maximum is returned.

◆ GetInjectionSigmaMin()

double InjRea::GetInjectionSigmaMin ( const unsigned int aNameIndex )

inline

Returns the minimum injection sigma [s].

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global minimum is returned.

◆ GetInjectionTag() [1/2]

bool InjRea::GetInjectionTag ( const Long64_t aInjIndex )

inline

Returns an injection tag.

Parameters

[in] aInjIndex Injection index.

◆ GetInjectionTag() [2/2]

bool InjRea::GetInjectionTag ( void )

inline

Returns the current injection tag.

◆ GetInjectionTime()

double InjRea::GetInjectionTime ( void )

inline

Returns the current injection GPS time [s].

◆ GetInjectionTimeEnd()

double InjRea::GetInjectionTimeEnd ( void )

Returns the GPS ending time of the injection [s] at the center of the Earth.

It depends on the type of waveform:

Sine-Gaussian waveform: this is ::sinegauss_duration_nsigma sigmas after the injection time.
User-defined waveform: end time of the \(h_{+}\) time series relatively to the injection time.

Returns: 0 if the waveform type is unknown.

◆ GetInjectionTimeMax()

double InjRea::GetInjectionTimeMax ( const unsigned int aNameIndex )

inline

Returns the maximum injection GPS time.

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global maximum is returned.

◆ GetInjectionTimeMin()

double InjRea::GetInjectionTimeMin ( const unsigned int aNameIndex )

inline

Returns the minimum injection GPS time.

Parameters

[in] aNameIndex Index in the list of names. If this index is out-of-range, the global minimum is returned.

◆ GetInjectionTimeStart()

double InjRea::GetInjectionTimeStart ( void )

Returns the GPS starting time of the injection [s] at the center of the Earth.

It depends on the type of waveform:

Sine-Gaussian waveform: this is ::sinegauss_duration_nsigma sigmas before the injection time.
User-defined waveform: start time of the \(h_{+}\) time series relatively to the injection time.

Returns: 0 if the waveform type is unknown.

◆ GetInjectionType()

injtype InjRea::GetInjectionType ( void )

inline

Returns the current injection type.

◆ GetInputFilePattern()

string InjRea::GetInputFilePattern ( void )

inline

Returns the input file pattern provided in the constructor.

◆ GetLastInjectionIndexStartBefore()

Long64_t InjRea::GetLastInjectionIndexStartBefore ( const double aTime )

inline

Returns the index of the last injection starting before a given time.

This function is meant to be used for optimizing for loops over injections overlapping a given time segment. It returns the index of the last injection to consider to cover a time segment. This injection actually starts after the given time: this is where to stop the loop. This is an approximation as it considers the maximum duration of all injections to find the last injection: the user must test the injection boundaries (with GetInjectionTimeStart() and GetInjectionTimeEnd()) before injecting in the segment.

Note: The found injection is loaded.

See also: GetFirstInjectionIndexEndAfter().

Returns: If no injections are found, the number of injections is returned and the last injection is loaded.

Parameters

[in] aTime Reference time [s].

◆ GetN() [1/2]

Long64_t InjRea::GetN ( const unsigned int aNameIndex )

inline

Returns the number of injections of a given name.

Parameters

[in] aNameIndex Index in the list of names.

◆ GetN() [2/2]

Long64_t InjRea::GetN ( void )

inline

Returns the number of injections.

◆ GetSineGaussh0cross()

double InjRea::GetSineGaussh0cross ( void )

Returns the SineGauss \(h_{\times rss}\) peak amplitude of current injection.

For details see K. Riles, LIGO-T040055-00

◆ GetSineGaussh0plus()

double InjRea::GetSineGaussh0plus ( void )

Returns the SineGauss \(h_{+rss}\) peak amplitude of current injection.

For details see K. Riles, LIGO-T040055-00

◆ LoadInjection()

int InjRea::LoadInjection ( const Long64_t aInjIndex )

Loads a given injection.

Returns: The function returns the number of bytes read from the input buffer. If entry does not exist or if an I/O error occurs, the function returns 0.

Parameters

[in] aInjIndex Injection index.

◆ SetInjectionTag() [1/2]

void InjRea::SetInjectionTag ( const bool aTag )

inline

Sets a new tag value to the current injection.

Parameters

[in] aTag New tag value.

◆ SetInjectionTag() [2/2]

void InjRea::SetInjectionTag	(	const Long64_t	aInjIndex,
		const bool	aTag
	)

inline

Sets a new tag value to an injection.

Parameters

[in]	aInjIndex	Injection index.
[in]	aTag	New tag value.

Member Data Documentation

◆ inj_amp

double InjRea::inj_amp

private

Injection amplitude.

◆ inj_ampmax

double* InjRea::inj_ampmax

private

Amplitude max.

◆ inj_ampmin

double* InjRea::inj_ampmin

private

Amplitude min.

◆ inj_dec

double InjRea::inj_dec

private

Injection declination.

◆ inj_durmax_m

double InjRea::inj_durmax_m

private

Maximum injection duration before inj_time.

◆ inj_durmax_p

double InjRea::inj_durmax_p

private

Maximum injection duration after inj_time.

◆ inj_ecc

double InjRea::inj_ecc

private

Injection eccentricity.

◆ inj_f0

double InjRea::inj_f0

private

Injection frequency.

◆ inj_f0max

double* InjRea::inj_f0max

private

Frequency max.

◆ inj_f0min

double* InjRea::inj_f0min

private

Frequency min.

◆ inj_index

Long64_t InjRea::inj_index

private

Current injection index.

◆ inj_psi

double InjRea::inj_psi

private

Injection polarization angle.

◆ inj_ra

double InjRea::inj_ra

private

Injection right ascension.

◆ inj_sigma

double InjRea::inj_sigma

private

Injection sigma.

◆ inj_sigmamax

double* InjRea::inj_sigmamax

private

Sigma max.

◆ inj_sigmamin

double* InjRea::inj_sigmamin

private

Sigma min.

◆ inj_tag

bool* InjRea::inj_tag

private

Injection tags.

◆ inj_time

double InjRea::inj_time

private

Injection time.

◆ inj_timemax

double* InjRea::inj_timemax

private

Time max.

◆ inj_timemin

double* InjRea::inj_timemin

private

Time min.

◆ InjTree

TChain* InjRea::InjTree

protected

Injection tree.

◆ mon

Monitor* InjRea::mon

protected

Class monitor.

◆ pattern

string InjRea::pattern

private

Input file pattern.

◆ sort_index

TTreeIndex* InjRea::sort_index

private

TTree index.

◆ wave_hcross

TGraph* InjRea::wave_hcross

protected

Waveform \(h_{\times}(t)\).

◆ wave_hplus

TGraph* InjRea::wave_hplus

protected

Waveform \(h_{+}(t)\).

◆ wave_name

string* InjRea::wave_name

private

Waveform name.

◆ wave_name_n

Long64_t* InjRea::wave_name_n

private

◆ wave_names

vector<string> InjRea::wave_names

private

List of waveform names.

◆ wave_type

UInt_t InjRea::wave_type

private

Waveform type: see InjTyp.h.

◆ WaveTree

TChain* InjRea::WaveTree

private

Waveform tree.

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

src/Inject/InjRea.h
src/Inject/InjRea.cc

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InjRea()

◆ ~InjRea()

Member Function Documentation

◆ GetFirstInjectionIndexEndAfter()

◆ GetInjectionAmplitude()

◆ GetInjectionAmplitudeMax()

◆ GetInjectionAmplitudeMin()

◆ GetInjectionDec()

◆ GetInjectionEccentricity()

◆ GetInjectionFrequency()

◆ GetInjectionFrequencyMax()

◆ GetInjectionFrequencyMin()

◆ GetInjectionIndex()

◆ GetInjectionIndexAfter()

◆ GetInjectionName() [1/2]

◆ GetInjectionName() [2/2]

◆ GetInjectionNameIndex()

◆ GetInjectionNameN()

◆ GetInjectionParamDist()

◆ GetInjectionPolarization()

◆ GetInjectionRa()

◆ GetInjectionSigma()

◆ GetInjectionSigmaMax()

◆ GetInjectionSigmaMin()

◆ GetInjectionTag() [1/2]

◆ GetInjectionTag() [2/2]

◆ GetInjectionTime()

◆ GetInjectionTimeEnd()

◆ GetInjectionTimeMax()

◆ GetInjectionTimeMin()

◆ GetInjectionTimeStart()

◆ GetInjectionType()

◆ GetInputFilePattern()

◆ GetLastInjectionIndexStartBefore()

◆ GetN() [1/2]

◆ GetN() [2/2]

◆ GetSineGaussh0cross()

◆ GetSineGaussh0plus()

◆ LoadInjection()

◆ SetInjectionTag() [1/2]

◆ SetInjectionTag() [2/2]

Member Data Documentation

◆ inj_amp

◆ inj_ampmax

◆ inj_ampmin

◆ inj_dec

◆ inj_durmax_m

◆ inj_durmax_p

◆ inj_ecc

◆ inj_f0

◆ inj_f0max

◆ inj_f0min

◆ inj_index

◆ inj_psi

◆ inj_ra

◆ inj_sigma

◆ inj_sigmamax

◆ inj_sigmamin

◆ inj_tag

◆ inj_time

◆ inj_timemax

◆ inj_timemin

◆ InjTree

◆ mon

◆ pattern

◆ sort_index

◆ wave_hcross

◆ wave_hplus

◆ wave_name

◆ wave_name_n

◆ wave_names

◆ wave_type

◆ WaveTree