GWOLLUM
4.2.0
Tools for gravitational-wave analyses
|
Read a set of injections. More...
#include <InjRea.h>
Public Member Functions | |
double | GetInjectionAmplitude (void) |
Returns the current injection amplitude. More... | |
double | GetInjectionAmplitudeMax (const unsigned int aNameIndex) |
Returns the maximum injection amplitude. More... | |
double | GetInjectionAmplitudeMin (const unsigned int aNameIndex) |
Returns the minimum injection amplitude. More... | |
double | GetInjectionDec (void) |
Returns the current injection declination [rad]. More... | |
double | GetInjectionEccentricity (void) |
Returns the current injection eccentricity. More... | |
double | GetInjectionFrequency (void) |
Returns the current injection frequency [Hz]. More... | |
double | GetInjectionFrequencyMax (const unsigned int aNameIndex) |
Returns the maximum injection frequency [Hz]. More... | |
double | GetInjectionFrequencyMin (const unsigned int aNameIndex) |
Returns the minimum injection frequency [Hz]. More... | |
Long64_t | GetInjectionIndex (void) |
Returns the index of the current injection. More... | |
Long64_t | GetInjectionIndexAfter (const double aTime) |
Returns the index of the first injection after a given time. More... | |
string | GetInjectionName (const unsigned int aNameIndex) |
Returns a given injection name in the list. More... | |
string | GetInjectionName (void) |
Returns the current injection name. More... | |
unsigned int | GetInjectionNameIndex (void) |
Returns the current injection name index. More... | |
unsigned int | GetInjectionNameN (void) |
Returns the number of injection names. More... | |
TH1D * | GetInjectionParamDist (const string aParamName, const unsigned int aNbins=1, const string aBinType="UNIFORM") |
Returns the 1D distribution of an injection parameter. More... | |
double | GetInjectionPolarization (void) |
Returns the current injection polarization [rad]. More... | |
double | GetInjectionRa (void) |
Returns the current injection right-ascension [rad]. More... | |
double | GetInjectionSigma (void) |
Returns the current injection sigma [s]. More... | |
double | GetInjectionSigmaMax (const unsigned int aNameIndex) |
Returns the maximum injection sigma [s]. More... | |
double | GetInjectionSigmaMin (const unsigned int aNameIndex) |
Returns the minimum injection sigma [s]. More... | |
bool | GetInjectionTag (const Long64_t aInjIndex) |
Returns an injection tag. More... | |
bool | GetInjectionTag (void) |
Returns the current injection tag. More... | |
double | GetInjectionTime (void) |
Returns the current injection GPS time [s]. More... | |
double | GetInjectionTimeEnd (void) |
Returns the GPS ending time of the injection [s] at the center of the Earth. More... | |
double | GetInjectionTimeMax (const unsigned int aNameIndex) |
Returns the maximum injection GPS time. More... | |
double | GetInjectionTimeMin (const unsigned int aNameIndex) |
Returns the minimum injection GPS time. More... | |
double | GetInjectionTimeStart (void) |
Returns the GPS starting time of the injection [s] at the center of the Earth. More... | |
injtype | GetInjectionType (void) |
Returns the current injection type. More... | |
string | GetInputFilePattern (void) |
Returns the input file pattern provided in the constructor. More... | |
Long64_t | GetN (const unsigned int aNameIndex) |
Returns the number of injections of a given name. More... | |
Long64_t | GetN (void) |
Returns the number of injections. More... | |
double | GetSineGaussh0cross (void) |
Returns the SineGauss \(h_{\times rss}\) peak amplitude of current injection. More... | |
double | GetSineGaussh0plus (void) |
Returns the SineGauss \(h_{+rss}\) peak amplitude of current injection. More... | |
int | LoadInjection (const Long64_t aInjIndex) |
Loads a given injection. More... | |
void | SetInjectionTag (const bool aTag) |
Sets a new tag value to the current injection. More... | |
void | SetInjectionTag (const Long64_t aInjIndex, const bool aTag) |
Sets a new tag value to an injection. More... | |
Constructors and destructors | |
InjRea (const string aPattern, const unsigned int aVerbose=0) | |
Constructor of the InjRea class. More... | |
virtual | ~InjRea () |
Destructor of the InjRea class. More... | |
Protected Attributes | |
TChain * | InjTree |
Injection tree. More... | |
unsigned int | Verbose |
Verbosity level. More... | |
TGraph * | wave_hcross |
Waveform \(h_{\times}(t)\). More... | |
TGraph * | wave_hplus |
Waveform \(h_{+}(t)\). More... | |
Private Attributes | |
double | inj_amp |
Injection amplitude. More... | |
double * | inj_ampmax |
Amplitude max. More... | |
double * | inj_ampmin |
Amplitude min. More... | |
double | inj_dec |
Injection declination. More... | |
double | inj_ecc |
Injection eccentricity. More... | |
double | inj_f0 |
Injection frequency. More... | |
double * | inj_f0max |
Frequency max. More... | |
double * | inj_f0min |
Frequency min. More... | |
Long64_t | inj_index |
Current injection index. More... | |
double | inj_psi |
Injection polarization angle. More... | |
double | inj_ra |
Injection right ascension. More... | |
double | inj_sigma |
Injection sigma. More... | |
double * | inj_sigmamax |
Sigma max. More... | |
double * | inj_sigmamin |
Sigma min. More... | |
bool * | inj_tag |
Injection tags. More... | |
double | inj_time |
Injection time. More... | |
double * | inj_timemax |
Time max. More... | |
double * | inj_timemin |
Time min. More... | |
string | pattern |
Input file pattern. More... | |
TTreeIndex * | sort_index |
TTree index. More... | |
string * | wave_name |
Waveform name. More... | |
Long64_t * | wave_name_n |
vector< string > | wave_names |
List of waveform names. More... | |
UInt_t | wave_type |
Waveform type: see InjTyp.h. More... | |
TChain * | WaveTree |
Waveform tree. More... | |
Read a set of injections.
Injection parameters, generated with the InjGen class, are loaded.
InjRea::InjRea | ( | const string | aPattern, |
const unsigned int | aVerbose = 0 |
||
) |
|
virtual |
Destructor of the InjRea class.
|
inline |
Returns the current injection amplitude.
|
inline |
Returns the maximum injection amplitude.
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global maximum is returned. |
|
inline |
Returns the minimum injection amplitude.
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global minimum is returned. |
|
inline |
Returns the current injection declination [rad].
|
inline |
Returns the current injection eccentricity.
|
inline |
Returns the current injection frequency [Hz].
|
inline |
Returns the maximum injection frequency [Hz].
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global maximum is returned. |
|
inline |
Returns the minimum injection frequency [Hz].
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global minimum is returned. |
|
inline |
Returns the index of the current injection.
Long64_t InjRea::GetInjectionIndexAfter | ( | const double | aTime | ) |
Returns the index of the first injection after a given time.
[in] | aTime | Reference time [s]. |
|
inline |
Returns a given injection name in the list.
[in] | aNameIndex | Index in the list of names. |
|
inline |
Returns the current injection name.
|
inline |
Returns the current injection name index.
|
inline |
Returns the number of injection names.
TH1D * InjRea::GetInjectionParamDist | ( | const string | aParamName, |
const unsigned int | aNbins = 1 , |
||
const string | aBinType = "UNIFORM" |
||
) |
Returns the 1D distribution of an injection parameter.
[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". |
|
inline |
Returns the current injection polarization [rad].
|
inline |
Returns the current injection right-ascension [rad].
|
inline |
Returns the current injection sigma [s].
|
inline |
Returns the maximum injection sigma [s].
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global maximum is returned. |
|
inline |
Returns the minimum injection sigma [s].
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global minimum is returned. |
|
inline |
Returns an injection tag.
[in] | aInjIndex | Injection index. |
|
inline |
Returns the current injection tag.
|
inline |
Returns the current injection GPS time [s].
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:
|
inline |
Returns the maximum injection GPS time.
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global maximum is returned. |
|
inline |
Returns the minimum injection GPS time.
[in] | aNameIndex | Index in the list of names. If this index is out-of-range, the global minimum is returned. |
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:
|
inline |
Returns the current injection type.
|
inline |
Returns the input file pattern provided in the constructor.
|
inline |
Returns the number of injections of a given name.
[in] | aNameIndex | Index in the list of names. |
|
inline |
Returns the number of injections.
double InjRea::GetSineGaussh0cross | ( | void | ) |
Returns the SineGauss \(h_{\times rss}\) peak amplitude of current injection.
For details see K. Riles, LIGO-T040055-00
double InjRea::GetSineGaussh0plus | ( | void | ) |
Returns the SineGauss \(h_{+rss}\) peak amplitude of current injection.
For details see K. Riles, LIGO-T040055-00
int InjRea::LoadInjection | ( | const Long64_t | aInjIndex | ) |
Loads a given injection.
[in] | aInjIndex | Injection index. |
|
inline |
Sets a new tag value to the current injection.
[in] | aTag | New tag value. |
|
inline |
Sets a new tag value to an injection.
[in] | aInjIndex | Injection index. |
[in] | aTag | New tag value. |
|
private |
Injection amplitude.
|
private |
Amplitude max.
|
private |
Amplitude min.
|
private |
Injection declination.
|
private |
Injection eccentricity.
|
private |
Injection frequency.
|
private |
Frequency max.
|
private |
Frequency min.
|
private |
Current injection index.
|
private |
Injection polarization angle.
|
private |
Injection right ascension.
|
private |
Injection sigma.
|
private |
Sigma max.
|
private |
Sigma min.
|
private |
Injection tags.
|
private |
Injection time.
|
private |
Time max.
|
private |
Time min.
|
protected |
Injection tree.
|
private |
Input file pattern.
|
private |
TTree index.
|
protected |
Verbosity level.
|
protected |
Waveform \(h_{\times}(t)\).
|
protected |
Waveform \(h_{+}(t)\).
|
private |
Waveform name.
|
private |
|
private |
List of waveform names.
|
private |
Waveform type: see InjTyp.h.
|
private |
Waveform tree.