Tutorial module for plotting all of the GOES pixels over the array. More...

#include <PlotGOES.h>

Inheritance diagram for PlotGOESNS::PlotGOES:

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

	PlotGOES ()

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

ResultFlag	RunWithTiming (evt::Event &event)

virtual	~PlotGOES ()

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 Member Functions
	REGISTER_MODULE ("PlotGOES", PlotGOES)

Private Attributes
bool	fPlotFDFOV

std::vector< std::string >	fPlotFormats

utl::TimeStamp	fTimeFinish

utl::TimeStamp	fTimeStart

utl::TimeInterval	fTimeStep

Detailed Description

Tutorial module for plotting all of the GOES pixels over the array.

This module shows how to get all of the GOES pixels in one call and iterate over them to plot the whole array. It also shows how to set up a colour scale that correctly represents GOES cloud probabilities.

Definition at line 60 of file PlotGOES.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

PlotGOES::PlotGOES ( )

Definition at line 14 of file PlotGOES.cc.

PlotGOES::~PlotGOES ( )

virtual

Definition at line 17 of file PlotGOES.cc.

Member Function Documentation

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

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

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

References fwk::VModule::eFailure, fwk::VModule::eSuccess, FATAL, fPlotFDFOV, fPlotFormats, fTimeFinish, fTimeStart, fTimeStep, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), and fwk::CentralConfig::GetInstance().

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

PlotGOESNS::PlotGOES::REGISTER_MODULE	(	"PlotGOES"	,
		PlotGOES
	)

private

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

References RdGeoCeLDFFitter::b, utl::degree, fwk::VModule::eSuccess, fPlotFDFOV, fPlotFormats, fTimeFinish, fTimeStart, fTimeStep, utl::g, det::Detector::GetAtmosphere(), utl::UTMPoint::GetEasting(), det::Detector::GetFDetector(), atm::Atmosphere::GetGOESDB(), utl::UTMPoint::GetNorthing(), det::Detector::GetSDetector(), utl::ReferenceEllipsoid::GetWGS84(), utl::km, G4StationSimulatorOG::p, utl::TransformationMatrix::RotationZ(), 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

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 PlotGOESNS::PlotGOES::fPlotFDFOV

private

Definition at line 78 of file PlotGOES.h.

Referenced by Init(), and Run().

std::vector<std::string> PlotGOESNS::PlotGOES::fPlotFormats

private

Definition at line 77 of file PlotGOES.h.

Referenced by Init(), and Run().

utl::TimeStamp PlotGOESNS::PlotGOES::fTimeFinish

private

Definition at line 74 of file PlotGOES.h.

Referenced by Init(), and Run().

utl::TimeStamp PlotGOESNS::PlotGOES::fTimeStart

private

Definition at line 73 of file PlotGOES.h.

Referenced by Init(), and Run().

utl::TimeInterval PlotGOESNS::PlotGOES::fTimeStep

private

Definition at line 75 of file PlotGOES.h.

Referenced by Init(), and Run().

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 Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation