Omicron  4.2.0
An algorithm to detect and characterize transient events in gravitational-wave detectors
Loading...
Searching...
No Matches
OxEvent.h
Go to the documentation of this file.
1
6#ifndef __OxEvent__
7#define __OxEvent__
8#include "OxCorr.h"
9
10using namespace std;
11
27class OxEvent: public OxCorr{
28
29public:
30
45 OxEvent(const string aOptionFile, const unsigned int aGpsRef);
46
50 virtual ~OxEvent(void);
51
63 bool CreateOutputFile(const unsigned int aTime);
64
73 bool SaveEvents(const UChar_t aAnalysisIndex = 0);
74
78 inline Long64_t GetEntries(void){ return oxe_tree_read->GetEntries(); };
79
86 int GetEntry(const Long64_t aEntry);
87
92 inline unsigned int GetSliceN(void){ return slice_n; };
93
98 inline unsigned int GetSliceTimeDelayBinsN(void){ return slice_nbins; };
99
105 inline unsigned int GetSliceUnusedTimeDelayBinsN(void){
107 };
108
113 inline double GetSliceHalfDuration(void){
115 };
116
123 inline double GetSliceTimeDelay(const unsigned int aSliceIndex){
124 return OxCorr::GetTimeDelay(slice_firstbin[aSliceIndex] + slice_nbins/2);
125 };
126
131 inline unsigned int GetSliceIndexCenter(void){
132 return (GetSliceN()-1)/2;
133 };
134
138 inline unsigned int GetEventSliceIndex(void){ return oxe_sindex; };
139
143 inline UChar_t GetEventAnalysisIndex(void){ return oxe_aindex; };
144
149 double GetEventRank(void);
150
155 double GetEventFrequency(void);
156
157private:
158
159 // TTree
160 TTree *oxe_tree;
162 UChar_t oxe_aindex;
163 unsigned int oxe_sindex;
164 double oxe_dt;
165 Long64_t oxe_oxo_0;
166 Long64_t oxe_oxo_1;
168 double *oxe_Xi_q;
169 unsigned int *oxe_n_sveto_q;
170 double *oxe_dt_var_q;
171
172 // SLICES
173 unsigned int slice_n;
174 unsigned int slice_nbins;
175 unsigned int *slice_firstbin;
177
178
179
184 void ComputeEvent(const unsigned int aSliceIndex);
185
202 void MakeSlices(void);
203
204
205 ClassDef(OxEvent,0)
206};
207
208
209#endif
210
211
Ox cross-correlation engine.
Ox cross-correlation engine.
Definition OxCorr.h:19
double GetTimeDelayResolution(void)
Returns the time-delay resolution [s].
Definition OxCorr.h:99
double GetTimeDelay(const unsigned int aTimeDelayBinIndex)
Returns the time delay of a bin in the cross-correlation map [s].
Definition OxCorr.h:90
unsigned int GetTimeDelayBinsN(void)
Returns the number of time-delay bins.
Definition OxCorr.h:81
Ox event management.
Definition OxEvent.h:27
double GetSliceHalfDuration(void)
Returns the half duration of one slice [s].
Definition OxEvent.h:113
void MakeSlices(void)
Slices a cross-correlation map.
Definition OxEvent.cc:359
double * oxe_dt_var_q
Event tree: time-delay variance [s^2] / Q.
Definition OxEvent.h:170
unsigned int slice_n
Number of slices in a cross-correlation map.
Definition OxEvent.h:173
int GetEntry(const Long64_t aEntry)
Loads an entry in the event TTree (read-only).
Definition OxEvent.cc:169
unsigned int * slice_firstbin
First time-delay bin index of each slice.
Definition OxEvent.h:175
unsigned int GetEventSliceIndex(void)
Returns the slice index for the current event.
Definition OxEvent.h:138
double * oxe_Xi_q
Event tree: /Q.
Definition OxEvent.h:168
Long64_t oxe_oxo_0
Event tree: Omicron TTree entry (det 0).
Definition OxEvent.h:165
double GetEventFrequency(void)
Returns the frequency for the current event [Hz].
Definition OxEvent.cc:207
bool CreateOutputFile(const unsigned int aTime)
Creates an ouput file.
Definition OxEvent.cc:100
void ComputeEvent(const unsigned int aSliceIndex)
Computes the event parameters.
Definition OxEvent.cc:222
double oxe_dt
Event tree: time delay [s].
Definition OxEvent.h:164
Long64_t GetEntries(void)
Returns the number of events (read-only).
Definition OxEvent.h:78
unsigned int GetSliceTimeDelayBinsN(void)
Returns the number of time-delay bins in one slice.
Definition OxEvent.h:98
unsigned int GetSliceUnusedTimeDelayBinsN(void)
Returns the number of unsed time-delay bins after slicing.
Definition OxEvent.h:105
int ** slice_ctn_binmax
Slice container: time-delay bin where xi is max / f row / Q.
Definition OxEvent.h:176
UChar_t GetEventAnalysisIndex(void)
Returns the analysis index for the current event.
Definition OxEvent.h:143
unsigned int slice_nbins
Number of time-delay bins in a slice.
Definition OxEvent.h:174
double * oxe_frequency_q
Event tree: frequency [Hz] / Q.
Definition OxEvent.h:167
double GetSliceTimeDelay(const unsigned int aSliceIndex)
Returns the time delay at the center of a slice [s].
Definition OxEvent.h:123
unsigned int * oxe_n_sveto_q
Event tree: number of frequency rows rejected by the slice veto / Q.
Definition OxEvent.h:169
double GetEventRank(void)
Returns the rank for the current event.
Definition OxEvent.cc:192
TTree * oxe_tree
Event tree. Do not delete as it is owned by the output file.
Definition OxEvent.h:160
OxEvent(const string aOptionFile, const unsigned int aGpsRef)
Constructor of the OxEvent class.
Long64_t oxe_oxo_1
Event tree: Omicron TTree entry (det 1).
Definition OxEvent.h:166
virtual ~OxEvent(void)
Destructor of the OxEvent class.
Definition OxEvent.cc:85
TChain * oxe_tree_read
TChain: Ox events (read-only).
Definition OxEvent.h:161
bool SaveEvents(const UChar_t aAnalysisIndex=0)
Save events in the TTree.
Definition OxEvent.cc:136
UChar_t oxe_aindex
Event tree: analysis index.
Definition OxEvent.h:162
unsigned int GetSliceN(void)
Returns the number of slices in one cross-correlation map.
Definition OxEvent.h:92
unsigned int GetSliceIndexCenter(void)
Returns the index of the slice at the center of the cross-correlation map.
Definition OxEvent.h:131
unsigned int oxe_sindex
Event tree: slice index.
Definition OxEvent.h:163