In file Veto.hh:

namespace events class Veto : public Condition

Defines an veto condition

Inheritance:

Public Methods

Veto ()
Default constructor
Veto (const Interval& duration, const Interval& offset)
Constructor
explicit Veto (const TimeWindow& window)
Constructor
Veto (const Condition& cond, const Interval& duration, const Interval& offset)
Constructor
Veto (const Condition& cond, const TimeWindow& window)
Constructor
virtual Veto* Copy () const
Copy the event
virtual bool Evaluate (const Argument& arg, bool& val) const
Evaluate
const ConditionPtr& GetCondition () const
Get event condition
void SetWindow (const TimeWindow& window)
Set time window
void SetWindow (const Interval& width, const Interval& offset)
Set time window
void SetOffset (const Interval& offset)
Set time offset
Interval GetOffset () const
Get time offset
void SetWidth (const Interval& duration)
Set time duration
Interval GetWidth () const
Get time duration

Inherited from Condition:

Public Methods

bool operator) (const Argument& arg, bool& val) const
bool operator) (const Event& event, bool& val) const
static const Condition& True()
static const Condition& False()

Protected Methods

Condition& operator= (const Condition&)

Documentation

Describes an event veto. An event veto consists of a condition and a time window around the event time. The veto conditions yields true if an event which fullfills the condition falls within the veto window around the analysed event. This means a condition which wants to rejects events which are close to a veto event has to be specified something like 
    Filter ("burst::*") && !Veto (Filter ("glitch::psl"), 0.1, -0.05)

The time window is defined relative to the time of the first current event. Current events are ignored in the veto condition and none of them is checked against the veto condition. The veto condition is called with same event list as the veto class, but with a single current event which is set to the event test for.

A veto condition can also be used to specify a coincidence condition! The following example demonstrates this: 

    Filter ("burst::*") && Veto (Filter ("burst::*"), 0.1)
looks for two burst events which fall within 100ms. To avoid the confusion this example may create, the alias Coincide is defined which makes the example more readable, but otherwise behaves like the veto condition: 
    Filter ("burst::*") && Coincide (Filter ("burst::*"), 0.1)
yields the same result as the previous example.

Basically, the terms veto and conicide do not describe different outcomes of a condition, but rather how the occurance of a close-by second event is treated in the analysis.

Veto()
Creates an default event veto (+/-0.5sec)

Veto(const Interval& duration, const Interval& offset)
Creates an event veto. Any event is considered.
Parameters:
cond - Condition
duration - Duration of veto window
offset - Time offset for veto start (relative to event)

explicit Veto(const TimeWindow& window)
Creates an event veto. Any event is considered. The veto window is symmetric around the analyzed event.
Parameters:
cond - Condition
duration - Duration of veto window

Veto(const Condition& cond, const Interval& duration, const Interval& offset)
Creates an event veto. Takes a condition as an argument. Typically an event filter is used.
Parameters:
cond - Condition
offset - Time offset for veto start (relative to event)
duration - Duration of veto window

Veto(const Condition& cond, const TimeWindow& window)
Creates an event veto. Takes a condition as an argument. The veto window is symmetric around the analyzed event.
Parameters:
cond - Condition
duration - Duration of veto window

virtual Veto* Copy() const
Returns a copy of the event condition. This method must be overriden by all descendents.
Returns:
event copy

virtual bool Evaluate(const Argument& arg, bool& val) const
Evaluate the veto. This function must be overriden by descendents.
Returns:
True if condition could be evaluated
Parameters:
arg - Event argument list
val - Condition value (return)

const ConditionPtr& GetCondition() const
Get the event condition.

void SetWindow(const TimeWindow& window)
Set the time window.

void SetWindow(const Interval& width, const Interval& offset)
Set the time window.
Parameters:
width - Window duration
offset - Window offset

void SetOffset(const Interval& offset)
Set the time offset.

Interval GetOffset() const
Get the time offset.

void SetWidth(const Interval& duration)
Set the time duration.

Interval GetWidth() const
Get the time duration.

This class has no child classes.
Author:
Written June 2001 by Masahiro Ito and Daniel Sigg
Version:
1.0

alphabetic index hierarchy of classes

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

generated by doc++