List of all members | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends
sevt::Station Class Reference

class to hold data at Station level More...

#include "sevt/Station.h"

Public Types

typedef
utl::MultiTraceD::ConstIterator 
ConstVEMTraceIterator
 
typedef utl::MultiTraceD::Iterator VEMTraceIterator
 an iterator over VEM traces of different components More...
 

Public Member Functions

void AddParticle (const utl::Particle &particle)
 
int GetId () const
 Get the station Id. More...
 
ScintillatorGetScintillator ()
 
const ScintillatorGetScintillator () const
 
SignalSegmentCollectionGetSignals ()
 
const SignalSegmentCollectionGetSignals () const
 
SmallPMTDataGetSmallPMTData ()
 
const SmallPMTDataGetSmallPMTData () const
 
bool HasScintillator () const
 
bool HasSmallPMTData () const
 
bool IsCyclone () const
 
bool IsUUB () const
 
Stationoperator= (const Station &station)
 
void SetIsCyclone (const bool cy=true)
 
 Station (const Station &station)
 
Methods for handling traces
utl::TimeStamp GetTraceStartTime () const
 Get absolute start time of the VEM trace. More...
 
void SetTraceStartTime (const utl::TimeStamp &Time)
 Set absolute start time of the VEM trace. More...
 
utl::TraceDGetVEMTrace (const StationConstants::SignalComponent source=StationConstants::eTotal)
 signal trace calibrated in [VEM charge] More...
 
const utl::TraceDGetVEMTrace (const StationConstants::SignalComponent source=StationConstants::eTotal) const
 
void MakeVEMTrace (const StationConstants::SignalComponent source=StationConstants::eTotal)
 Make a VEM trace object. More...
 
bool HasVEMTrace (const StationConstants::SignalComponent source=StationConstants::eTotal) const
 Check whether VEM trace exists. More...
 
VEMTraceIterator VEMTracesBegin ()
 First VEM trace. More...
 
ConstVEMTraceIterator VEMTracesBegin () const
 
VEMTraceIterator VEMTracesEnd ()
 Last VEM trace. More...
 
ConstVEMTraceIterator VEMTracesEnd () const
 
Has/Make/Get methods
sevt::StationSimDataGetSimData ()
 Get simulated data at station level. More...
 
const sevt::StationSimDataGetSimData () const
 
void MakeSimData ()
 Make station simulated data object. More...
 
bool HasSimData () const
 Check whether station simulated data exists. More...
 
sevt::StationRecDataGetRecData ()
 Get station level reconstructed data. More...
 
const sevt::StationRecDataGetRecData () const
 
void MakeRecData ()
 Make station reconstructed data object. More...
 
bool HasRecData () const
 Check whether station reconstructed data exists. More...
 
sevt::StationTriggerDataGetTriggerData ()
 Get Trigger data for the station. More...
 
const sevt::StationTriggerDataGetTriggerData () const
 
void MakeTriggerData ()
 Make trigger data object. More...
 
bool HasTriggerData () const
 Check whether trigger data object exists. More...
 
sevt::StationCalibDataGetCalibData ()
 Get calibration data for the station. More...
 
const sevt::StationCalibDataGetCalibData () const
 
void MakeCalibData ()
 Make calibration data object. More...
 
bool HasCalibData () const
 Check whether calibration data object exists. More...
 
sevt::StationGPSDataGetGPSData ()
 Get GPS data for the station. More...
 
const sevt::StationGPSDataGetGPSData () const
 
void MakeGPSData ()
 Make GPS data object. More...
 
bool HasGPSData () const
 Check whether GPS data object edists. More...
 
Methods for setting/getting flags
bool IsCandidate () const
 Check if the station is a candidate. More...
 
bool IsRejected () const
 Check if the station is rejected. More...
 
bool IsSilent () const
 Check if the station is silent. More...
 
void SetCandidate ()
 Set candidate station flag. More...
 
void SetRejected (const int reason)
 Set rejected station flag. More...
 
void SetSilent ()
 Set silent station flag. More...
 
int GetRejectionStatus () const
 
int GetT2Life () const
 
