![]() |
Common analysis format between UCorrelator and Acclaim. More...
#include <AnitaEventSummary.h>
Classes | |
class | ChannelInfo |
class | EventFlags |
class | MCTruth |
class | PayloadLocation |
class | PointingHypothesis |
class | SourceHypothesis |
class | WaveformInfo |
Stores information about a coherently summed waveform (filtered/unfiltered/deconvolved) The coherent summing of the waveform corresponds to a direction stored in a PointingHypothesis Units are assumed to be in mV, ns,and GHz. More... | |
Public Member Functions | |
AnitaEventSummary () | |
Reduced GPS data. More... | |
AnitaEventSummary (const RawAnitaHeader *header) | |
Constructor. More... | |
AnitaEventSummary (const RawAnitaHeader *header, UsefulAdu5Pat *pat, const TruthAnitaEvent *truth=0) | |
Constructor. More... | |
void | setTriggerInfomation (const RawAnitaHeader *header) |
void | setSourceInformation (UsefulAdu5Pat *pat, const TruthAnitaEvent *truth=0) |
void | zeroInternals () |
Bool_t | update () const |
AnitaPol::AnitaPol_t | highestPol () const |
Int_t | highestPolAsInt () const |
Int_t | highestPeakInd () const |
const PointingHypothesis & | highestPeak () const |
const WaveformInfo & | highestCoherent () const |
const WaveformInfo & | highestDeconvolved () const |
const WaveformInfo & | highestCoherentFiltered () const |
const WaveformInfo & | highestDeconvolvedFiltered () const |
AnitaPol::AnitaPol_t | mostImpulsivePol (int whichMetric=0) const |
value between 0 and 1, will find the brightest peak that is within threshold as impulsive as the most impulsive peak More... | |
Int_t | mostImpulsivePolAsInt (int whichMetric=0) const |
Int_t | mostImpulsiveInd (int whichMetric=0) const |
const PointingHypothesis & | mostImpulsivePeak (int whichMetric=0) const |
const WaveformInfo & | mostImpulsiveCoherent (int whichMetric=0) const |
const WaveformInfo & | mostImpulsiveDeconvolved (int whichMetric=0) const |
const WaveformInfo & | mostImpulsiveCoherentFiltered (int whichMetric=0) const |
const WaveformInfo & | mostImpulsiveDeconvolvedFiltered (int whichMetric=0) const |
Double_t | weight () |
AnitaPol::AnitaPol_t | trainingPol () const |
Return the weight of the event, always returns 1 for data, the weight from MCTruth otherwise. More... | |
Int_t | trainingPolAsInt () const |
Int_t | trainingPeakInd () const |
const PointingHypothesis & | trainingPeak () const |
const WaveformInfo & | trainingCoherent () const |
const WaveformInfo & | trainingDeconvolved () const |
const WaveformInfo & | trainingCoherentFiltered () const |
const WaveformInfo & | trainingDeconvolvedFiltered () const |
Int_t | countChannelAboveThreshold (int threshold=100) const |
Static Public Member Functions | |
static void | setThresholdForMostImpulsive (double threshold) |
Public Attributes | |
Int_t | run |
UInt_t | eventNumber |
Run. | |
UInt_t | realTime |
Event number. | |
Int_t | nPeaks [AnitaPol::kNotAPol] |
Time of the event. | |
PointingHypothesis | peak [AnitaPol::kNotAPol][maxDirectionsPerPol] |
Number of peaks stored in this AnitaEventSummary (might be less than maxDirectionsPerPol) | |
WaveformInfo | coherent [AnitaPol::kNotAPol][maxDirectionsPerPol] |
Summaries of the event peak directions (indices of all WaveformInfo member arrays match peak index) | |
WaveformInfo | deconvolved [AnitaPol::kNotAPol][maxDirectionsPerPol] |
Summaries of the (unfiltered) coherently summed waveforms, array index correponds to entry in peak[][]. | |
WaveformInfo | coherent_filtered [AnitaPol::kNotAPol][maxDirectionsPerPol] |
Summaries of the (unfiltered) de-dispersed coherently summed waveforms, array index correponds to entry in peak[][]. | |
WaveformInfo | deconvolved_filtered [AnitaPol::kNotAPol][maxDirectionsPerPol] |
Summaries of the filtered, coherently summed waveforms, array index correponds to entry in peak[][]. | |
ChannelInfo | channels [AnitaPol::kNotAPol][NUM_SEAVEYS] |
Summaries of the filtered, de-dispersed, coherently summed waveforms, array index correponds to entry in peak[][]. | |
EventFlags | flags |
Summaries of each channel's waveform. | |
SourceHypothesis | sun |
Flags corresponding the event quality, trigger type, calibration pulser timing, etc. | |
SourceHypothesis | wais |
Contains location of sun in map coordinates at time of event. | |
SourceHypothesis | ldb |
Contains location of WAIS divide cal pulser in map coordinates at time of event. | |
MCTruth | mc |
Contains location of LDB cal pulser in map coordinates at time of event. | |
PayloadLocation | anitaLocation |
Contains summary information about MC truth, if real data then this filled with constant, unphysical values. | |
Static Public Attributes | |
static const Int_t | maxDirectionsPerPol = 5 |
static const Int_t | peaksPerSpectrum = 3 |
The maximum number of hypotheses storable per polarization */. | |
static const Int_t | numFracPowerWindows = 5 |
The maximum number of frequency peaks per waveform spectrum. | |
static const Int_t | numBlastPowerBands = 3 |
Common analysis format between UCorrelator and Acclaim.
Two independent analyses will fill most of the variables in these trees. Needless to say, there's no guarantee that everything will be filled, so be wary if something is 0 (it may not have been filled). Also, member variables that have been filled may have slightly different definitions between analyses. You have been warned.
This class and its subclasses have utility functions that can be used inside TTree::Draw(). For example, with a TTree (called sumTree) of AnitaEventSummaries (called sum) doing
sumTree->Draw("sum.highestPeak().dPhiWais()")
Should produce a histogram of the reconstructed phi-angle from the WAIS divide cal pulser.
Definition at line 32 of file AnitaEventSummary.h.
AnitaEventSummary::AnitaEventSummary | ( | ) |
Reduced GPS data.
Default Constructor.
Default constructor for ROOT
Definition at line 24 of file AnitaEventSummary.cc.
AnitaEventSummary::AnitaEventSummary | ( | const RawAnitaHeader * | header | ) |
Constructor.
Takes care of copying the header info into the event summary
Definition at line 39 of file AnitaEventSummary.cc.
AnitaEventSummary::AnitaEventSummary | ( | const RawAnitaHeader * | header, |
UsefulAdu5Pat * | pat, | ||
const TruthAnitaEvent * | truth = 0 |
||
) |
Constructor.
Takes care of copying the header and GPS info into the event summary
Definition at line 61 of file AnitaEventSummary.cc.
int AnitaEventSummary::countChannelAboveThreshold | ( | int | threshold = 100 | ) | const |
Utility function to get the number of the channel that rms > threshold Useful for finding the blast events
Definition at line 340 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::highestCoherent | ( | ) | const |
Utility function to return a const reference to the the unfiltered coherently summed waveform info of the polarisation of the highest map peak Useful for TTree::Draw()
Definition at line 176 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::highestCoherentFiltered | ( | ) | const |
Utility function to return a const reference to the the filtered coherently summed waveform info of the polarisation of the highest map peak Useful for TTree::Draw()
Definition at line 202 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::highestDeconvolved | ( | ) | const |
Utility function to return a const reference to the the unfiltered, deconvolved coherently summed waveform info of the polarisation of the highest map peak Useful for TTree::Draw()
Definition at line 188 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::highestDeconvolvedFiltered | ( | ) | const |
Utility function to return a const reference to the the filtered, deconvolved coherently summed waveform info of the polarisation of the highest map peak Useful for TTree::Draw()
Definition at line 214 of file AnitaEventSummary.cc.
const AnitaEventSummary::PointingHypothesis & AnitaEventSummary::highestPeak | ( | ) | const |
Utility function to return a const reference to the higher map peak. Useful for TTree::Draw()
Definition at line 164 of file AnitaEventSummary.cc.
int AnitaEventSummary::highestPeakInd | ( | ) | const |
Utility function to get the index of the highest map peak Useful for TTree::Draw()
Definition at line 151 of file AnitaEventSummary.cc.
AnitaPol::AnitaPol_t AnitaEventSummary::highestPol | ( | ) | const |
Utility function to get the polarisation of the highest map peak Useful for TTree::Draw()
Definition at line 127 of file AnitaEventSummary.cc.
int AnitaEventSummary::highestPolAsInt | ( | ) | const |
Utility function to get the polarisation of the highest map peak Useful for TTree::Draw()
Definition at line 139 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::mostImpulsiveCoherent | ( | int | whichMetric = 0 | ) | const |
Utility function to return a const reference to the the unfiltered coherently summed waveform info of the polarisation of the most impulsive deconvolved wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 287 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::mostImpulsiveCoherentFiltered | ( | int | whichMetric = 0 | ) | const |
Utility function to return a const reference to the the filtered coherently summed waveform info of the polarisation of the most impulsive deconvolved wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 315 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::mostImpulsiveDeconvolved | ( | int | whichMetric = 0 | ) | const |
Utility function to return a const reference to the the most impulsive unfiltered, deconvolved coherently summed waveform info Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 300 of file AnitaEventSummary.cc.
const AnitaEventSummary::WaveformInfo & AnitaEventSummary::mostImpulsiveDeconvolvedFiltered | ( | int | whichMetric = 0 | ) | const |
Utility function to return a const reference to the the filtered, deconvolved coherently summed waveform info of the polarisation of the most impulsive deconvolved wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 328 of file AnitaEventSummary.cc.
int AnitaEventSummary::mostImpulsiveInd | ( | int | whichMetric = 0 | ) | const |
Utility function to get the index of the most impulsive deconvolved wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 260 of file AnitaEventSummary.cc.
const AnitaEventSummary::PointingHypothesis & AnitaEventSummary::mostImpulsivePeak | ( | int | whichMetric = 0 | ) | const |
Utility function to return a const reference to the map peak corresponding to the most impulsive deconvolved wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 274 of file AnitaEventSummary.cc.
AnitaPol::AnitaPol_t AnitaEventSummary::mostImpulsivePol | ( | int | whichMetric = 0 | ) | const |
value between 0 and 1, will find the brightest peak that is within threshold as impulsive as the most impulsive peak
Utility function to get the polarisation of the most impulsive deconvolved coherently summed wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 234 of file AnitaEventSummary.cc.
int AnitaEventSummary::mostImpulsivePolAsInt | ( | int | whichMetric = 0 | ) | const |
Utility function to get the polarisation of the most impulsive deconvolved wf Useful for TTree::Draw()
param | whichMetric 0 for Cosmin's impulsivityMeasure, 1 for Ben's fracPowerWindowGradient() (default = 0) |
Definition at line 247 of file AnitaEventSummary.cc.
void AnitaEventSummary::setSourceInformation | ( | UsefulAdu5Pat * | pat, |
const TruthAnitaEvent * | truth = 0 |
||
) |
Set the source information using the GPS info (and MC truth if non-NULL)
pat | is a pointer to the event GPS information |
truth | is a pointer to the MC Truth, default value is NULL |
Definition at line 408 of file AnitaEventSummary.cc.
void AnitaEventSummary::setTriggerInfomation | ( | const RawAnitaHeader * | header | ) |
Set trigger information in EventFlags directly from the header
header | is a pointer to the event header |
Definition at line 360 of file AnitaEventSummary.cc.
AnitaPol::AnitaPol_t AnitaEventSummary::trainingPol | ( | ) | const |
Return the weight of the event, always returns 1 for data, the weight from MCTruth otherwise.
Get the polarisation of the peak best corresponding to the MC peak In the case of data, just returns the highestPeak
Definition at line 935 of file AnitaEventSummary.cc.
void AnitaEventSummary::zeroInternals | ( | ) |
Set everything to zero, should be called in constructor
Definition at line 83 of file AnitaEventSummary.cc.