Performs calibration and signal analysis of the SD event. More...

#include "SdCalibratorOG/SdCalibrator.h"

Inheritance diagram for SdCalibratorOG::SdCalibrator:

Public Types
enum	ResultFlag { eSuccess, eFailure, eBreakLoop, eContinueLoop }
	Flag returned by module methods to the RunController. More...

enum	VersionInfoType { eFilename = 1, eRevisionNumber = 2, eDate = 3, eTime = 4, eLastEditor = 5 }
	Different types of version info that can be retrieved from GetVersionInfo. More...

Public Member Functions
fwk::VModule::ResultFlag	Finish () override
	Finish: invoked at end of the run (NOT end of the event) More...

utl::Stopwatch &	GetStopwatch ()

const utl::Stopwatch &	GetStopwatch () const

std::string	GetVersionInfo (const VersionInfoType v) const
	Retrieve different sorts of module version info. More...

fwk::VModule::ResultFlag	Init () override
	Initialize: invoked at beginning of run (NOT beginning of event) More...

void	InitTiming ()

fwk::VModule::ResultFlag	Run (evt::Event &event) override
	Run: invoked once per event. More...

ResultFlag	RunWithTiming (evt::Event &event)

Static Public Member Functions
static std::string	GetResultFlagByName (const ResultFlag flag)

Protected Types
enum	InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }

Protected Attributes
int	fInfoLevel = 0

Private Types
typedef std::pair< double, double >	PairD

Private Member Functions
void	ApplyTimeCorrection (sevt::Station &station)
	Calculate corrected nanosecond from raw GPS parameter. More...

int	BuildSignals (sevt::Station &station) const

bool	BuildSignals (sevt::PMT &pmt, const unsigned int traceLength, const int saturationValue) const

void	CalculatePeakAndCharge (sevt::Station &station)

bool	ComputeBaseline (const sevt::Station &station, sevt::PMT &pmt, const sdet::PMTConstants::PMTGain gain) const

bool	ComputeBaselines (sevt::Station &station) const

void	ComputeShapeRiseFallPeak (sevt::PMTRecData &pmtRecData, const double binTiming, const unsigned int startBin, const unsigned int startIntegration, const unsigned int endIntegration, const double traceIntegral) const

bool	CopySmallPMTCalibData (sevt::Station &station)

bool	IsTestStation (const int id) const

bool	MakeComponentVEMTraces (sevt::PMT &pmt) const

void	MakeFlatBaseline (sevt::PMT &pmt, const sdet::PMTConstants::PMTGain gain) const

bool	MergeSignals (sevt::Station &station) const

	REGISTER_MODULE ("SdCalibratorOG", SdCalibrator)

bool	SelectSignal (sevt::Station &station) const

void	SumPMTComponents (sevt::Station &station) const

void	TreatSaturated (sevt::Station &station) const

Private Attributes
bool	fApplyBackwardFlatPieceCheck = false

int	fBinsBeforeStartForSPMT = 0

double	fChargeFitChi2Accept = 0

double	fChargeFitShoulderHeadRatio = 0

double	fChargeHistogramToMIPFactor = 0

double	fChargeHistogramToVEMFactor = 0

double	fChargeOnlineToMIPFactor = 0

double	fChargeOnlineToVEMFactor = 0

bool	fDecreaseLGFlatPieceTolerance = false

PairD	fFallTimeFractions {0, 0}

int	fFindSignalBinsAboveThreshold = 0

double	fFindSignalThreshold = 0

bool	fIncludeWaterCherenkovDetectorInScintillatorStartStopDetermination = false

bool	fIsUUB = false

double	fPeakFitChi2Accept = 0

PairD	fPeakFitRange {0, 0}

double	fPeakHistogramToMIPFactor = 0

double	fPeakHistogramToVEMFactor = 0

double	fPeakOnlineToMIPFactor = 0

double	fPeakOnlineToVEMFactor = 0

double	fPMTSummationCutoff = 0

PairD	fRiseTimeFractions {0, 0}

PairD	fShapeFitRangeBefore12 {0, 0}

PairD	fShapeFitRangeSince12 {0, 0}

std::set< int >	fTestStations

bool	fToldYaCharge = false

bool	fToldYaPeak = false

bool	fToldYaShape = false

bool	fTreatHGLGEqualInSignalSearch = false

const utl::TimeRange	kCommsCrisis {utl::TimeStamp{928378815}, utl::TimeStamp{942375615}}

Detailed Description

Performs calibration and signal analysis of the SD event.

Module does the following:

