#include <RdStationSignalReconstructorWithBgSubtraction.h>

Inheritance diagram for RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction:

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 ()
	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 ()
	Initialize: invoked at beginning of run (NOT beginning of event) More...

void	InitTiming ()

	RdStationSignalReconstructorWithBgSubtraction ()

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

ResultFlag	RunWithTiming (evt::Event &event)

virtual	~RdStationSignalReconstructorWithBgSubtraction ()

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

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

Private Member Functions
void	CalculateTheBGAverage (revt::ChannelFFTDataContainer &Long_FFTDataContainer, unsigned int nWindows, int nBin, int ntimeBin, double const sigmaB, double const meanB) const

void	EnergyFluenceIntegral (revt::ChannelFrequencySpectrum &channeltrace, const std::vector< double > &uncertainty, double &integratedSignal, double &energyFluenceUncertainty, const bool usePower) const

double	GetAdjustedSignalAmplitude (const double signalAmpitude, const double snr) const
	the formula is documented in GAP 2013-059 More...

double	GetSignalTimeUncertainty (const double snr) const

double	GetSignalUncertainty (const double signalAmplitude, const double snr) const

void	Noisefinder (const revt::ChannelTimeSeries &channeltrace, double &RMSNoise, double &MeanNoise, double NoiseWindowStart, double NoiseWindowStop) const

void	Pulsefinder (const revt::ChannelTimeSeries &channeltrace, double &PeakAmplitude, double &PeakTime, double &PeakTimeError, double SignalSearchWindowStart, double SignalSearchWindowStop, unsigned int &sample) const

void	PulseFWHMIntegrator (const revt::ChannelTimeSeries &channeltrace, unsigned int sample, double PeakAmplitude, double &SignalFWHM, double &IntegratedSignal, double &SignalWindowStart, double &SignalWindowStop) const

	REGISTER_MODULE ("RdStationSignalReconstructorWithBgSubtraction", RdStationSignalReconstructorWithBgSubtraction)

Private Attributes
TF1 *	f_sigmoind = nullptr

bool	fBackGroundSubtraction = false

double	fBlackSpiderAntennaUncertainty = 0

double	fButterflyAntennaUncertainty = 0

const double	fConversionSignalToEnergyFluence = 2.65441729 * 1e-3 * 1.e-9 * 6.24150934 * 1e6

double	fDefaultAntennaUncertainty = 0

double	fEnergyFluenceIntegrationWindowStart = 0

double	fEnergyFluenceIntegrationWindowStop = 0

int	fInfoLevel = 0

double	fMinSignal = 0

double	fMinSignalToNoise = 0

unsigned int	fNumberOfEvents1SignalStations = 0

unsigned int	fNumberOfEvents2SignalStations = 0

unsigned int	fNumberOfEvents3SignalStations = 0

unsigned int	fNumberOfEvents4SignalStations = 0

unsigned int	fNumberOfEvents5plusSignalStations = 0

unsigned int	fNumberOfEvents5SignalStations = 0

double	fRelativeAmplitudeUncertainty = 0

bool	fSelfTriggeredSNcut = true

double	fSignalIntegrationWindowSize = 0

unsigned int	fTotalNumberOfEvents = 0

bool	fUseEnvelope = false

unsigned int	fVectorialComponent = 0

utl::AnalyticWindow *	fWindow = nullptr

double	fWindowSizeOnEachSide = 0

Detailed Description

Definition at line 42 of file RdStationSignalReconstructorWithBgSubtraction.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.

Constructor & Destructor Documentation

RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction ( )

inline

Definition at line 45 of file RdStationSignalReconstructorWithBgSubtraction.h.

virtual RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::~RdStationSignalReconstructorWithBgSubtraction ( )

inlinevirtual

Definition at line 46 of file RdStationSignalReconstructorWithBgSubtraction.h.

Member Function Documentation

void RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::CalculateTheBGAverage	(	revt::ChannelFFTDataContainer &	Long_FFTDataContainer,
		unsigned int	nWindows,
		int	nBin,
		int	ntimeBin,
		double *const	sigmaB,
		double *const	meanB
	)		const

private

Definition at line 813 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::abs(), utl::Trace< T >::Clear(), utl::Trace< T >::GetBinning(), utl::FFTDataContainer< C, T, F >::GetFrequencySpectrum(), utl::FFTDataContainer< C, T, F >::GetTimeSeries(), std::pow(), utl::Trace< T >::PushBack(), utl::Trace< T >::SetBinning(), and sqrt().

void RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::EnergyFluenceIntegral	(	revt::ChannelFrequencySpectrum &	channeltrace,
		const std::vector< double > &	uncertainty,
		double &	integratedSignal,
		double &	energyFluenceUncertainty,
		const bool	usePower
	)		const

private

Definition at line 791 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::abs(), utl::Trace< T >::GetSize(), RdBeamFormer::norm(), utl::Sqr(), and sqrt().

VModule::ResultFlag RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::Finish ( )

virtual

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 705 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References io::eSuccess, and INFO.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::GetAdjustedSignalAmplitude	(	const double	signalAmpitude,
		const double	snr
	)		const

private

the formula is documented in GAP 2013-059

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().

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::GetSignalTimeUncertainty ( const double snr ) const

private

Definition at line 783 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::ns, and std::pow().

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::GetSignalUncertainty	(	const double	signalAmplitude,
		const double	snr
	)		const

private

Definition at line 775 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References std::pow(), and sqrt().

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 RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::Init ( )

virtual

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 74 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, and INFODebug.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

void RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::Noisefinder	(	const revt::ChannelTimeSeries &	channeltrace,
		double &	RMSNoise,
		double &	MeanNoise,
		double	NoiseWindowStart,
		double	NoiseWindowStop
	)		const

