Basic window iterator

Inheritance:

Public Methods

	BasicWindowIterator () Default constructor
	BasicWindowIterator (const ConstIterator& beg, const ConstIterator& end, int order = 1, const TimeWindow& window = 1.0) Constructor
	BasicWindowIterator (const ConstIterator& beg1, const ConstIterator& end1, const ConstIterator& beg2, const ConstIterator& end2, const TimeWindow& window = 1.0) Constructor
	BasicWindowIterator (const ConstIterator& beg1, const ConstIterator& end1, const ConstIterator& beg2, const ConstIterator& end2, const ConstIterator& beg3, const ConstIterator& end3, const TimeWindow& window = 1.0) Constructor
	BasicWindowIterator (const InputStateList& state, const TimeWindow& window = 1.0) Constructor
int	GetOrder () const Get event window order

Public Members

struct	InputState State of iterator in input
typedef std::vector<InputState>	InputStateList List of iterator states

Protected Methods

void	InitWindow () Init window
void	Increment () Increment operator
int	GetPermutations () const Get number of permutations
void	SetPermutation () Set permutation to window
Window&	GetWindow () Get event window
const Window&	GetWindow () const Get event window

Documentation

Basic window iterator class. Helper class for WindowIterator and ConstWindowIterator.

struct InputState

State of iterator in input

ConstIterator mBegin

Begin

ConstIterator mEnd

End

ConstIterator mFirst

First event (for window list)

ConstIterator mNext

Next event (for window list)

ConstIterator mCur

Current event

InputState()

Constructor

InputState(const ConstIterator& beg, const ConstIterator& end)

Constructor

typedef std::vector<InputState> InputStateList

List of iterator states

BasicWindowIterator()

Creates an NULL window iterator. Equivalent to an end iterator

BasicWindowIterator(const ConstIterator& beg, const ConstIterator& end, int order = 1, const TimeWindow& window = 1.0)

Creates an window iterator from a an iterator range. Works from a single input stream.

Parameters:

beg - Beginning of event range
- end End of event range
order - Coincidence order
window - Anlysis window (in sec)
offset - Offset of analysis window (in sec)

BasicWindowIterator(const ConstIterator& beg1, const ConstIterator& end1, const ConstIterator& beg2, const ConstIterator& end2, const TimeWindow& window = 1.0)

Creates an window iterator from two iterator ranges. This is a simple coincidence between two input lists, hence the coincidence order is 2.

Parameters:

beg1 - Beginning of first event range
end1 - End of first event range
beg2 - Beginning of second event range
end2 - End of second event range
window - Anlysis window (in sec)
offset - Offset of analysis window (in sec)

BasicWindowIterator(const ConstIterator& beg1, const ConstIterator& end1, const ConstIterator& beg2, const ConstIterator& end2, const ConstIterator& beg3, const ConstIterator& end3, const TimeWindow& window = 1.0)

Creates an window iterator from three iterator ranges. This is a simple coincidence between three input lists, hence the coincidence order is 3.

Parameters:

beg1 - Beginning of first event range
end1 - End of first event range
beg2 - Beginning of second event range
end2 - End of second event range
beg3 - Beginning of third event range
end3 - End of third event range
window - Anlysis window (in sec)
offset - Offset of analysis window (in sec)

BasicWindowIterator(const InputStateList& state, const TimeWindow& window = 1.0)

Creates an window iterator from multiple iterator ranges. This is a simple coincidence between multiple input lists. The coincidence order is the equal the length of the input list.

Parameters:

- state List of input event ranges
window - Anlysis window (in sec)
offset - Offset of analysis window (in sec)

int GetOrder() const

Get the event window order.

void InitWindow()

Initializes the window

void Increment()

Increments the iterator

int GetPermutations() const

Gets the number of coincidence permutations for the present event list.

void SetPermutation()

Set the current events in window according to the permutations index.

Window& GetWindow()

Get the event window.

const Window& GetWindow() const

Get the event window.

Direct child classes:

WindowIterator
ConstWindowIterator

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