List of all members | Public Types | Static Private Member Functions | Private Attributes
sevt::SdFootprintData Class Reference
Shower

Class to hold simple parameters describing the footprint of an SD event. More...

#include "sevt/SdFootprintData.h"

Public Types

typedef
SdFootprintEnumerations::Alignment 		Alignment
 

Public Member Functions

Standard Parameters
double GetLength () const
 
double GetWidth () const
 
double GetSpeed () const
 The mean 'apparent speed' of the signals as they sweep over the array. More...
 
double GetSpeedStandardDeviation () const
 The standard deviation of apparent speed histogram. All possible pairs of stations correspond to an entry in the histogram. More...
 
double GetTOTFraction () const
 Fraction of stations with a TOT trigger. More...
 
double GetAreaOverPeakAsymmetry () const
 
Alignment GetAlignment () const
 Flag describing how 'aligned' an event is. More...
 
void SetLength (const double l)
 
void SetWidth (const double w)
 
void SetSpeed (const double s, const double ds)
 
void SetTOTFraction (const double f)
 
void SetAreaOverPeakAsymmetry (const double a)
 
void SetAlignment (const Alignment alignment)
 

Static Private Member Functions

static const std::string & CurrentModule ()
 

Private Attributes

Alignment fAlignment = SdFootprintEnumerations::eNotAligned
 
double fAreaOverPeakAsymmetry = 0
 
double fLength = 0
 
utl::ParameterStorage< Parameter > fParameters {"Shower:SdFootprintData"}
 
double fSpeed = 0
 
double fSpeedStandardDeviation = 0
 
double fTOTFraction = 0
 
double fWidth = 0
 

Not-so-standard Parameters

typedef
SdFootprintEnumerations::Parameter 		Parameter
 
void SetParameter (const Parameter p, const double v, bool lock=true)
 
bool HasParameter (const Parameter p) const
 
double GetParameter (const Parameter p) const
 
bool GetParameterOrigin (const Parameter p) const
 
std::vector< Parameter > GetParameterVector () const
 

Detailed Description

Class to hold simple parameters describing the footprint of an SD event.

This class is intended for simple parameters related to the footprint of the event like the ones used in the neutrino analyses. Since the set of parameters used in the analyses changes with time, this class provides getters and setter for the most standard ones and leaves the user the choice to add his or her own. The allowed parameters are indexed by the SdFootprintEnumerations::Parameter enumeration, which includes some values for user-defined parameters.

Author
Javier Gonzalez
Date
19 Apr 2012

Definition at line 30 of file SdFootprintData.h.

Member Typedef Documentation

typedef SdFootprintEnumerations::Alignment sevt::SdFootprintData::Alignment

Definition at line 33 of file SdFootprintData.h.

typedef SdFootprintEnumerations::Parameter sevt::SdFootprintData::Parameter

Definition at line 59 of file SdFootprintData.h.

Member Function Documentation

static const std::string& sevt::SdFootprintData::CurrentModule ( )
inlinestaticprivate

Definition at line 68 of file SdFootprintData.h.

Referenced by GetParameter(), GetParameterOrigin(), and SetParameter().

Alignment sevt::SdFootprintData::GetAlignment ( ) const
inline

Flag describing how 'aligned' an event is.

Definition at line 47 of file SdFootprintData.h.

References fAlignment.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::ComputeGroundVariables(), and SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

double sevt::SdFootprintData::GetAreaOverPeakAsymmetry ( ) const
inline

Definition at line 45 of file SdFootprintData.h.

References fAreaOverPeakAsymmetry.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

double sevt::SdFootprintData::GetLength ( ) const
inline

Definition at line 37 of file SdFootprintData.h.

References fLength.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

double sevt::SdFootprintData::GetParameter ( const Parameter  p) const
inline

Definition at line 62 of file SdFootprintData.h.

References CurrentModule(), and fParameters.

bool sevt::SdFootprintData::GetParameterOrigin ( const Parameter  p) const
inline

Definition at line 63 of file SdFootprintData.h.

References CurrentModule(), and fParameters.

std::vector<Parameter> sevt::SdFootprintData::GetParameterVector ( ) const
inline

Definition at line 64 of file SdFootprintData.h.

References fParameters.

double sevt::SdFootprintData::GetSpeed ( ) const
inline

The mean 'apparent speed' of the signals as they sweep over the array.

Definition at line 40 of file SdFootprintData.h.

References fSpeed.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

double sevt::SdFootprintData::GetSpeedStandardDeviation ( ) const
inline

The standard deviation of apparent speed histogram. All possible pairs of stations correspond to an entry in the histogram.

Definition at line 42 of file SdFootprintData.h.

References fSpeedStandardDeviation.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

double sevt::SdFootprintData::GetTOTFraction ( ) const
inline

Fraction of stations with a TOT trigger.

Definition at line 44 of file SdFootprintData.h.

References fTOTFraction.

double sevt::SdFootprintData::GetWidth ( ) const
inline

Definition at line 38 of file SdFootprintData.h.

References fWidth.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

bool sevt::SdFootprintData::HasParameter ( const Parameter  p) const
inline

Definition at line 61 of file SdFootprintData.h.

References fParameters, and utl::ParameterStorage< IndexEnum, ParameterType, ParameterCovarianceType >::HasParameter().

void sevt::SdFootprintData::SetAlignment ( const Alignment  alignment)
inline

Definition at line 54 of file SdFootprintData.h.

References fAlignment.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::ComputeGroundVariables(), and io::SdFootprintData_ROOT::operator>>().

void sevt::SdFootprintData::SetAreaOverPeakAsymmetry ( const double  a)
inline

Definition at line 53 of file SdFootprintData.h.

References RdGeoCeLDFFitter::a, and fAreaOverPeakAsymmetry.

Referenced by io::SdFootprintData_ROOT::operator>>(), and SdFootprintAnalyzerNS::SdFootprintAnalyzer::Run().

void sevt::SdFootprintData::SetLength ( const double  l)
inline

Definition at line 49 of file SdFootprintData.h.

References fLength.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::ComputeGroundVariables(), and io::SdFootprintData_ROOT::operator>>().

void sevt::SdFootprintData::SetParameter ( const Parameter  p,
const double  v,
bool  lock = true 
)
inline

Definition at line 60 of file SdFootprintData.h.

References CurrentModule(), and fParameters.

Referenced by io::SdFootprintData_ROOT::operator>>().

void sevt::SdFootprintData::SetSpeed ( const double  s,
const double  ds 
)
inline

Definition at line 51 of file SdFootprintData.h.

References fSpeed, fSpeedStandardDeviation, and utl::s.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::ComputeGroundVariables(), and io::SdFootprintData_ROOT::operator>>().

void sevt::SdFootprintData::SetTOTFraction ( const double  f)
inline

Definition at line 52 of file SdFootprintData.h.

References fTOTFraction.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::ComputeGroundVariables(), and io::SdFootprintData_ROOT::operator>>().

void sevt::SdFootprintData::SetWidth ( const double  w)
inline

Definition at line 50 of file SdFootprintData.h.

References fWidth.

Referenced by SdFootprintAnalyzerNS::SdFootprintAnalyzer::ComputeGroundVariables(), and io::SdFootprintData_ROOT::operator>>().

Member Data Documentation

Alignment sevt::SdFootprintData::fAlignment = SdFootprintEnumerations::eNotAligned
private

Definition at line 76 of file SdFootprintData.h.

Referenced by GetAlignment(), and SetAlignment().

double sevt::SdFootprintData::fAreaOverPeakAsymmetry = 0
private

Definition at line 75 of file SdFootprintData.h.

Referenced by GetAreaOverPeakAsymmetry(), and SetAreaOverPeakAsymmetry().

double sevt::SdFootprintData::fLength = 0
private

Definition at line 70 of file SdFootprintData.h.

Referenced by GetLength(), and SetLength().

utl::ParameterStorage<Parameter> sevt::SdFootprintData::fParameters {"Shower:SdFootprintData"}
private

Definition at line 78 of file SdFootprintData.h.

Referenced by GetParameter(), GetParameterOrigin(), GetParameterVector(), HasParameter(), and SetParameter().

double sevt::SdFootprintData::fSpeed = 0
private

Definition at line 72 of file SdFootprintData.h.

Referenced by GetSpeed(), and SetSpeed().

double sevt::SdFootprintData::fSpeedStandardDeviation = 0
private

Definition at line 73 of file SdFootprintData.h.

Referenced by GetSpeedStandardDeviation(), and SetSpeed().

double sevt::SdFootprintData::fTOTFraction = 0
private

Definition at line 74 of file SdFootprintData.h.

Referenced by GetTOTFraction(), and SetTOTFraction().

double sevt::SdFootprintData::fWidth = 0
private

Definition at line 71 of file SdFootprintData.h.

Referenced by GetWidth(), and SetWidth().

The documentation for this class was generated from the following file:
, generated on Tue Sep 26 2023.