InjGen Class Reference

Generate a set of injections. More...

#include <InjGen.h>

Inheritance diagram for InjGen:

[legend]

Collaboration diagram for InjGen:

[legend]

List of all members.

Public Member Functions
int	GenerateInjections (void)
	Generates a set of injection parameters.
bool	SetAmplitudeDistribution (const string aDistribution="LOG")
	Sets the injection amplitude distribution.
bool	SetAmplitudeRange (const double aMin=1e-22, const double aMax=5e-19)
	Sets the injection amplitude range.
bool	SetEccentricityDistribution (const string aDistribution="UNIFORM")
	Sets the injection eccentricity distribution.
bool	SetEccentricityRange (const double aMin=0.0, const double aMax=1.0)
	Sets the injection eccentricity range.
bool	SetFrequencyDistribution (const string aDistribution="LOG")
	Sets the injection frequency distribution.
bool	SetFrequencyRange (const double aMin=30.0, const double aMax=2048.0)
	Sets the injection frequency range.
void	SetInjectionSpacing (const double aSpacing)
	Sets time space between 2 consecutive injections.
bool	SetPolarizationDistribution (const string aDistribution="UNIFORM")
	Sets the injection polarization distribution.
bool	SetPolarizationRange (const double aMin=0.0, const double aMax=2.0 *TMath::Pi())
	Sets the injection polarization range.
bool	SetSigmaDistribution (const string aDistribution="UNIFORM")
	Sets the injection sigma distribution.
bool	SetSigmaRange (const double aMin=0.01, const double aMax=1.0)
	Sets the injection sigma range.
Constructors and destructors
	InjGen (Segments *aInSegments, const string aInjType, const int aVerbose=0)
	Constructor of the InjGen class.
virtual	~InjGen ()
	Destructor of the InjTre class.

---

Detailed Description

Generate a set of injections.

Author:

Florent Robinet

---

Constructor & Destructor Documentation

InjGen::InjGen	(	Segments *	aInSegments,
		const string	aInjType,
		const int	aVerbose = 0
	)

Constructor of the InjGen class.

Injections are performed over a set of Segments. The injection type must be provided:

• "Gauss" for Gaussian injections
• "SineGauss" for sine-Gaussian injections

Parameters:

	aInSegments	input segments
	aInjType	injection type
	aVerbose	verbosity level

InjGen::~InjGen

(

void

)

[virtual]

Destructor of the InjTre class.

---

Member Function Documentation

int InjGen::GenerateInjections

(

void

)

Generates a set of injection parameters.

Returns the number of injections.

bool InjGen::SetAmplitudeDistribution

(

const string

aDistribution = "LOG"

)

Sets the injection amplitude distribution.

Amplitudes can either be logarithmically distributed ("LOG") or uniformly distributed ("UNIFORM").

Parameters:

aDistribution

distribution type

bool InjGen::SetAmplitudeRange	(	const double	aMin = 1e-22,
		const double	aMax = 5e-19
	)

Sets the injection amplitude range.

Parameters:

	aMin	minimum amplitude
	aMax	maximum amplitude

bool InjGen::SetEccentricityDistribution

(

const string

aDistribution = "UNIFORM"

)

Sets the injection eccentricity distribution.

Eccentricities can either be logarithmically distributed ("LOG") or uniformly distributed ("UNIFORM").

Parameters:

aDistribution

distribution type

bool InjGen::SetEccentricityRange	(	const double	aMin = 0.0,
		const double	aMax = 1.0
	)

Sets the injection eccentricity range.

Parameters:

	aMin	minimum eccentricity
	aMax	maximum eccentricity

bool InjGen::SetFrequencyDistribution

(

const string

aDistribution = "LOG"

)

Sets the injection frequency distribution.

Frequencies can either be logarithmically distributed ("LOG") or uniformly distributed ("UNIFORM").

Parameters:

aDistribution

distribution type

bool InjGen::SetFrequencyRange	(	const double	aMin = 30.0,
		const double	aMax = 2048.0
	)

Sets the injection frequency range.

Parameters:

	aMin	minimum frequency [Hz]
	aMax	maximum frequency [Hz]

void InjGen::SetInjectionSpacing

(

const double

aSpacing

)

[inline]

Sets time space between 2 consecutive injections.

Parameters:

aSpacing

time space [s]

bool InjGen::SetPolarizationDistribution

(

const string

aDistribution = "UNIFORM"

)

Sets the injection polarization distribution.

Polarizations can either be logarithmically distributed ("LOG") or uniformly distributed ("UNIFORM").

Parameters:

aDistribution

distribution type

bool InjGen::SetPolarizationRange	(	const double	aMin = 0.0,
		const double	aMax = 2.0*TMath::Pi()
	)

Sets the injection polarization range.

Parameters:

	aMin	minimum polarization [rad]
	aMax	maximum polarization [rad]

bool InjGen::SetSigmaDistribution

(

const string

aDistribution = "UNIFORM"

)

Sets the injection sigma distribution.

Sigmas can either be logarithmically distributed ("LOG") or uniformly distributed ("UNIFORM").

Parameters:

aDistribution

distribution type

bool InjGen::SetSigmaRange	(	const double	aMin = 0.01,
		const double	aMax = 1.0
	)

Sets the injection sigma range.

Parameters:

	aMin	minimum sigma [s]
	aMax	maximum sigma [s]

---

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

• /afs/in2p3.fr/throng/virgo/virgoDev/SoftFlorent/GWOLLUM/v2r2/src/Inject/InjGen.h
• /afs/in2p3.fr/throng/virgo/virgoDev/SoftFlorent/GWOLLUM/v2r2/src/Inject/InjGen.cc