void SetT2Life (const int t)
 0 = dead, 1 = 1sec alive, 2 = 120sec alive More...
 
bool IsT2Life () const
 
bool IsT2Life120 () const
 
double GetBottomUpResidual () const
 
void SetBottomUpResidual (const double d)
 
bool IsLowGainSaturation () const
 Check which gains are saturated. More...
 
bool IsHighGainSaturation () const
 
bool IsSmallPMTSaturation () const
 
void SetLowGainSaturation (const bool sat=true)
 
void SetHighGainSaturation (const bool sat=true)
 
void SetSmallPMTSaturation (const bool sat=true)
 

Private Types

typedef
boost::indirect_iterator
< InternalConstPMTPtrIterator,
const PMT & > 
InternalConstPMTIterator
 Iterator over station for read. More...
 
typedef std::vector< PMT * >
::const_iterator 
InternalConstPMTPtrIterator
 
typedef
boost::indirect_iterator
< InternalPMTPtrIterator, PMT & > 
InternalPMTIterator
 Iterator over station for read/write. More...
 
typedef std::vector< PMT * >
::iterator 
InternalPMTPtrIterator
 

Private Member Functions

 Station (const int stationId)
 
 ~Station ()
 

Private Attributes

double fBottomUpResidual = 0
 
utl::ShadowPtr< StationCalibDatafCalibData
 
utl::ShadowPtr< StationGPSDatafGPSData
 
int fId = 0
 
bool fIsCyclone = false
 
bool fIsUUB = false
 
std::vector< PMT * > fPMTs
 
utl::ShadowPtr< StationRecDatafRecData
 
StationConstants::ReconstructionStatus fReconstructionStatus = StationConstants::eCandidate
 
int fRejectionStatus = StationConstants::eNoRejection
 
bool fSaturation [sdet::PMTConstants::eNumberOfGains] = { false }
 
utl::ShadowPtr< ScintillatorfScintillator
 
SignalSegmentCollection fSignals
 
utl::ShadowPtr< StationSimDatafSimData
 
utl::ShadowPtr< SmallPMTDatafSmallPMTData
 
bool fSmallPMTSaturation = false
 
int fT2Life = 2
 
utl::MultiTraceD fTrace
 
utl::TimeStamp fTraceStartTime
 
utl::ShadowPtr
< StationTriggerData
fTriggerData
 

Friends

class sevt::SEvent
 

PMT methods

typedef boost::filter_iterator
< PMTFilter,
InternalPMTIterator
PMTIterator
 Iterator over station for read/write. More...
 
typedef boost::filter_iterator
< PMTFilter,
InternalConstPMTIterator
ConstPMTIterator
 Iterator over station for read. More...
 
bool HasPMT (const unsigned int pmtId) const
 Check if a particular PMT object exists. More...
 
void MakePMT (const unsigned int pmtId, const int stationId, const sdet::PMTConstants::PMTType type=sdet::PMTConstants::eWaterCherenkovLarge)
 
PMTGetPMT (const unsigned int pmtId)
 Retrive a PMT by Id. More...
 
const PMTGetPMT (const unsigned int pmtId) const
 
PMTGetScintillatorPMT ()
 
const PMTGetScintillatorPMT () const
 
PMTGetSmallPMT ()
 
const PMTGetSmallPMT () const
 
unsigned int GetNPMTs (const sdet::PMTConstants::PMTType type=sdet::PMTConstants::eAnyType) const
 Number of pmts. More...
 
PMTIterator PMTsBegin (const sdet::PMTConstants::PMTType type=sdet::PMTConstants::eWaterCherenkovLarge)
 begin PMT iterator for read/write More...
 
PMTIterator PMTsEnd (const sdet::PMTConstants::PMTType type=sdet::PMTConstants::eWaterCherenkovLarge)
 end PMT iterator for read/write More...
 
ConstPMTIterator PMTsBegin (const sdet::PMTConstants::PMTType type=sdet::PMTConstants::eWaterCherenkovLarge) const
 begin PMT iterator for read More...
 
ConstPMTIterator PMTsEnd (const sdet::PMTConstants::PMTType type=sdet::PMTConstants::eWaterCherenkovLarge) const
 end PMT iterator for read More...
 

