#include <RdVirtualStationNoiseImporter.h>

Inheritance diagram for RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter:

Classes
class	TimeRangeMap

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::multimap < utl::TimeStamp, std::pair < utl::TimeStamp, size_t > >	ParentMap

Private Member Functions
std::vector< int >	EventHasStations (std::vector< int > stationID, AERAevent *const aeraevent, const rdet::RDetector &rDetector)

bool	GetNoiseFileNameAtTime (const utl::UTCDateTime &dateTime, const utl::UTCDateTime &startingDay, std::string &NoiseImportfilename)

	REGISTER_MODULE ("RdVirtualStationNoiseImporter", RdVirtualStationNoiseImporter)

void	RemovePedestal (revt::ChannelADCTimeSeries &timeSeries)

void	RemovePedestal (std::vector< int > &timeSeries)

Private Attributes
bool	fCheckTimeWindow = false

std::string	fEvtSelInNoiseFile

bool	fExpectSubDirectories = false

std::string	fFilenamePrefix

std::string	fFilenameSuffix

double	fGainFactor = 0

double	fMaxTimeDifference = 10 * utl::minute

std::string	fNoiseFilePath

std::string	fNoiseFileSelection

unsigned int	fNumberOfRejectedStationsWithoutNoise = 0

utl::RandomEngine::RandomEngineType *	fRandomEngine = nullptr

utl::TimeStamp	fRandomNoiseTimeIntervalStart

utl::TimeStamp	fRandomNoiseTimeIntervalStop

TimeRangeMap	fRejectMap

bool	fReplaceDataWithNoise = false

std::vector< int >	fStationIDList

std::string	fTimeIntervalInFile

bool	fTraceShifting = true

Detailed Description

Definition at line 39 of file RdVirtualStationNoiseImporter.h.

Member Typedef Documentation

typedef std::multimap<utl::TimeStamp, std::pair<utl::TimeStamp, size_t> > RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::ParentMap

private

Definition at line 79 of file RdVirtualStationNoiseImporter.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

vector< int > RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::EventHasStations	(	std::vector< int >	stationID,
		AERAevent *const	aeraevent,
		const rdet::RDetector &	rDetector
	)

private

Definition at line 721 of file RdVirtualStationNoiseImporter.cc.

References rdet::RDetector::GetFullStationList(), and INFODebug.

fwk::VModule::ResultFlag RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::Finish ( )

overridevirtual

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 634 of file RdVirtualStationNoiseImporter.cc.

References io::eSuccess, INFO, and out.

bool RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::GetNoiseFileNameAtTime	(	const utl::UTCDateTime &	dateTime,
		const utl::UTCDateTime &	startingDay,
		std::string &	NoiseImportfilename
	)

private

Definition at line 672 of file RdVirtualStationNoiseImporter.cc.

References filename, utl::UTCDate::GetDay(), utl::UTCDateTime::GetHour(), utl::UTCDate::GetMonth(), utl::UTCDate::GetYear(), INFOFinal, and WARNING.

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

fwk::VModule::ResultFlag RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::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 52 of file RdVirtualStationNoiseImporter.cc.

References RdGeoCeLDFFitter::b, fwk::RandomEngineRegistry::eDetector, ERROR, io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetFirstChild(), fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), INFODebug, and INFOFinal.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::REGISTER_MODULE	(	"RdVirtualStationNoiseImporter"	,
		RdVirtualStationNoiseImporter
	)

private

void RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::RemovePedestal ( revt::ChannelADCTimeSeries & timeSeries )

private

Definition at line 646 of file RdVirtualStationNoiseImporter.cc.

References utl::abs(), utl::Trace< T >::Begin(), utl::Trace< T >::End(), utl::Trace< T >::GetSize(), and utl::TraceAlgorithm::Mean().

void RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::RemovePedestal ( std::vector< int > & timeSeries )

private

Definition at line 656 of file RdVirtualStationNoiseImporter.cc.

References utl::abs().

fwk::VModule::ResultFlag RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::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 113 of file RdVirtualStationNoiseImporter.cc.

References utl::abs(), revt::Station::ChannelsBegin(), rdet::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), rdet::Station::ChannelsEnd(), debug, utl::degree, revt::eManuallyRejected, ERROR, io::eSuccess, rdet::Channel::GetAntennaTypeName(), rdet::RDetector::GetBadStationReason(), rdet::Channel::GetBitDepth(), revt::Station::GetChannel(), revt::Channel::GetChannelADCTimeSeries(), rdet::Channel::GetChannelType(), rdet::RDetector::GetFullStationList(), evt::Event::GetHeader(), utl::UTCDateTime::GetHour(), rdet::Channel::GetId(), revt::Channel::GetId(), revt::Station::GetId(), rdet::Station::GetId(), evt::RadioSimulation::GetNumPulses(), rdet::Channel::GetOrientationAzimuth(), rdet::Channel::GetOrientationZenith(), evt::ShowerSimData::GetRadioSimulation(), det::Detector::GetRDetector(), rdet::Channel::GetSamplingFrequency(), utl::Trace< T >::GetSize(), rdet::RDetector::GetStation(), evt::Header::GetTime(), revt::Station::HasChannel(), evt::Event::HasREvent(), INFODebug, INFOFinal, INFOIntermediate, revt::Channel::IsActive(), utl::TraceAlgorithm::Mean(), utl::minute, std::pow(), revt::Station::SetRejectedReason(), revt::REvent::StationsBegin(), revt::REvent::StationsEnd(), det::Detector::Update(), 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

bool RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fCheckTimeWindow = false

private

Definition at line 64 of file RdVirtualStationNoiseImporter.h.

std::string RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fEvtSelInNoiseFile

private

Definition at line 61 of file RdVirtualStationNoiseImporter.h.

bool RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fExpectSubDirectories = false

private

Definition at line 50 of file RdVirtualStationNoiseImporter.h.

std::string RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fFilenamePrefix

private

Definition at line 51 of file RdVirtualStationNoiseImporter.h.

std::string RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fFilenameSuffix

private

Definition at line 52 of file RdVirtualStationNoiseImporter.h.

double RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fGainFactor = 0

private

Definition at line 66 of file RdVirtualStationNoiseImporter.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().

double RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fMaxTimeDifference = 10 * utl::minute

private

Definition at line 65 of file RdVirtualStationNoiseImporter.h.

std::string RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fNoiseFilePath

private

Definition at line 49 of file RdVirtualStationNoiseImporter.h.

std::string RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fNoiseFileSelection

private

Definition at line 48 of file RdVirtualStationNoiseImporter.h.

unsigned int RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fNumberOfRejectedStationsWithoutNoise = 0

private

Definition at line 63 of file RdVirtualStationNoiseImporter.h.

utl::RandomEngine::RandomEngineType* RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fRandomEngine = nullptr

private

Definition at line 68 of file RdVirtualStationNoiseImporter.h.

utl::TimeStamp RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fRandomNoiseTimeIntervalStart

private

Definition at line 57 of file RdVirtualStationNoiseImporter.h.

utl::TimeStamp RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fRandomNoiseTimeIntervalStop

private

Definition at line 58 of file RdVirtualStationNoiseImporter.h.

TimeRangeMap RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fRejectMap

private

Definition at line 104 of file RdVirtualStationNoiseImporter.h.

bool RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fReplaceDataWithNoise = false

private

Definition at line 55 of file RdVirtualStationNoiseImporter.h.

std::vector<int> RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fStationIDList

private

Definition at line 56 of file RdVirtualStationNoiseImporter.h.

std::string RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fTimeIntervalInFile

private

Definition at line 53 of file RdVirtualStationNoiseImporter.h.

bool RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::fTraceShifting = true

private

Definition at line 54 of file RdVirtualStationNoiseImporter.h.

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

Classes

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