Removes stations without trigger data.
Removes stations with trigger errors.
Appropriately tags stations with Station::IsCandidate(). Stations with StationTriggerData::GetError() == 2 and nonzero StationTriggerData::GetWindow() are tagged as Station::IsSilent()
Calculates VEM peak and VEM charge values for each PMT using LS online calibration and histograms.
Rechecks the time-over-threshold (TOT) trigger tag for LS calibration versions <= 12.
Applies nanosecond time correction to the station event time.
Applies calculated peak and charge values and generates appropriate PMT VEM traces.
Finds signal start, sets peak amplitude, total VEM signal and trace. Signal start is defined as timing of the first bin where all 3 PMTs have signal over the <signalTreshold>.
For each PMT, calculates signal rise/fall time, peak amplitude, charge (=area), and area/peak.for PMTs. Fills rise/fall time and shape parameter (all with RMS) for stations.
You can change rise/fall time definitions in the xml file under the <riseTimeFractions> and <fallTimeFractions>. Currently (Pierre Billoir's) defaults of 0.1, 0.5 and 0.5, 0.9 are used.

Differences to CDAS v3r2:

Total signal of the station is calculated as a sum of separate PMT VEM traces (in the integration window) and not as integral of a sum averaged over PMTs. Nevertheless, peak amplitude is found as maximum of a PMT VEM signal (same as CDAS).

Author: Stefano Argiro; Darko Veberic; Xavier Bertou

Date: 08 Oct 2003; 30 Sep 2004 update, CDAS v3r2 sync; 20 Oct 2004 update, CDAS v3r4 sync; 05 Apr 2005 update, CDAS v4r0 sync, not much changed; 02 Oct 2007 update based on Xavier's code in CDAS v4r6

Definition at line 68 of file SdCalibrator.h.

Member Typedef Documentation

typedef std::pair<double, double> SdCalibratorOG::SdCalibrator::PairD

private

Definition at line 107 of file SdCalibrator.h.

Member Enumeration Documentation

enum fwk::VModule::InfoLevel

protectedinherited

Enumerator
eInfoNone
eInfoFinal
eInfoIntermediate
eInfoDebug

Definition at line 125 of file VModule.h.

enum fwk::VModule::ResultFlag

inherited

Flag returned by module methods to the RunController.

Enumerator
eSuccess	Report success to RunController.
eFailure	Report failure to RunController, causing RunController to terminate execution.
eBreakLoop	Break current loop. It works for nested loops too!
eContinueLoop	Skip remaining modules in the current loop and continue with next iteration of the loop.

Definition at line 60 of file VModule.h.

enum fwk::VModule::VersionInfoType

inherited

Different types of version info that can be retrieved from GetVersionInfo.

Enumerator
eFilename
eRevisionNumber
eDate
eTime
eLastEditor

Definition at line 110 of file VModule.h.

Member Function Documentation

void SdCalibratorOG::SdCalibrator::ApplyTimeCorrection ( sevt::Station & station )

private

Calculate corrected nanosecond from raw GPS parameter.

Definition at line 311 of file SdCalibrator.cc.

References sevt::Station::GetGPSData(), sevt::StationGPSData::GetTick(), and utl::nanosecond.

int SdCalibratorOG::SdCalibrator::BuildSignals ( sevt::Station & station ) const

private

Definition at line 1213 of file SdCalibrator.cc.

References sdet::PMTConstants::eAnyType, sdet::PMTConstants::eScintillator, sdet::PMTConstants::eWaterCherenkovLarge, sevt::Station::GetScintillator(), utl::Trace< T >::GetSize(), sevt::Station::GetVEMTrace(), sevt::Station::HasVEMTrace(), sevt::Scintillator::MakeMIPTrace(), sevt::Station::MakeVEMTrace(), and utl::Trace< T >::ResetAll().

bool SdCalibratorOG::SdCalibrator::BuildSignals	(	sevt::PMT &	pmt,
		const unsigned int	traceLength,
		const int	saturationValue
	)		const

private

Definition at line 1274 of file SdCalibrator.cc.

References sdet::PMTConstants::eHighGain, sdet::PMTConstants::eLowGain, sdet::PMTConstants::eWaterCherenkovSmall, SdTraceCalibratorOG::CalibrationParameters::GetBinsWithLargeSignalThreshold(), SdTraceCalibratorOG::CalibrationParameters::GetBinsWithSignalThreshold(), sevt::PMT::GetCalibData(), sevt::PMT::GetFADCTrace(), SdTraceCalibratorOG::CalibrationParameters::GetFindSignalThresholdMultiplier(), SdTraceCalibratorOG::CalibrationParameters::GetLargeFADCThreshold(), SdTraceCalibratorOG::CalibrationParameters::GetMinFADCValue(), sevt::PMT::GetRecData(), SdTraceCalibratorOG::CalibrationParameters::GetSaturatedBinsMaximum(), SdTraceCalibratorOG::CalibrationParameters::GetSignalMaxDist(), sevt::PMT::GetType(), sevt::PMT::HasRecData(), sevt::PMTCalibData::IsLowGainOk(), sevt::PMT::MakeRecData(), max, and sevt::PMTRecData::SetFADCSaturatedBins().

void SdCalibratorOG::SdCalibrator::CalculatePeakAndCharge ( sevt::Station & station )

private

bool SdCalibratorOG::SdCalibrator::ComputeBaseline	(	const sevt::Station &	station,
		sevt::PMT &	pmt,
		const sdet::PMTConstants::PMTGain	gain
	)		const

private

bool SdCalibratorOG::SdCalibrator::ComputeBaselines ( sevt::Station & station ) const

private

Definition at line 892 of file SdCalibrator.cc.

References sdet::PMTConstants::eAnyType, sdet::PMTConstants::eHighGain, and sdet::PMTConstants::eLowGain.

void SdCalibratorOG::SdCalibrator::ComputeShapeRiseFallPeak	(	sevt::PMTRecData &	pmtRecData,
		const double	binTiming,
		const unsigned int	startBin,
		const unsigned int	startIntegration,
		const unsigned int	endIntegration,
		const double	traceIntegral
	)		const

private

Definition at line 734 of file SdCalibrator.cc.

References sevt::PMTRecData::GetVEMTrace(), utl::nanosecond, sevt::PMTRecData::SetFallTime(), sevt::PMTRecData::SetPeakAmplitude(), sevt::PMTRecData::SetRiseTime(), sevt::PMTRecData::SetShapeParameter(), sevt::PMTRecData::SetT40(), and sevt::PMTRecData::SetT50().

bool SdCalibratorOG::SdCalibrator::CopySmallPMTCalibData ( sevt::Station & station )

private

Definition at line 355 of file SdCalibrator.cc.

References sevt::SmallPMTData::GetCalibData(), sevt::PMT::GetCalibData(), sevt::Station::GetId(), sevt::Station::GetSmallPMT(), sevt::Station::GetSmallPMTData(), INFO, utl::Sqr(), and WARNING.

fwk::VModule::ResultFlag SdCalibratorOG::SdCalibrator::Finish ( )

inlineoverridevirtual

Finish: invoked at end of the run (NOT end of the event)

This method is for things that should be done at the end of the run (for example, closing files or writing out histograms) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 73 of file SdCalibrator.h.

References fwk::VModule::eSuccess.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag flag )

staticinherited

Definition at line 8 of file VModule.cc.

References fwk::VModule::eBreakLoop, fwk::VModule::eContinueLoop, fwk::VModule::eFailure, and fwk::VModule::eSuccess.

Referenced by fwk::RunController::DoNextInSequence(), fwk::RunController::FinishBranch(), and fwk::RunController::InitBranch().

utl::Stopwatch& fwk::VModule::GetStopwatch ( )

inlineinherited

Definition at line 106 of file VModule.h.

References fwk::VModule::fStopwatch.

const utl::Stopwatch& fwk::VModule::GetStopwatch ( ) const

inlineinherited

Definition at line 107 of file VModule.h.

References fwk::VModule::fStopwatch.

std::string fwk::VModule::GetVersionInfo ( const VersionInfoType v ) const

inherited

Retrieve different sorts of module version info.

Definition at line 26 of file VModule.cc.

Referenced by fwk::CentralConfig::GetConfig(), ThresholdCalculatorKG::ThresholdCalculator::Init(), fdDoubleBumpFinder::FdDoubleBumpFinder::Init(), LaserGeneratorNA::LaserGenerator::Init(), LaserLightSimulatorNA::LaserLightSimulator::Init(), FdElectronicsSimulatorOG::FdElectronicsSimulator::Init(), TelescopeSimulatorKG::TelescopeSimulator::Init(), TelescopeSimulatorKG2::TelescopeSimulator::Init(), SdSimpleSimKG::SdSimpleSim::Init(), ShowerPhotonGeneratorOG::ShowerPhotonGenerator::Init(), and testRunController::testModuleVersionInfo().

VModule::ResultFlag SdCalibratorOG::SdCalibrator::Init ( )

overridevirtual

Initialize: invoked at beginning of run (NOT beginning of event)

This method is for things that should be done once at the beginning of a run (for example, booking histograms, performing calculations that need to be done only once, initializing parameters) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 88 of file SdCalibrator.cc.