Detailed Description

class to hold data at Station level

Definition at line 41 of file SEvent/Station.h.

Member Typedef Documentation

Iterator over station for read.

Definition at line 90 of file SEvent/Station.h.

Definition at line 60 of file SEvent/Station.h.

typedef boost::indirect_iterator<InternalConstPMTPtrIterator, const PMT&> sevt::Station::InternalConstPMTIterator
private

Iterator over station for read.

Definition at line 51 of file SEvent/Station.h.

typedef std::vector<PMT*>::const_iterator sevt::Station::InternalConstPMTPtrIterator
private

Definition at line 45 of file SEvent/Station.h.

typedef boost::indirect_iterator<InternalPMTPtrIterator, PMT&> sevt::Station::InternalPMTIterator
private

Iterator over station for read/write.

Definition at line 48 of file SEvent/Station.h.

typedef std::vector<PMT*>::iterator sevt::Station::InternalPMTPtrIterator
private

Definition at line 44 of file SEvent/Station.h.

typedef boost::filter_iterator<PMTFilter, InternalPMTIterator> sevt::Station::PMTIterator

Iterator over station for read/write.

Definition at line 87 of file SEvent/Station.h.

an iterator over VEM traces of different components

Returns a LabeledTrace when dereferenced

Definition at line 59 of file SEvent/Station.h.

Constructor & Destructor Documentation

sevt::Station::Station ( const Station station)
inline

Definition at line 54 of file SEvent/Station.h.

Station::Station ( const int  stationId)
private

Definition at line 32 of file SEvent/Station.cc.

References fId, fPMTs, fScintillator, and fSmallPMTData.

Station::~Station ( )
private

Definition at line 50 of file SEvent/Station.cc.

References fPMTs, and G4StationSimulatorOG::p.

Member Function Documentation

void Station::AddParticle ( const utl::Particle particle)
double sevt::Station::GetBottomUpResidual ( ) const
inline

Definition at line 211 of file SEvent/Station.h.

References fBottomUpResidual.

sevt::StationCalibData& sevt::Station::GetCalibData ( )
inline
const sevt::StationCalibData& sevt::Station::GetCalibData ( ) const
inline

Definition at line 168 of file SEvent/Station.h.

References fCalibData.

sevt::StationGPSData& sevt::Station::GetGPSData ( )
inline
const sevt::StationGPSData& sevt::Station::GetGPSData ( ) const
inline

Definition at line 176 of file SEvent/Station.h.

References fGPSData.

int sevt::Station::GetId ( ) const
inline
unsigned int Station::GetNPMTs ( const sdet::PMTConstants::PMTType  type = sdet::PMTConstants::eAnyType) const

Number of pmts.

Definition at line 175 of file SEvent/Station.cc.

References sdet::PMTConstants::eAnyType, fPMTs, and G4StationSimulatorOG::p.

Referenced by GetScintillatorPMT(), and GetSmallPMT().

PMT& sevt::Station::GetPMT ( const unsigned int  pmtId)
inline
const PMT & Station::GetPMT ( const unsigned int  pmtId) const

Definition at line 115 of file SEvent/Station.cc.

References ERROR, fPMTs, and G4StationSimulatorOG::p.

sevt::StationRecData& sevt::Station::GetRecData ( )
inline
const sevt::StationRecData& sevt::Station::GetRecData ( ) const
inline

Definition at line 152 of file SEvent/Station.h.

References fRecData.

int sevt::Station::GetRejectionStatus ( ) const
inline
Scintillator& sevt::Station::GetScintillator ( )
inline
const Scintillator& sevt::Station::GetScintillator ( ) const
inline

Definition at line 233 of file SEvent/Station.h.

References fScintillator.

PMT& sevt::Station::GetScintillatorPMT ( )
inline

Definition at line 77 of file SEvent/Station.h.

References GetScintillatorPMT(), and OFFLINE_CAST_CONST_METHOD.

Referenced by GetScintillatorPMT().

const PMT & Station::GetScintillatorPMT ( ) const
SignalSegmentCollection& sevt::Station::GetSignals ( )
inline
const SignalSegmentCollection& sevt::Station::GetSignals ( ) const
inline

Definition at line 225 of file SEvent/Station.h.

References fSignals.

sevt::StationSimData& sevt::Station::GetSimData ( )
inline
const sevt::StationSimData& sevt::Station::GetSimData ( ) const
inline

Definition at line 144 of file SEvent/Station.h.

References fSimData.

PMT& sevt::Station::GetSmallPMT ( )
inline
const PMT & Station::GetSmallPMT ( ) const
SmallPMTData& sevt::Station::GetSmallPMTData ( )
inline
const SmallPMTData& sevt::Station::GetSmallPMTData ( ) const
inline

Definition at line 237 of file SEvent/Station.h.

References fSmallPMTData.

int sevt::Station::GetT2Life ( ) const
inline

Definition at line 203 of file SEvent/Station.h.

References fT2Life.

utl::TimeStamp sevt::Station::GetTraceStartTime ( ) const
inline

Get absolute start time of the VEM trace.

Definition at line 115 of file SEvent/Station.h.

References fTraceStartTime.

Referenced by MdMuonCounterAG::MdMuonCounter::GetSdTraceStartTime().

sevt::StationTriggerData& sevt::Station::GetTriggerData ( )
inline
const sevt::StationTriggerData& sevt::Station::GetTriggerData ( ) const
inline

Definition at line 160 of file SEvent/Station.h.

References fTriggerData.

utl::TraceD& sevt::Station::GetVEMTrace ( const StationConstants::SignalComponent  source = StationConstants::eTotal)
inline
const utl::TraceD& sevt::Station::GetVEMTrace ( const StationConstants::SignalComponent  source = StationConstants::eTotal) const
inline

Definition at line 124 of file SEvent/Station.h.

References fTrace, and utl::MultiTrace< T >::GetTrace().

bool sevt::Station::HasCalibData ( ) const
inline

Check whether calibration data object exists.

Definition at line 172 of file SEvent/Station.h.

References fCalibData.

Referenced by sevt::IsLightning().

bool sevt::Station::HasGPSData ( ) const
inline

Check whether GPS data object edists.

Definition at line 180 of file SEvent/Station.h.

References fGPSData.

Referenced by CentralTriggerEventBuilderNS::CentralTriggerEventBuilder::BuildEvent(), and MdMuonCounterAG::MdMuonCounter::GetSdTraceStartTime().

bool Station::HasPMT ( const unsigned int  pmtId) const
bool sevt::Station::HasRecData ( ) const
inline
bool sevt::Station::HasScintillator ( ) const
inline
bool sevt::Station::HasSimData ( ) const
inline
bool sevt::Station::HasSmallPMTData ( ) const
inline

Definition at line 238 of file SEvent/Station.h.

References fSmallPMTData.

Referenced by SdCalibratorOG::SdCalibrator::SelectSignal().

bool sevt::Station::HasTriggerData ( ) const
inline
bool sevt::Station::HasVEMTrace ( const StationConstants::SignalComponent  source = StationConstants::eTotal) const
inline
bool sevt::Station::IsCandidate ( ) const
inline
bool sevt::Station::IsCyclone ( ) const
inline
bool sevt::Station::IsHighGainSaturation ( ) const
inline
bool sevt::Station::IsLowGainSaturation ( ) const
inline
bool sevt::Station::IsRejected ( ) const
inline

Check if the station is rejected.

Definition at line 188 of file SEvent/Station.h.

References sevt::StationConstants::eRejected, and fReconstructionStatus.

bool sevt::Station::IsSilent ( ) const
inline
bool sevt::Station::IsSmallPMTSaturation ( ) const
inline

Definition at line 217 of file SEvent/Station.h.

References fSmallPMTSaturation.

bool sevt::Station::IsT2Life ( ) const
inline

Definition at line 207 of file SEvent/Station.h.

References fT2Life.

bool sevt::Station::IsT2Life120 ( ) const
inline

Definition at line 208 of file SEvent/Station.h.

References fT2Life.

bool Station::IsUUB ( ) const
void Station::MakeCalibData ( )

Make calibration data object.

Definition at line 220 of file SEvent/Station.cc.

References ERROR, and fCalibData.

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

void Station::MakeGPSData ( )

Make GPS data object.

Definition at line 230 of file SEvent/Station.cc.

References ERROR, and fGPSData.

Referenced by CentralTriggerEventBuilderNS::CentralTriggerEventBuilder::BuildEvent(), and io::Station_ROOT::operator>>().

void Station::MakePMT ( const unsigned int  pmtId,
const int  stationId,
const sdet::PMTConstants::PMTType  type = sdet::PMTConstants::eWaterCherenkovLarge 
)

Definition at line 102 of file SEvent/Station.cc.

References ERROR, fPMTs, and HasPMT().

void Station::MakeRecData ( )
void Station::MakeSimData ( )
void Station::MakeTriggerData ( )
void Station::MakeVEMTrace ( const StationConstants::SignalComponent  source = StationConstants::eTotal)
Station & Station::operator= ( const Station station)
PMTIterator sevt::Station::PMTsBegin ( const sdet::PMTConstants::PMTType  type = sdet::PMTConstants::eWaterCherenkovLarge)
inline
ConstPMTIterator sevt::Station::PMTsBegin ( const sdet::PMTConstants::PMTType  type = sdet::PMTConstants::eWaterCherenkovLarge) const
inline

begin PMT iterator for read

Definition at line 101 of file SEvent/Station.h.

References fPMTs.

PMTIterator sevt::Station::PMTsEnd ( const sdet::PMTConstants::PMTType  type = sdet::PMTConstants::eWaterCherenkovLarge)
inline
ConstPMTIterator sevt::Station::PMTsEnd ( const sdet::PMTConstants::PMTType  type = sdet::PMTConstants::eWaterCherenkovLarge) const
inline

end PMT iterator for read

Definition at line 105 of file SEvent/Station.h.

References fPMTs.

void sevt::Station::SetBottomUpResidual ( const double  d)
inline

Definition at line 212 of file SEvent/Station.h.

References fBottomUpResidual.

void Station::SetCandidate ( )
void sevt::Station::SetHighGainSaturation ( const bool  sat = true)
inline
void sevt::Station::SetIsCyclone ( const bool  cy = true)
inline

Definition at line 230 of file SEvent/Station.h.

References fIsCyclone.

void sevt::Station::SetLowGainSaturation ( const bool  sat = true)
inline
void Station::SetRejected ( const int  reason)
void Station::SetSilent ( )
void sevt::Station::SetSmallPMTSaturation ( const bool  sat = true)
inline
void sevt::Station::SetT2Life ( const int  t)
inline

0 = dead, 1 = 1sec alive, 2 = 120sec alive

Definition at line 205 of file SEvent/Station.h.

References fT2Life.

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

void sevt::Station::SetTraceStartTime ( const utl::TimeStamp Time)
inline

Set absolute start time of the VEM trace.

For MC this should be set by the local trigger simulation

Definition at line 119 of file SEvent/Station.h.

References fTraceStartTime.

Referenced by io::Station_ROOT::operator>>(), SdTraceCalibratorOG::SdTraceCalibrator::SelectSignal(), SdCalibratorOG::SdCalibrator::SelectSignal(), and SdTopDownSignalSelectorUGR::SdTopDownSignalSelectorUGR::UpdateStationValues().

VEMTraceIterator sevt::Station::VEMTracesBegin ( )
inline

First VEM trace.

Definition at line 133 of file SEvent/Station.h.

References utl::MultiObject< T, LabeledObjectType >::Begin(), and fTrace.

ConstVEMTraceIterator sevt::Station::VEMTracesBegin ( ) const
inline

Definition at line 134 of file SEvent/Station.h.

References utl::MultiObject< T, LabeledObjectType >::Begin(), and fTrace.

VEMTraceIterator sevt::Station::VEMTracesEnd ( )
inline

Last VEM trace.

Definition at line 136 of file SEvent/Station.h.

References utl::MultiObject< T, LabeledObjectType >::End(), and fTrace.

