Trigger result base class.

Inheritance:

Public Methods

	TrigBase (void) Default constructor.
	TrigBase (const TrigBase& trig) Copy constructor.
	TrigBase (const char* ID, const char* SubID=0, const Time& When=Time(0), const Interval& dTime=0.0, double Size=1.0, double Signif=1.0, double Frequency=0.0, const char* ifo=0) Create a trigger object.
virtual	~TrigBase (void) Destroy a TrigBase object.
double	getBandwidth (void) const Trigger frequency.
index_type	getData (index_type inx, index_type len, char* data) const Get a substring of the result data.
int	getDisposition (void) const Get the trigger disposition mask.
Interval	getDt (void) const Get trigger duration.
double	getFrequency (void) const Trigger middle frequency.
const char*	getID (void) const Get the trigger ID.
const char*	getIFOs (void) const Get the trigger ID.
double	getLowF (void) const Low trigger frequency.
double	getIntensity (void) const Trigger Intensity.
double	getHighF (void) const High trigger frequency.
TrigPrio	getPriority (void) const Get trigger priority.
const char*	getProcess (void) const Trigger process ID.
const char*	getResult (void) const Get the trigger Result data.
index_type	getResultLength (void) const Get the trigger result data length.
double	getSignificance (void) const Trigger Significance.
const char*	getSubID (void) const Get the trigger sub-ID.
Time	getTime (void) const Get trigger time.
Interval	getPeakOffset (void) const Get the time offset from the start time to the time of the peak sample in the trigger
Interval	getAvgOffset (void) const Get the time offset from the start time to the time of the peak sample in the trigger
Time	getPeakTime (void) const Get the time of the peak sample in the trigger
Time	getAvgTime (void) const Get the time offset from the start time to the time of the peak sample in the trigger
Interval	getTimeSigma (void) const Get the width of the power distribution in time.
double	getFreqPeak (void) const Get the peak frequency of the trigger
double	getFreqAvg (void) const Get the time power weighted average frequency
double	getFreqSigma (void) const Get the sigma of the power distribution in frequency
double	getNoisePower (void) const Get the noise power in the trigger time-frequency interval
double	getSignalPower (void) const Get the signal power in the trigger time-frequency interval
int	getPixelCount (void) const Get the number of time frequency pixels needed to span the trigger
double	getConfidence (void) const Get the confidence limit for the trigger
TrigBase&	operator= (const TrigBase& trigger) Assignment operator.
bool	operator== (const TrigBase& trigger) const Compare operator.
void	appData (const char* data, index_type len) Append data to result data text.
void	modData (const char* data, index_type inx, index_type len) Replace a substring of the result data.
void	setBandwidth (double bw) Set the bandwidth.
void	setData (const char* data, index_type len) Append data to result data text.
void	setDisposition (int disp) Set the trigger disposition.
void	setDuration (Interval dT) Set the trigger duration.
void	setFrequency (double F0) Set the frequency.
void	setIfos (const char* IFO) Set the interferometer ID.
void	setIntensity (double Mag) Set the intensit.
void	setSignificance (double sigma) Set the significance.
void	setTime (const Time& T0) Set the trigger time.
void	setPriority (TrigPrio prio) Set the trigger priority level.
void	setProcess (const char* Process) Set the trigger process ID.
void	setPeakOffset (Interval dT) Set the peak time sample for the trigger
void	setAvgOffset (Interval dT) Set the power weighted time average
void	setPeakTime (const Time& t) Set the peak time sample for the trigger
void	setAvgTime (const Time& t) Set the power weighted time average
void	setTimeSigma (Interval s) Set the sigms of the power distribution in time
void	setFreqPeak (double f) Set the frequency of the peak in the power distribution in frequency
void	setFreqAvg (double f) Set the power weightd average frequency
void	setFreqSigma (double s) Set the sigma of the power distribution in frequency
void	setNoisePower (double np) Set the total noise power in the time-frequency region containing the trigger effect
void	setSignalPower (double sp) Set the total signal power in the tim-frequency region containing the trigger effect
void	setPixelCount (int N) Set the number of time-frequency pixels covering the trigger
void	setConfidence (double cl) Set log of the confidence of the trigger effect
void	zeroResult (index_type inx, index_type len) Zero a substring of the result data.

Protected Methods

char*

getResult (void) Get the trigger Result data.

Documentation

The trigger base class contains the information needed from all triggers. It may be used as a base for a specific trigger object. Data contained in the trigger base provide all the information needed to select triggers for cross correlation studies, etc. A 1kB space is allocated for additional, trigger specific (result) data to be provided by the concrete trigger method.

TrigBase(void)

Construct an empty trigger object.

TrigBase(const TrigBase& trig)

Copy a trigger.

TrigBase(const char* ID, const char* SubID=0, const Time& When=Time(0), const Interval& dTime=0.0, double Size=1.0, double Signif=1.0, double Frequency=0.0, const char* ifo=0)

A trigger object is created and initialized as specified by the constructor arguments.

Parameters:

ID - Primary trigger identifier
SubID - Secondary trigger i dentifier.
When - Trigger time
dTime - Trigger duration
- Size Trigger Peak amplitude
Signif - Trigger significance (S/N)
Frequency - Trigger center frequency.
ifo - Trigger ifo name.

virtual ~TrigBase(void)

Release the data after recording the trigger.

double getBandwidth(void) const

Get the triggered frequency bandwidth.

Returns:

Trigger effect low fequency.

index_type getData(index_type inx, index_type len, char* data) const

Copy the specified substring of the trigger result data. Only data in the interval (0, mLength) will be copied.

Parameters:

inx - Offset into the result data of text to be replaced.
len - Length of result data increment in bytes.
data - Pointer to result data increment.

Returns:

Number of bytes actually copied.

int getDisposition(void) const

Get the trigger disposition mask.

Returns:

Trigger disposition mask.

Interval getDt(void) const

The trigger time offset from the start of the data epoch is returned.

Returns:

The interval corresponding to the duration of the effect being trigger on.

double getFrequency(void) const

Get the midpoint of triggered frequency band.

Returns:

Trigger effect middle fequency.

const char* getID(void) const

Get the trigger ID.

Returns:

Trigger ID.

const char* getIFOs(void) const

Get the trigger ID.

Returns:

Trigger ID.

double getLowF(void) const

Get the lower edge of the triggered frequency band.

Returns:

Trigger effect low fequency.

double getIntensity(void) const

Get the trigger effect intensity in units of the trigger threshold.

Returns:

Trigger effect intensity.

double getHighF(void) const

Get the upper edge of the triggered frequency band.

Returns:

Trigger effect high fequency.

TrigPrio getPriority(void) const

Get the priority level for this trigger.

Returns:

Trigger priority level.

const char* getProcess(void) const

Get the process ID for this trigger.

Returns:

Unique process ID.

const char* getResult(void) const

Get a pointer to the trigger result data. The result data are in general binary numbers and are specific to the trigger type.

Returns:

Pointer to the trigger result data.

index_type getResultLength(void) const

The trigger result data length is returned.

Returns:

Length of trigger result data in bytes.

double getSignificance(void) const

Get the trigger effect significance in units of the error on the trigger amplitude.

Returns:

Trigger effect significance.

const char* getSubID(void) const

The trigger sub-ID is returned. The sub-ID is defined by the trigger program to indicate more prcisely the reason for the trigger.

Returns:

trigger sub-ID.

Time getTime(void) const

Get the time at which the effect being triggered on starts.

Returns:

GPS start time of effect.

Interval getPeakOffset(void) const

Get the time offset from the start time to the time of the peak sample in the trigger

Returns:

Peak time offset.

Interval getAvgOffset(void) const

Get the time offset from the start time to the time of the peak sample in the trigger

Returns:

Average time offset.

Time getPeakTime(void) const

Get the time of the peak sample in the trigger

Returns:

Trigger peak time.

Time getAvgTime(void) const

Get the time offset from the start time to the time of the peak sample in the trigger

Returns:

Trigger average time.

Interval getTimeSigma(void) const

Get the width of the power distribution in time.

Returns:

Width of the time distribution.

double getFreqPeak(void) const

Get the peak frequency of the trigger

double getFreqAvg(void) const

Get the time power weighted average frequency

double getFreqSigma(void) const

Get the sigma of the power distribution in frequency

double getNoisePower(void) const

Get the noise power in the trigger time-frequency interval

double getSignalPower(void) const

Get the signal power in the trigger time-frequency interval

int getPixelCount(void) const

Get the number of time frequency pixels needed to span the trigger

double getConfidence(void) const

Get the confidence limit for the trigger

TrigBase& operator=(const TrigBase& trigger)

Copy a trigger.

bool operator==(const TrigBase& trigger) const

Compare two triggers.

void appData(const char* data, index_type len)

The specified data are appended to the trigger result data. The result data are assumed to be binary numbers, meaning that no content checking is performed and any number of embedded null characters are allowed. The total result data length must not exceed maxDataLength bytes.

Parameters:

data - Pointer to result data increment.
len - Length of result data increment in bytes.

void modData(const char* data, index_type inx, index_type len)

The specified data replace a substring of the trigger result data. The result data are treated as a binary string in that no content checking is performed and any number of embedded null characters are allowed. The result data length must not exceed 1024 bytes.

Parameters:

data - Pointer to result data increment.
len - Length of result data increment in bytes.
inx - Offset into the result data of text to be replaced.

void setBandwidth(double bw)

The bandwidth field of the trigger is replaced with the argument value.

Parameters:

bw - Bandwidth in Hz.

void setData(const char* data, index_type len)

The specified data replace the trigger result data. The result data are assumed to be binary numbers, meaning that no content checking is performed and any number of embedded null characters are allowed. The result data length must not exceed 1024 bytes.

Parameters:

data - Pointer to replacement data.
len - Length of result data increment in bytes.

void setDisposition(int disp)

Set the disposition for this trigger.

Parameters:

Trigger - disposition.

void setDuration(Interval dT)

Set the duration for this trigger.

Parameters:

Trigger - duration.

void setFrequency(double F0)

Set the typical frequency (ie. the midpoint of the frequency band) of the effect being triggered on.

Parameters:

F0 - Trigger effect frequency in Hz.

void setIfos(const char* IFO)

Set the interferometer ID for this trigger.

Parameters:

IFO - interferometer ID.

void setIntensity(double Mag)

Set the intensity for this trigger.

Parameters:

Mag - trigger intensity.

void setSignificance(double sigma)

Set the significance for this trigger.

Parameters:

Trigger - significance.

void setTime(const Time& T0)

Set the trigger time stamp. The time stamp can be any time that best defines the particular type of trigger, e.g. start time peak time, critical time, etc.

Parameters:

T0 - Time to be recorded in the trigger object.

void setPriority(TrigPrio prio)

Set the priority level for this trigger.

Parameters:

prio - Trigger priority level.

void setProcess(const char* Process)

Set the process ID for this trigger.

Parameters:

Process - Unique process ID.

void setPeakOffset(Interval dT)

Set the peak time sample for the trigger

void setAvgOffset(Interval dT)

Set the power weighted time average

void setPeakTime(const Time& t)

Set the peak time sample for the trigger

void setAvgTime(const Time& t)

Set the power weighted time average

void setTimeSigma(Interval s)

Set the sigms of the power distribution in time

void setFreqPeak(double f)

Set the frequency of the peak in the power distribution in frequency

void setFreqAvg(double f)

Set the power weightd average frequency

void setFreqSigma(double s)

Set the sigma of the power distribution in frequency

void setNoisePower(double np)

Set the total noise power in the time-frequency region containing the trigger effect

void setSignalPower(double sp)

Set the total signal power in the tim-frequency region containing the trigger effect

void setPixelCount(int N)

Set the number of time-frequency pixels covering the trigger

void setConfidence(double cl)

Set log of the confidence of the trigger effect

void zeroResult(index_type inx, index_type len)

A substring of the trigger result data is zeroed.

Parameters:

len - Length of result data increment in bytes.
inx - Offset into the result data of text to be replaced.

char* getResult(void)

Get a pointer to the trigger result data. The result data are in general binary numbers and are specific to the trigger type.

Returns:

Pointer to the trigger result data.

Direct child classes:

TrigRslt

Author:

J. Zweizig

Version:

1.3; Modified July 14, 2004

Alphabetic index HTML hierarchy of classes or Java

Please send questions and comments to zweizig_j@ligo-wa.caltech.edu