namespace generator class SinGauss : public DataSource

Sine-Gaussian function generator.

Inheritance:


Public Methods

SinGauss(void)
Default constructor
SinGauss(double Amp, double Freq, double Q, double Phi=0.0, double wid=6.0)
Construct a SinGauss data source and initialize the waveform parameters
~SinGauss(void)
Destroy a SinGauss data source
SinGauss* clone(void) const
Create an identical copy of a SinGauss object
const char* getDataType(void) const
Return a constant string containing the data source type, "SinGauss"
Interval getDuration(void) const
Return the duration of the data to be generated

Inherited from DataSource:

Public Classes

enum RepMode
kContinuous
Continuous data source
kSingle
Generate a single event
kRate
Generate events with poisson statistics
kFixed
Generate events at fixed intervals
class SrcEvent
SrcEvent(void)
Default SrcEvent constructor
SrcEvent(const std::string& name, const std::string& comment, const Time& t0, Interval before, Interval after, const ParamMap& map)
SrcEvent data constructor
const char* getComment(void) const
Get the comment field
const char* getInputs(void) const
Get the input data
const char* getName(void) const
Get the data source name
const Time& getGPSMax(void) const
Get the GPS time of the maximum value
Interval getTimeBefore(void) const
Get the duration of the generated waveform before the maximum time
Interval getTimeAfter(void) const
Get the duration of the generated waveform after the maximum time
double getAmplitude(void) const
Get the waveform amplitude
const ParamList& getParamList(void) const
Get a list of the generated parameters

Public Methods

static DataSource* parse(const std::string& desc)
virtual std::ostream& dump(std::ostream& out) const
bool isContinuous(void) const
void generate(const Time& t0, Interval dt)
int getDebug(void) const
Time getLatest(void) const
const char* getName(void) const
virtual double getNumeric(const std::string& name) const
virtual const char* getParameter(const std::string& name) const
double getRate(void) const
Interval getSample(void) const
virtual Interval getStartOffset(void) const
Time getStartTime(void) const
Time getTrigTime(void) const
TSeries getTimeSeries(const Time& t0, Interval dT) const
const TSeries& getTimeSeries(void) const
virtual std::string getSourceName(void) const
virtual void randomize(void)
void release(const Time& t0)
void setDebug(int lvl)
void setName(const std::string& name)
virtual void setParameter(const std::string& name, const std::string& val)
virtual void setParameter(const std::string& name, double value)
void setSample(Interval dT)
void setTriggerRate(double rate)
void setTriggerTime(const Time& t0)
bool getWriteFlag(void) const
bool getSaveFlag(void) const
void setWriteFlag(bool yorn=true)
void setSaveFlag(bool yorn=true)
unsigned long getNEvent(void) const
const SrcEvent& refEvent(void) const
const SrcEvent& refEvent(unsigned long i) const
void eraseEvent(unsigned long N)

Documentation

SinGauss is an analytical function data source that generates a sinusoid of arbitrary phase multiplied by a gaussian envelope (i.e. a sine-gaussian). The generated waveform is:


The wave-form parameters that may be specified by the generation control function are:

Parameter Default Meaning
A - Gaussian envelope amplitude at t=to
F - Sinusoid frequency (in Hz)
Q - Quality factor
Phi 0 Phase () at t=to (in degrees)
Width 6 Half-width of the waveform to be generated (in units)

At the default width value of 6.0, the gaussian envelope has decreased to of its central amplitude.

SinGauss(void)
Default constructor

SinGauss(double Amp, double Freq, double Q, double Phi=0.0, double wid=6.0)
Construct a SinGauss data source and initialize the waveform parameters
Parameters:
Amp - the amplitude at t=to.
Freq - the sinusoid frequency (in Hz).
Q - the quality factor.
Phi - the sinusoid phase at t=to (in degrees).
wid - the half width of the generated data in units of Q/(2*pi*F).

~SinGauss(void)
Destroy a SinGauss data source

SinGauss* clone(void) const
Create an identical copy of a SinGauss object

const char* getDataType(void) const
Return a constant string containing the data source type, "SinGauss"

Interval getDuration(void) const
Return the duration of the data to be generated. For SinGauss this is evaluated on an event by event basis and is 2*Width*Q/F.


This class has no child classes.
Author:
John Zweizig
Version:
1.1; last modified April 21, 2004

alphabetic index hierarchy of classes


generated by doc++