private

Definition at line 736 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::Trace< T >::GetBinning(), and un2::Mean().

void RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::Pulsefinder	(	const revt::ChannelTimeSeries &	channeltrace,
		double &	PeakAmplitude,
		double &	PeakTime,
		double &	PeakTimeError,
		double	SignalSearchWindowStart,
		double	SignalSearchWindowStop,
		unsigned int &	sample
	)		const

private

Definition at line 749 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::Trace< T >::GetBinning(), OUT, and sqrt().

void RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::PulseFWHMIntegrator	(	const revt::ChannelTimeSeries &	channeltrace,
		unsigned int	sample,
		double	PeakAmplitude,
		double &	SignalFWHM,
		double &	IntegratedSignal,
		double &	SignalWindowStart,
		double &	SignalWindowStop
	)		const

private

Definition at line 849 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::Trace< T >::GetBinning(), and utl::Trace< T >::GetSize().

RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::REGISTER_MODULE	(	"RdStationSignalReconstructorWithBgSubtraction"	,
		RdStationSignalReconstructorWithBgSubtraction
	)

private

VModule::ResultFlag RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::Run ( evt::Event & event )

virtual

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 112 of file RdStationSignalReconstructorWithBgSubtraction.cc.

References utl::abs(), revt::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), utl::Trace< T >::Clear(), fwk::LocalCoordinateSystemConstructor< Policy >::Create(), utl::Cross(), ERROR, revt::StationTriggerData::eSelf, io::eSuccess, utl::Trace< T >::GetBinning(), revt::Station::GetFFTDataContainer(), utl::FFTDataContainer< C, T, F >::GetFrequencySpectrum(), revt::Channel::GetId(), revt::Station::GetId(), evt::ShowerRRecData::GetMagneticFieldVector(), revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), revt::Station::GetRecData(), evt::ShowerRRecData::GetReferenceAxis(), evt::ShowerRRecData::GetReferenceCorePosition(), utl::Trace< T >::GetSize(), utl::FFTDataContainer< C, T, F >::GetTimeSeries(), revt::Station::GetTriggerData(), revt::StationTriggerData::GetTriggerSource(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), utl::BasicVector< HepVector >::GetZ(), revt::Station::HasRecData(), evt::Event::HasRecShower(), evt::ShowerRRecData::HasReferenceAxis(), evt::ShowerRRecData::HasReferenceCorePosition(), evt::Event::HasREvent(), evt::ShowerRecData::HasRRecShower(), INFO, INFODebug, INFOFinal, INFOIntermediate, evt::Event::MakeRecShower(), evt::ShowerRecData::MakeRRecShower(), max, utl::microvolt, RdBeamFormer::norm(), utl::Normalized(), OUT, std::pow(), utl::Trace< T >::PushBack(), utl::Trace< T >::SetBinning(), revt::Station::SetNoSignal(), revt::StationRecData::SetParameter(), revt::StationRecData::SetParameterError(), revt::StationRecData::SetPulseFound(), revt::Station::SetSignal(), utl::Sqr(), sqrt(), revt::REvent::StationsBegin(), revt::REvent::StationsEnd(), 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().

Member Data Documentation

TF1* RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::f_sigmoind = nullptr

private

Definition at line 118 of file RdStationSignalReconstructorWithBgSubtraction.h.

bool RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fBackGroundSubtraction = false

private

Definition at line 101 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fBlackSpiderAntennaUncertainty = 0

private

Definition at line 97 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fButterflyAntennaUncertainty = 0

private

Definition at line 96 of file RdStationSignalReconstructorWithBgSubtraction.h.

const double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fConversionSignalToEnergyFluence = 2.65441729 * 1e-3 * 1.e-9 * 6.24150934 * 1e6

private

Definition at line 116 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fDefaultAntennaUncertainty = 0

private

Definition at line 95 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fEnergyFluenceIntegrationWindowStart = 0

private

Definition at line 89 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fEnergyFluenceIntegrationWindowStop = 0

private

Definition at line 90 of file RdStationSignalReconstructorWithBgSubtraction.h.

int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fInfoLevel = 0

private

Definition at line 111 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fMinSignal = 0

private

Definition at line 92 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fMinSignalToNoise = 0

private

Definition at line 93 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fNumberOfEvents1SignalStations = 0

private

Definition at line 104 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fNumberOfEvents2SignalStations = 0

private

Definition at line 105 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fNumberOfEvents3SignalStations = 0

private

Definition at line 106 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fNumberOfEvents4SignalStations = 0

private

Definition at line 107 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fNumberOfEvents5plusSignalStations = 0

private

Definition at line 109 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fNumberOfEvents5SignalStations = 0

private

Definition at line 108 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fRelativeAmplitudeUncertainty = 0

private

Definition at line 98 of file RdStationSignalReconstructorWithBgSubtraction.h.

bool RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fSelfTriggeredSNcut = true

private

Definition at line 100 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fSignalIntegrationWindowSize = 0

private

Definition at line 88 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fTotalNumberOfEvents = 0

private

Definition at line 103 of file RdStationSignalReconstructorWithBgSubtraction.h.

bool RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fUseEnvelope = false

private

Definition at line 87 of file RdStationSignalReconstructorWithBgSubtraction.h.

unsigned int RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fVectorialComponent = 0

private

Definition at line 86 of file RdStationSignalReconstructorWithBgSubtraction.h.

utl::AnalyticWindow* RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fWindow = nullptr

private

Definition at line 117 of file RdStationSignalReconstructorWithBgSubtraction.h.

double RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::fWindowSizeOnEachSide = 0

private

Definition at line 94 of file RdStationSignalReconstructorWithBgSubtraction.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation