Defines an event window

Inheritance:

Public Methods

explicit	Window (const TimeWindow& window = TimeWindow (1.0), int order = 1) Constructor
	Window (const Interval& width, const Interval& offset, int order = 1) Constructor
explicit	Window (pointer event) Constructor
	Window (pointer e1, pointer e2) Constructor
bool	operator== (const Window& win) const Equality operator
bool	operator!= (const Window& win) const Inequality operator
Time	GetTimeFirst () const Time of first event
Time	GetTimeLast () const Time of last event
Time	GetTime () const Time of current events
Time	GetStartTime () const Window start time
Time	GetStopTime () const Window stop time
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
void	SetOrder (int n) Set window order
int	GetOrder () const Window order
reference	operator() (int n) Current event access
const_reference	operator() (int n) const Current event access
reference	Current (int n = 0) Current event access
const_reference	Current (int n = 0) const Current event access
void	SetCurrent (int n, pointer current) Set current event
current&	GetCurrentList () Get current event list
const current&	GetCurrentList () const Get current event list
reference	Front () First
const_reference	Front () const First
reference	Back () Last
const_reference	Back () const Last
iterator	Begin () Begin
const_iterator	Begin () const Begin
iterator	End () End
const_iterator	End () const End
reference	operator[] (int n) List access
const_reference	operator[] (int n) const List access
reference	At (int n) List access
const_reference	At (int n) const List access
int	Size () const List size
bool	Empty () const List empty?
void	PushBack (pointer event) Add an element
void	PushFront (pointer event) Add an element
void	PopBack () Remove an element
void	PopFront () Remove an element
void	Clear () Clear list

Public Members

typedef Event	value_type Value type
typedef Event*	pointer Pointer type
typedef const Event*	const_pointer Const pointer type
typedef Event&	reference Reference type
typedef const Event&	const_reference Const reference type
typedef Iterator	iterator Iterator type
typedef ConstIterator	const_iterator Const iterator type
typedef std::deque<pointer>	list List of event pointers
typedef std::vector<pointer>	current List of current event pointers

Documentation

An event window is a utility class which manages a set of events which fall within a time window. The idea is that an analysis program will defined a maximum duration within to look for events. During the analysis this time window is moved through the series of events until all events are porcessed. An event window can be any coincidence order. An order of one means that the window refernces one current event and the list of events with in the time window. An order of two means that two events are currently selected for a concidence analysis. A triple coincidence would have an order of three, and so on.

An event window provides iterators to go through the list of events in the window.

typedef Event value_type

Value type

typedef Event* pointer

Pointer type

typedef const Event* const_pointer

Const pointer type

typedef Event& reference

Reference type

typedef const Event& const_reference

Const reference type

typedef Iterator iterator

Iterator type

typedef ConstIterator const_iterator

Const iterator type

typedef std::deque<pointer> list

List of event pointers

typedef std::vector<pointer> current

List of current event pointers

explicit Window(const TimeWindow& window = TimeWindow (1.0), int order = 1)

Creates an event window. For a symmetric window set the offset to the negative of half the window width.

Parameters:

window - Time window
order - Coincidence order

Window(const Interval& width, const Interval& offset, int order = 1)

Creates an event window. For a symmetric window set the offset to the negative of half the window width.

Parameters:

width - Width of window
offset - Window offset
order - Coincidence order

explicit Window(pointer event)

Creates a window from a single event.

Window(pointer e1, pointer e2)

Creates a window from two events.

bool operator== (const Window& win) const

Equality operator. Two windows are the same if they have the same order and the same current events.

bool operator!= (const Window& win) const

Inequality operator

Time GetTimeFirst() const

Time of first event in the list

Time GetTimeLast() const

Time of last event in the list

Time GetTime() const

Time. Averaged time of current event(s).

Time GetStartTime() const

Start time of window

Time GetStopTime() const

Stop time of window

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.

void SetOrder(int n)

Set window order. How many current or coincidence events can be selected?

int GetOrder() const

Get window order. How many current or coincidence events are selected?

reference operator() (int n)

Access the current event(s).

const_reference operator() (int n) const

Access the current event(s).

reference Current(int n = 0)

Access the current event(s).

const_reference Current(int n = 0) const

Access the current event(s).

void SetCurrent(int n, pointer current)

Set the current event(s).

current& GetCurrentList()

Get the list of current event(s).

const current& GetCurrentList() const

Get the list of current event(s).

reference Front()

First event in window.

const_reference Front() const

First event in window.

reference Back()

Last event in window.

const_reference Back() const

Last event in window.

iterator Begin()

Beginning of list.

const_iterator Begin() const

Beginning of list.

iterator End()

End of list.

const_iterator End() const

End of list.

reference operator[] (int n)

List access.

const_reference operator[] (int n) const

List access.

reference At(int n)

List access.

const_reference At(int n) const

List access.

int Size() const

List size.

bool Empty() const

List empty?.

void PushBack(pointer event)

Add an element at the end.

void PushFront(pointer event)

Add an element at the beginning.

void PopBack()

Remove an element from the end.

void PopFront()

Remove an element from the beginning.

void Clear()

Clear list.

This class has no child classes.

Author:

Written June 2001 by Masahiro Ito and Daniel Sigg

Version:

1.0

Alphabetic index HTML hierarchy of classes or Java

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