References ERROR, io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), INFO, SdEventSelectorOG::IsInRange(), and utl::Join().

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

References fwk::VModule::fStopwatch, and utl::Stopwatch::Reset().

bool SdCalibratorOG::SdCalibrator::IsTestStation ( const int id ) const

inlineprivate

Definition at line 102 of file SdCalibrator.h.

References fTestStations, and utl::Is().

bool SdCalibratorOG::SdCalibrator::MakeComponentVEMTraces ( sevt::PMT & pmt ) const

private

Definition at line 1166 of file SdCalibrator.cc.

References sdet::PMTConstants::eHighGain, sevt::StationConstants::eTotal, sevt::StationConstants::eTotalNoSaturation, sevt::PMT::GetFADCTrace(), sevt::PMT::GetFADCTraceD(), sevt::PMTRecData::GetGainUsed(), sevt::PMT::GetMultiFADCTrace(), sevt::PMT::GetRecData(), and utl::Trace< T >::GetSize().

void SdCalibratorOG::SdCalibrator::MakeFlatBaseline	(	sevt::PMT &	pmt,
		const sdet::PMTConstants::PMTGain	gain
	)		const

private

Definition at line 877 of file SdCalibrator.cc.

References sevt::PMTCalibData::GetBaseline(), sevt::PMT::GetCalibData(), sevt::PMT::GetRecData(), and sevt::PMTRecData::MakeFADCBaseline().

bool SdCalibratorOG::SdCalibrator::MergeSignals ( sevt::Station & station ) const

private

Definition at line 1465 of file SdCalibrator.cc.

References sdet::PMTConstants::eHighGain, SdTraceCalibratorOG::CalibrationParameters::GetFindSignalThresholdMultiplier(), sevt::Station::GetSignals(), sevt::Station::GetVEMTrace(), and SdCalibratorOG::Interval< T1, T2 >::Merge().

SdCalibratorOG::SdCalibrator::REGISTER_MODULE	(	"SdCalibratorOG"	,
		SdCalibrator
	)

private

VModule::ResultFlag SdCalibratorOG::SdCalibrator::Run ( evt::Event & event )

overridevirtual

Run: invoked once per event.

This method is for things that should be done once per event {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 169 of file SdCalibrator.cc.

References utl::abs(), io::ApplyTimeCorrection(), cevt::StationConstants::eBadCalib, sevt::StationConstants::eBadCompress, cevt::StationConstants::eErrorCode, cevt::StationConstants::eNoCalibData, cevt::StationConstants::eNoGPSData, sevt::StationConstants::eNotAliveT120, sevt::StationConstants::eNotAliveT2, cevt::StationConstants::eNoTrigger, sevt::StationConstants::eRandom, io::eSuccess, evt::Event::HasSEvent(), INFO, utl::String::Plural(), and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event & event )

inlineinherited

Definition at line 98 of file VModule.h.

References fwk::VModule::fStopwatch, fwk::VModule::Run(), utl::Stopwatch::Start(), and utl::Stopwatch::Stop().

Referenced by fwk::RunController::DoNextInSequence().

bool SdCalibratorOG::SdCalibrator::SelectSignal ( sevt::Station & station ) const

private

Definition at line 1570 of file SdCalibrator.cc.

References sdet::PMTConstants::eAnyType, sdet::PMTConstants::eHighGain, sdet::PMTConstants::eLowGain, sdet::PMTConstants::eScintillator, sdet::PMTConstants::eWaterCherenkovLarge, sdet::PMTConstants::eWaterCherenkovSmall, sevt::Station::GetGPSData(), sevt::Station::GetId(), sevt::StationTriggerData::GetPLDTimeOffset(), sevt::Scintillator::GetRecData(), sevt::Station::GetRecData(), sevt::Station::GetScintillator(), sevt::Scintillator::GetSignals(), sevt::Station::GetSignals(), sevt::Station::GetSmallPMTData(), sevt::Station::GetTriggerData(), sevt::Station::GetVEMTrace(), sevt::Station::HasRecData(), sevt::Station::HasScintillator(), sevt::Station::HasSmallPMTData(), sevt::SmallPMTData::IsTubeOk(), sevt::Scintillator::MakeMIPTrace(), sevt::Station::MakeRecData(), max, sevt::Station::SetHighGainSaturation(), sevt::SmallPMTData::SetIsTubeOk(), sevt::Station::SetLowGainSaturation(), sevt::StationRecData::SetSignalStartSlot(), sevt::Station::SetSmallPMTSaturation(), sevt::Station::SetTraceStartTime(), and WARNING.