ConstVEMTraceIterator sevt::Station::VEMTracesEnd ( ) const
inline

Definition at line 137 of file SEvent/Station.h.

References utl::MultiObject< T, LabeledObjectType >::End(), and fTrace.

Friends And Related Function Documentation

friend class sevt::SEvent
friend

Definition at line 281 of file SEvent/Station.h.

Member Data Documentation

double sevt::Station::fBottomUpResidual = 0
private

Definition at line 271 of file SEvent/Station.h.

Referenced by GetBottomUpResidual(), and SetBottomUpResidual().

utl::ShadowPtr<StationCalibData> sevt::Station::fCalibData
private

Definition at line 255 of file SEvent/Station.h.

Referenced by GetCalibData(), HasCalibData(), MakeCalibData(), and operator=().

utl::ShadowPtr<StationGPSData> sevt::Station::fGPSData
private

Definition at line 257 of file SEvent/Station.h.

Referenced by GetGPSData(), HasGPSData(), MakeGPSData(), and operator=().

int sevt::Station::fId = 0
private

Definition at line 251 of file SEvent/Station.h.

Referenced by AddParticle(), GetId(), operator=(), and Station().

bool sevt::Station::fIsCyclone = false
private

Definition at line 279 of file SEvent/Station.h.

Referenced by IsCyclone(), and SetIsCyclone().

bool sevt::Station::fIsUUB = false
private

Definition at line 278 of file SEvent/Station.h.

std::vector<PMT*> sevt::Station::fPMTs
private
utl::ShadowPtr<StationRecData> sevt::Station::fRecData
private

Definition at line 254 of file SEvent/Station.h.

Referenced by GetRecData(), HasRecData(), MakeRecData(), and operator=().

StationConstants::ReconstructionStatus sevt::Station::fReconstructionStatus = StationConstants::eCandidate
private

Definition at line 260 of file SEvent/Station.h.

Referenced by IsRejected(), IsSilent(), operator=(), SetCandidate(), SetRejected(), and SetSilent().

int sevt::Station::fRejectionStatus = StationConstants::eNoRejection
private

Definition at line 263 of file SEvent/Station.h.

Referenced by GetRejectionStatus(), operator=(), and SetRejected().

bool sevt::Station::fSaturation[sdet::PMTConstants::eNumberOfGains] = { false }
private
utl::ShadowPtr<Scintillator> sevt::Station::fScintillator
private

Definition at line 275 of file SEvent/Station.h.

Referenced by AddParticle(), GetScintillator(), HasScintillator(), operator=(), and Station().

SignalSegmentCollection sevt::Station::fSignals
private

Definition at line 273 of file SEvent/Station.h.

Referenced by GetSignals(), and operator=().

utl::ShadowPtr<StationSimData> sevt::Station::fSimData
private

Definition at line 253 of file SEvent/Station.h.

Referenced by AddParticle(), GetSimData(), HasSimData(), MakeSimData(), and operator=().

utl::ShadowPtr<SmallPMTData> sevt::Station::fSmallPMTData
private

Definition at line 276 of file SEvent/Station.h.

Referenced by GetSmallPMTData(), HasSmallPMTData(), operator=(), and Station().

bool sevt::Station::fSmallPMTSaturation = false
private

Definition at line 262 of file SEvent/Station.h.

Referenced by IsSmallPMTSaturation(), and SetSmallPMTSaturation().

int sevt::Station::fT2Life = 2
private

Definition at line 269 of file SEvent/Station.h.

Referenced by GetT2Life(), IsT2Life(), IsT2Life120(), operator=(), and SetT2Life().

utl::MultiTraceD sevt::Station::fTrace
private
utl::TimeStamp sevt::Station::fTraceStartTime
private

Definition at line 258 of file SEvent/Station.h.

Referenced by GetTraceStartTime(), operator=(), and SetTraceStartTime().

utl::ShadowPtr<StationTriggerData> sevt::Station::fTriggerData
private

Definition at line 256 of file SEvent/Station.h.

Referenced by GetTriggerData(), HasTriggerData(), MakeTriggerData(), and operator=().


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

, generated on Tue Sep 26 2023.