class PulsarMon : public DatEnv, MonServer

PulsarMon class for DMT pulsar monitor.

Inheritance:

Public Methods

PulsarMon(int argc, const char *argv[])
Constructor.
~PulsarMon(void)
Destructor.
void ProcessData(void)
Process data statement.
virtual void RevolverSummary(const Time& t, Parameter Run_Par, Range_Data R_Dat)
Write an abbreviated html page summarizing the monitor and interferometer status.
virtual void Summary(const Time& t, Parameter Run_Par, Range_Data R_Dat)
Write an html page summarizing the monitor and interferometer status.
virtual void Configure(std::string& filename)
Read run parameters from specified configuration file.
virtual void Configure(int argc, const char *argv[])
Read run parameters from command-line arguments.
virtual void VerifyParameters(Parameter& Run_Par, bool& fatal_error)
Perform various checks on monitor parameters.
virtual void DumpParameters(std::ostream& file)
Dump run parameters to specified output stream.
virtual void DumpReportHeader(std::ostream& out)
Write column headers for range data to specified output stream.
virtual void DumpReportHeader(std::ostream& out, double frequency)
Write column headers for range data to specified output stream.
virtual void ReportResults(std::ostream& out, const Time& t, Parameter& Run_Par)
Write current range and calibration information to the specified output stream.
virtual void Attention(void)
Handle signals to monitor.

Public

Reread configuration file.
Act on SIGUSR1 signal.

Documentation

The PulsarMon class is the base class for a DMT monitor of the same name which produces estimates of the Figure of Merit of known and unknown Pulsars
PulsarMon(int argc, const char *argv[])
Construct a PulsarMon object.

~PulsarMon(void)
Destroy a PulsarMon object.

void ProcessData(void)
Process data statement. The monitor reads a specified amount of time-series data for the LSC-AS_Q channel and computes the different Pulsars FOMs

virtual void RevolverSummary(const Time& t, Parameter Run_Par, Range_Data R_Dat)
Write a brief html page summarizing the monitor and interferometer status. The file is named <IFO>_PulsarMon_Summary.revolver.html, where <IFO> is one of L1, H1, or H2. FILE IS WRITTEN TO WHAT DIRECTORY?
Parameters:
t - Start time of data for which summary is written.
Run_Par - Struct Parameter holding SenseMonitor parameters.
R_Dat - Struct Range_Data holding data on recent range and calibration.

virtual void Summary(const Time& t, Parameter Run_Par, Range_Data R_Dat)
Write an html page summarizing the monitor and interferometer status. The file is named index.html. FILE IS WRITTEN TO WHAT DIRECTORY?
Parameters:
t - Start time of data for which summary is written.
Run_Par - Struct Parameter holding SenseMonitor parameters.
R_Dat - Struct Range_Data holding data on recent range and calibration.

virtual void Configure(std::string& filename)
Read run parameters from specified configuration file. See documentation for syntax.
Parameters:
filename - Name of configuration file.

virtual void Configure(int argc, const char *argv[])
Read run parameters from command-line arguments. See documentation for syntax.

virtual void VerifyParameters(Parameter& Run_Par, bool& fatal_error)
Perform various checks on monitor parameters and set bool fatal_error to TRUE if any of the following hold: stride is not an integer multiple of number of averages; low frequency is not less than high frequency; calibration file(s) cannot be opened; operating state condition (OSC) configuration file cannot be opened. Also prints warnings under various conditions.
Parameters:
Run_Par - Struct Parameter holding PulsarMon parameters.
fatal_error - Set to TRUE if parameters in Run_Par are not valid.

virtual void DumpParameters(std::ostream& file)
Dump run parameters to specified output stream. Dumps all members of specified Parameter except dyncal and config_file_name, plus MaxStride, frequency of the calibration line tracked (if any), frequency and amplitude of the simulated calibration line (if any), plus open-loop gain and sensing function data if dyncal is TRUE. Output is human-readable, and each line begins with the character (except for calbration data).
Parameters:
file - Ouput stream.

virtual void DumpReportHeader(std::ostream& out)
Write column headers for range data to specified output stream. The precise header information depends on whether the calibration line is tracked.
Parameters:
out - Output stream to which to dump headers.

virtual void DumpReportHeader(std::ostream& out, double frequency)
Write column headers for range data to specified output stream. The precise header information depends on whether the calibration line is tracked.
Parameters:
out - Output stream to which to dump headers.
frequency - Frequency of calibration line to be tracked for calibration adjustments (use zero if no such line).

virtual void ReportResults(std::ostream& out, const Time& t, Parameter& Run_Par)
Write current range and calibration information to the specified output stream.
Parameters:
out - Output stream to which to write information.

Reread configuration file and extract new values for `beta' and nominal calibration-line amplitude (only).

Act on SIGUSR1 signal (reread configuration file).

virtual void Attention(void)
Handle signals to monitor.

This class has no child classes.

alphabetic index hierarchy of classes

generated by doc++