void SdCalibratorOG::SdCalibrator::SumPMTComponents ( sevt::Station & station ) const

private

Definition at line 816 of file SdCalibrator.cc.

References cevt::StationConstants::eLastSource, sevt::Station::GetVEMTrace(), sevt::Station::HasVEMTrace(), and sevt::Station::MakeVEMTrace().

void SdCalibratorOG::SdCalibrator::TreatSaturated ( sevt::Station & station ) const

private

Member Data Documentation

bool SdCalibratorOG::SdCalibrator::fApplyBackwardFlatPieceCheck = false

private

Definition at line 128 of file SdCalibrator.h.

int SdCalibratorOG::SdCalibrator::fBinsBeforeStartForSPMT = 0

private

Definition at line 131 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fChargeFitChi2Accept = 0

private

Definition at line 115 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fChargeFitShoulderHeadRatio = 0

private

Definition at line 114 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fChargeHistogramToMIPFactor = 0

private

Definition at line 119 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fChargeHistogramToVEMFactor = 0

private

Definition at line 117 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fChargeOnlineToMIPFactor = 0

private

Definition at line 118 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fChargeOnlineToVEMFactor = 0

private

Definition at line 116 of file SdCalibrator.h.

bool SdCalibratorOG::SdCalibrator::fDecreaseLGFlatPieceTolerance = false

private

Definition at line 129 of file SdCalibrator.h.

PairD SdCalibratorOG::SdCalibrator::fFallTimeFractions {0, 0}

private

Definition at line 123 of file SdCalibrator.h.

int SdCalibratorOG::SdCalibrator::fFindSignalBinsAboveThreshold = 0

private

Definition at line 126 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fFindSignalThreshold = 0

private

Definition at line 125 of file SdCalibrator.h.

bool SdCalibratorOG::SdCalibrator::fIncludeWaterCherenkovDetectorInScintillatorStartStopDetermination = false

private

Definition at line 130 of file SdCalibrator.h.

int fwk::VModule::fInfoLevel = 0

protectedinherited

Definition at line 123 of file VModule.h.

Referenced by RdChannelASCIINoiseImporterRD::RdChannelASCIINoiseImporterRD::Init(), Rd2dLDFFitter::Rd2dLDFFitter::Init(), RdChannelNoiseImporter_AERA::RdChannelNoiseImporter_AERA::Init(), and Rd2dLDFFitter::Rd2dLDFFitter::Run().

bool SdCalibratorOG::SdCalibrator::fIsUUB = false

private

Definition at line 137 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fPeakFitChi2Accept = 0

private

Definition at line 109 of file SdCalibrator.h.

PairD SdCalibratorOG::SdCalibrator::fPeakFitRange {0, 0}

private

Definition at line 108 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fPeakHistogramToMIPFactor = 0

private

Definition at line 113 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fPeakHistogramToVEMFactor = 0

private

Definition at line 111 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fPeakOnlineToMIPFactor = 0

private

Definition at line 112 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fPeakOnlineToVEMFactor = 0

private

Definition at line 110 of file SdCalibrator.h.

double SdCalibratorOG::SdCalibrator::fPMTSummationCutoff = 0

private

Definition at line 105 of file SdCalibrator.h.

PairD SdCalibratorOG::SdCalibrator::fRiseTimeFractions {0, 0}

private

Definition at line 122 of file SdCalibrator.h.

PairD SdCalibratorOG::SdCalibrator::fShapeFitRangeBefore12 {0, 0}

private

Definition at line 120 of file SdCalibrator.h.

PairD SdCalibratorOG::SdCalibrator::fShapeFitRangeSince12 {0, 0}

private

Definition at line 121 of file SdCalibrator.h.

std::set<int> SdCalibratorOG::SdCalibrator::fTestStations

private

Definition at line 124 of file SdCalibrator.h.

Referenced by IsTestStation().

bool SdCalibratorOG::SdCalibrator::fToldYaCharge = false

private

Definition at line 134 of file SdCalibrator.h.

bool SdCalibratorOG::SdCalibrator::fToldYaPeak = false

private

Definition at line 133 of file SdCalibrator.h.

bool SdCalibratorOG::SdCalibrator::fToldYaShape = false

private

Definition at line 135 of file SdCalibrator.h.

bool SdCalibratorOG::SdCalibrator::fTreatHGLGEqualInSignalSearch = false

private

Definition at line 127 of file SdCalibrator.h.

const utl::TimeRange SdCalibratorOG::SdCalibrator::kCommsCrisis {utl::TimeStamp{928378815}, utl::TimeStamp{942375615}}

private

Definition at line 139 of file SdCalibrator.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation