Streams Class Reference

Manage streams. More...

#include <Streams.h>

List of all members.

Public Member Functions
bool	GetDetAMResponse (double *fplus, double *fcross, const double ra, const double dec, const double psi, const double gmst)
	Computes F+ and Fx.
int	GetDetIndex (void)
	Returns the detector index for this stream.
string	GetDetPrefix (void)
	Returns the detector prefix for this stream.
string	GetName (void)
	Returns the stream full name.
string	GetNamePrefix (void)
	Returns the stream name prefix.
string	GetNameSuffix (void)
	Returns the stream name suffix.
bool	GetStatus (void)
	Returns class status.
bool	MakeLVDetector (void)
	Makes this stream a detector from the LIGO-Virgo (LV) global network.
bool	SetName (const string aNewName)
	Sets a new name to the stream.
Constructors and destructors
	Streams (const string aName, const int aVerbose=0)
	Constructor of the Streams class.
virtual	~Streams (void)
	Destructor of the ReadCoinc class.

---

Detailed Description

Manage streams.

This class was designed to manage Streams as defined in the GWOLLUM convention for streams. In particular, the Stream object can be converted as one detectors of the LIGO-virgo global network. In that case many specific functions are provided to access the detector properties.

Author:

Florent Robinet

---

Constructor & Destructor Documentation

Streams::Streams	(	const string	aName,
		const int	aVerbose = 0
	)

Constructor of the Streams class.

The stream is defined by its name which should contain at least 2 characters.

Parameters:

	aName	stream name
	aVerbose	verbosity level

Streams::~Streams

(

void

)

[virtual]

Destructor of the ReadCoinc class.

---

Member Function Documentation

bool Streams::GetDetAMResponse	(	double *	fplus,
		double *	fcross,
		const double	ra,
		const double	dec,
		const double	psi,
		const double	gmst
	)

Computes F+ and Fx.

Returns F+ and Fx values for a source at a specified sky position, polarization angle, and sidereal time. This function only works if the stream has been turned into a detector (see MakeLVDetector()). true is returned if success.

Parameters:

	fplus	pointer to F+ value
	fcross	pointer to Fx value
	ra	right ascension [rad]
	dec	declination [rad]
	psi	polarisation angle [rad]
	gmst	sideral time [s]

int Streams::GetDetIndex

(

void

)

[inline]

Returns the detector index for this stream.

Returns -1 if this stream was not converted into a LV detector (see MakeLVDetector()).

string Streams::GetDetPrefix

(

void

)

[inline]

Returns the detector prefix for this stream.

Returns "" if this stream was not converted into a LV detector (see MakeLVDetector()).

string Streams::GetName

(

void

)

[inline]

Returns the stream full name.

string Streams::GetNamePrefix

(

void

)

[inline]

Returns the stream name prefix.

string Streams::GetNameSuffix

(

void

)

[inline]

Returns the stream name suffix.

bool Streams::GetStatus

(

void

)

[inline]

Returns class status.

bool Streams::MakeLVDetector

(

void

)

Makes this stream a detector from the LIGO-Virgo (LV) global network.

When this function is called, the stream is considered as a LIGO-Virgo detector, provided the stream prefix match a known detector prefix. The stream name can be changed with SetName();

bool Streams::SetName

(

const string

aNewName

)

Sets a new name to the stream.

Parameters:

aNewName

new name

---

The documentation for this class was generated from the following files:

• /afs/in2p3.fr/throng/virgo/virgoDev/GWOLLUM/v1r3/src/Streams/Streams.h
• /afs/in2p3.fr/throng/virgo/virgoDev/GWOLLUM/v1r3/src/Streams/Streams.cc