Generator

namespace generator class Generator

DMT data generation class.

Public Methods
Generator(void): Default Generator constructor
~Generator(void): Generator destructor
int addChannel(const char* chan, int detID=0, const Pipe* daq=0): Add a channel to the list of channels to be simulated
int addDetector(const char* ifo): Add specified ifo to the detector list.
int addDetector(const GenDet& det): Add an IFO to the Generator list.
int addSource(const std::string& name, const DataSource& data): Add a named data source.
int addSource(const std::string& name, DataSource* data=0): Add an existing DataSource to the Generator source list.
void generate(const Time& t0, Interval dT): Generate dat for the specified time range.
void releaseSourceData(const Time& t0): Release source data
void releaseChannelData(const Time& t0): Release channel data
Interval getGenerStride(void) const: Get the generation stride.
Time getLatest(void) const: Get the last generation time.
int getNChannel(void) const: Get the number of channels.
int getNDetector(void) const: Get the number of detectors.
int getNSource(void) const: Get the number of data sources
const GenChan& refChannel(int id) const: Get a constant reference to the specified channel ID
GenChan& refChannel(int id): Get a reference to the specified channel ID
const GenDet& refDetector(int id) const: Get a constant reference to a Detector definition
GenDet& refDetector(int id): Get a constant reference to a Detector definition
const DataSource& refSource(int id) const: Get a constant referecne to the data cource object with the specified index
DataSource& refSource(int id): Get a referecne to the data cource object with the specified index
int getSourceID(const std::string& name) const: get named source index.
void setDebug(int lvl): Set the debug verbosity level
void setGenerStride(Interval dt): Get the generation stride.

Documentation

The Generator class generates data for a monte carlo study of LIGO analysis routines. The signals are optionally passed through a response filter and then added to the noise. One or more signals may be injected either at fixed or random times. The data sources and output channels are specified using the "addSource" and "addCHannel" methods.

Generator(void)

Default Generator constructor

~Generator(void)

Generator destructor

int addChannel(const char* chan, int detID=0, const Pipe* daq=0)

Add a channel to the list of channels to be simulated. The channel definition includes a name, a detector identifier.

Returns:: New channel index
Parameters:: chan - Channel name
detID - Detector index
daq - DAQ simulation filter pipe.

int addDetector(const char* ifo)

Add default detector information for the specified ifo

Returns:: Index of the added detector.
Parameters:: ifo - Two digit standard IFO name (in the form "Xn")

int addDetector(const GenDet& det)

Add an IFO to the Generator list.

Parameters:: det - Detector specifier.

int addSource(const std::string& name, const DataSource& data)

Create a copy of a data source and add the copy to the data source list.

Returns:: Source index.
Parameters:: name - Name of the data source.
data - Data source to be cloned

int addSource(const std::string& name, DataSource* data=0)

Add a data source object to the Genereator source list. The specified object is added to the list. Ownership of the DataSource is passed to the generator class object.