class Cluster : public Condition

Defines an event cluster condition

Inheritance:

Public Fields

ifndef __CINT__ typedef std::vector < const Event* >

eventlist Event list

Public Methods

	Cluster () Default constructor
	Cluster (int threshold, const TimeWindow& window) Constructor
	Cluster (int threshold, const Interval& duration, const Interval& offset) Constructor
	Cluster (const Condition& cond, int threshold, const TimeWindow& window) Constructor
	Cluster (const Condition& cond, int threshold, const Interval& duration, const Interval& offset) Constructor
virtual Cluster*	Copy () const Copy the event
virtual bool	Evaluate (const Argument& arg, bool& val) const Evaluate
int	GetClusters (const Argument& arg, eventlist& list) const Evaluate
const ConditionPtr&	GetCondition () const Get event condition
void	SetThreshold (int threshold) Set threshold
int	GetThreshold () const Get threshold
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&)

ifndef __CINT__ typedef std::vector < const Event* > eventlist

Event list

Cluster()

Creates a default event cluster condition. All events are considered. The default threshold is three. The default window is 1s.

Cluster(int threshold, const TimeWindow& window)

Creates an event cluster condition. All events are considered.

Parameters:

threshold - Cluster threshold (number of events)
duration - Duration of veto window
offset - Time offset for veto start (relative to event)

Cluster(int threshold, const Interval& duration, const Interval& offset)

Creates an event cluster condition. All events are considered.

Parameters:

threshold - Cluster threshold (number of events)
duration - Duration of veto window
offset - Time offset for veto start (relative to event)

Cluster(const Condition& cond, int threshold, const TimeWindow& window)

Creates an event cluster condition.

Parameters:

cond - Event condition for cluster participants
threshold - Cluster threshold (number of events)
duration - Duration of veto window

Cluster(const Condition& cond, int threshold, const Interval& duration, const Interval& offset)

Creates an event cluster condition.

Parameters:

cond - Event condition for cluster participants
threshold - Cluster threshold (number of events)
duration - Duration of veto window
offset - Time offset for veto start (relative to event)

virtual Cluster* 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 condition. This function must be overriden by descendents.

Returns:

True if condition could be evaluated

Parameters:

arg - Event argument list
val - Condition value (return)

int GetClusters(const Argument& arg, eventlist& list) const

Evaluates the cluster condition. Returns the number of clusters found as well as a list of them.

Returns:

True if condition could be evaluated

Parameters:

arg - Event argument list
val - Condition value (return)
list - Events belonging to the cluster (return)

const ConditionPtr& GetCondition() const

Get the event condition.

void SetThreshold(int threshold)

Set the cluster threshold.

int GetThreshold() const

Get the cluster threshold.

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.

alphabetic index hierarchy of classes

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

generated by doc++