TimeSlides Class Reference

Define a set of time lags for a network of streams. More...

#include <TimeSlides.h>

Inheritance diagram for TimeSlides:

Public Member Functions
int	GetNLags (void)
	Returns the current number of lags.
int	GetNlags (void)
	Returns the current number of lags.
int	GetNstreams (void)
	Returns the number of streams.
int	GetNStreams (void)
	Returns the number of streams.
double	GetTimeOffset (const int aStreamIndex, const int aLagIndex)
	Returns the time offset for lag 'aLagIndex' and stream 'aStreamIndex'.
bool	MakeLags (const int aN, const double aDt)
	Generates lags.
bool	PrintSlides (const int aVerbose=1)
	Prints the offset values for all lags.
Constructors and destructors

	TimeSlides (const int aNstreams, const int aVerbose=0)
	Constructor of the TimeSlides class.
	TimeSlides (const TimeSlides &InTimeSlides)
	Copy Constructor of the TimeSlides class.
virtual	~TimeSlides (void)
	Destructor of the TimeSlides class.
Protected Attributes
int	Nstreams
	number of data streams
TTree *	SlideTree
	TimeSlide tree.
double *	t_offset
	time offsets
int	verbose
	verbosity level

Detailed Description

Define a set of time lags for a network of streams.

This class was designed to generate time offsets for N data streams. The TimeSlides object follows the GWOLLUM convention for time-slide.

Author:: Florent Robinet

Constructor & Destructor Documentation

TimeSlides::TimeSlides ( const TimeSlides & InTimeSlides )

Copy Constructor of the TimeSlides class.

TimeSlides::TimeSlides	(	const int	aNstreams,
		const int	aVerbose = `0`
	)

Constructor of the TimeSlides class.

Parameters:

	aNstreams	number of input streams
	aVerbose	verbosity level

TimeSlides::~TimeSlides ( void ) [virtual]

Destructor of the TimeSlides class.

Member Function Documentation

int TimeSlides::GetNLags ( void ) [inline]

Returns the current number of lags.

int TimeSlides::GetNlags ( void ) [inline]

Returns the current number of lags.

int TimeSlides::GetNstreams ( void ) [inline]

Returns the number of streams.

int TimeSlides::GetNStreams ( void ) [inline]

Returns the number of streams.

double TimeSlides::GetTimeOffset	(	const int	aStreamIndex,
		const int	aLagIndex
	)

Returns the time offset for lag 'aLagIndex' and stream 'aStreamIndex'.

Returns -1e20 if it fails.

Parameters:

	aStreamIndex	stream index
	aLagIndex	lag index

bool TimeSlides::MakeLags	(	const int	aN,
		const double	aDt
	)

Generates lags.

The TimeSlide object is first reset and aN time lags are generated in addition to the zero-lag.

For 2 streams, the first stream remains fixed (offset=0.0) and the second stream is shifted alternatively in a positive and negative direction with an incremental offset of aDt.

For 3 streams, the first stream remain fixed (offset=0.0) and the second stream is shifted alternatively in a positive and negative direction with an incremental offset of aDt. The third stream shift takes the opposite value of the 2nd stream shift.

Parameters: