LALSimInspiralWaveformParams.c File Reference

Prototypes
int	XLALSimInspiralCheckKnownREAL8Key (const char *key)
	Check if the key belong to the know waveform params defined in LALSimInspiralWaveformParams_common.c. More...
int	XLALSimInspiralCheckDeterminationOfMasses (LALDict *params)
	Check if the mass paramters inserted in the LALDict allow to determine the two mass components mass1, mass2. More...
int	XLALSimInspiralWaveformParamsInsertModeArray (LALDict *params, LALValue *value)
int	XLALSimInspiralWaveformParamsInsertModeArrayJframe (LALDict *params, LALValue *value)
int	XLALSimInspiralWaveformParamsInsertModeArrayFromModeString (LALDict *params, const char *modestr)
int	XLALSimInspiralWaveformParamsInsertModeArrayJframeFromModeString (LALDict *params, const char *modestr)
	DEFINE_INSERT_FUNC (PhenomXPSpinTaylorCoarseFactor, INT4, "SpinTaylorCoarseFactor", 10)
REAL8	XLALSimInspiralGetMassRatioFromSymMassRatio (REAL8 sym_mass_ratio)
REAL8	XLALSimInspiralGetMassRatioFromChirpMassComponentMass2 (REAL8 chirp_mass, REAL8 component_mass)
REAL8	XLALSimInspiralGetMassRatioFromChirpMassComponentMass1 (REAL8 chirp_mass, REAL8 component_mass)
REAL8	XLALSimInspiralWaveformParamsLookupMass1 (LALDict *params)
	Compute mass1 from any possible combination of 2 mass parameters inserted in the LALDict. More...
REAL8	XLALSimInspiralWaveformParamsLookupMass2 (LALDict *params)
	Compute mass2 from any possible combination of 2 mass parameters inserted in the LALDict. More...
REAL8	XLALSimInspiralWaveformParamsLookupTotalMass (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupMassRatio (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSymMassRatio (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupChirpMass (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupMassDifference (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupReducedMass (LALDict *params)
REAL8	XLALSimInspiralGetCartesianSpinXFromPolar (REAL8 spin_norm, REAL8 spin_tilt, REAL8 spin_phi)
REAL8	XLALSimInspiralGetCartesianSpinYFromPolar (REAL8 spin_norm, REAL8 spin_tilt, REAL8 spin_phi)
REAL8	XLALSimInspiralGetCartesianSpinZFromPolar (REAL8 spin_norm, REAL8 spin_tilt)
REAL8	XLALSimInspiralGetPolarSpin_normFromCartesian (REAL8 spinx, REAL8 spiny, REAL8 spinz)
REAL8	XLALSimInspiralGetPolarSpin_tiltFromCartesian (REAL8 spinx, REAL8 spiny, REAL8 spinz)
REAL8	XLALSimInspiralGetPolarSpin_phiFromCartesian (REAL8 spiny, REAL8 spinz)
REAL8	XLALSimInspiralWaveformParamsLookupSpin1x (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin1y (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin1z (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin2x (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin2y (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin2z (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin1norm (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin1tilt (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin1phi (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin2norm (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin2tilt (LALDict *params)
REAL8	XLALSimInspiralWaveformParamsLookupSpin2phi (LALDict *params)
LALValue *	XLALSimInspiralWaveformParamsLookupModeArray (LALDict *params)
LALValue *	XLALSimInspiralWaveformParamsLookupModeArrayJframe (LALDict *params)
	DEFINE_LOOKUP_FUNC (PhenomXPSpinTaylorCoarseFactor, INT4, "SpinTaylorCoarseFactor", 10)
int	XLALSimInspiralWaveformParamsModeArrayIsDefault (LALDict *params)
int	XLALSimInspiralWaveformParamsModeArrayJframeIsDefault (LALDict *params)
	DEFINE_ISDEFAULT_FUNC (PhenomXPSpinTaylorCoarseFactor, INT4, "SpinTaylorCoarseFactor", 10)
LALDict *	XLALSimInspiralParamsDict (const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 longAscNodes, const REAL8 eccentricity, const REAL8 f_ref, LALDict *LALparams)
	Insert common waveform parameters into LALDict. More...

Go to the source code of this file.

Macros
#define	UNREVIEWED_CODE_WARNING
#define	DEFINE_INSERT_FUNC(NAME, TYPE, KEY, DEFAULT)
#define	DEFINE_LOOKUP_FUNC(NAME, TYPE, KEY, DEFAULT)
#define	DEFINE_ISDEFAULT_FUNC(NAME, TYPE, KEY, DEFAULT)
#define	String   const char *

Macro Definition Documentation

UNREVIEWED_CODE_WARNING

#define UNREVIEWED_CODE_WARNING

Value:

  int debug_level = XLALGetDebugLevel(); \
        XLALClobberDebugLevel(2); \
        XLAL_PRINT_WARNING("This code is currently UNREVIEWED, use with caution!"); \
        XLALClobberDebugLevel(debug_level);

Definition at line 16 of file LALSimInspiralWaveformParams.c.

DEFINE_INSERT_FUNC

#define DEFINE_INSERT_FUNC	(		NAME,
			TYPE,
			KEY,
			DEFAULT
	)

Value:

        int XLALSimInspiralWaveformParamsInsert ## NAME(LALDict *params, TYPE value) \
        { \
                return XLALDictInsert ## TYPE ## Value(params, KEY, value); \
        }

Definition at line 24 of file LALSimInspiralWaveformParams.c.

DEFINE_LOOKUP_FUNC

#define DEFINE_LOOKUP_FUNC	(		NAME,
			TYPE,
			KEY,
			DEFAULT
	)

Value:

        TYPE XLALSimInspiralWaveformParamsLookup ## NAME(LALDict *params) \
        { \
                TYPE value = DEFAULT; \
                if (params && XLALDictContains(params, KEY)) \
                        value = XLALDictLookup ## TYPE ## Value(params, KEY); \
                return value; \
        }

Definition at line 30 of file LALSimInspiralWaveformParams.c.

DEFINE_ISDEFAULT_FUNC

#define DEFINE_ISDEFAULT_FUNC	(		NAME,
			TYPE,
			KEY,
			DEFAULT
	)

Value:

        int XLALSimInspiralWaveformParams ## NAME ## IsDefault(LALDict *params) \
        { \
                return XLALSimInspiralWaveformParamsLookup ## NAME(params) == DEFAULT; \
        }

Definition at line 39 of file LALSimInspiralWaveformParams.c.

String

#define String   const char *

Definition at line 62 of file LALSimInspiralWaveformParams.c.

Function Documentation

XLALSimInspiralCheckKnownREAL8Key()

int XLALSimInspiralCheckKnownREAL8Key

(

const char *

key

)

Check if the key belong to the know waveform params defined in LALSimInspiralWaveformParams_common.c.

Definition at line 72 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralCheckDeterminationOfMasses()

int XLALSimInspiralCheckDeterminationOfMasses

(

LALDict *

params

)

Check if the mass paramters inserted in the LALDict allow to determine the two mass components mass1, mass2.

It accepts only two mass parameters and at least one must be dimensionful.

Definition at line 86 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsInsertModeArray()

int XLALSimInspiralWaveformParamsInsertModeArray	(	LALDict *	params,
		LALValue *	value
	)

Definition at line 172 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsInsertModeArrayJframe()

int XLALSimInspiralWaveformParamsInsertModeArrayJframe	(	LALDict *	params,
		LALValue *	value
	)

Definition at line 177 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsInsertModeArrayFromModeString()

int XLALSimInspiralWaveformParamsInsertModeArrayFromModeString	(	LALDict *	params,
		const char *	modestr
	)

Definition at line 182 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsInsertModeArrayJframeFromModeString()

int XLALSimInspiralWaveformParamsInsertModeArrayJframeFromModeString	(	LALDict *	params,
		const char *	modestr
	)

Definition at line 190 of file LALSimInspiralWaveformParams.c.

DEFINE_INSERT_FUNC()

DEFINE_INSERT_FUNC	(	PhenomXPSpinTaylorCoarseFactor	,
		INT4	,
		"SpinTaylorCoarseFactor"	,
		10
	)

XLALSimInspiralGetMassRatioFromSymMassRatio()

REAL8 XLALSimInspiralGetMassRatioFromSymMassRatio

(

REAL8

sym_mass_ratio

)

Definition at line 425 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetMassRatioFromChirpMassComponentMass2()

REAL8 XLALSimInspiralGetMassRatioFromChirpMassComponentMass2	(	REAL8	chirp_mass,
		REAL8	component_mass
	)

Definition at line 441 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetMassRatioFromChirpMassComponentMass1()

REAL8 XLALSimInspiralGetMassRatioFromChirpMassComponentMass1	(	REAL8	chirp_mass,
		REAL8	component_mass
	)

Definition at line 446 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupMass1()

REAL8 XLALSimInspiralWaveformParamsLookupMass1

(

LALDict *

params

)

Compute mass1 from any possible combination of 2 mass parameters inserted in the LALDict.

If the combination does not allow to distinguish the largest object then it assumes m1 > m2. mass_ratio is defined as q = m2/m1 and mass_difference as m1 - m2.

Definition at line 470 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupMass2()

REAL8 XLALSimInspiralWaveformParamsLookupMass2

(

LALDict *

params

)

Compute mass2 from any possible combination of 2 mass parameters inserted in the LALDict.

If the combination does not allow to distinguish the largest object then it assumes m1 > m2. mass_ratio is defined as q = m2/m1 and mass_difference as m1 - m2.

Definition at line 651 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupTotalMass()

REAL8 XLALSimInspiralWaveformParamsLookupTotalMass

(

LALDict *

params

)

Definition at line 831 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupMassRatio()

REAL8 XLALSimInspiralWaveformParamsLookupMassRatio

(

LALDict *

params

)

Definition at line 849 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSymMassRatio()

REAL8 XLALSimInspiralWaveformParamsLookupSymMassRatio

(

LALDict *

params

)

Definition at line 867 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupChirpMass()

REAL8 XLALSimInspiralWaveformParamsLookupChirpMass

(

LALDict *

params

)

Definition at line 885 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupMassDifference()

REAL8 XLALSimInspiralWaveformParamsLookupMassDifference

(

LALDict *

params

)

Definition at line 903 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupReducedMass()

REAL8 XLALSimInspiralWaveformParamsLookupReducedMass

(

LALDict *

params

)

Definition at line 920 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetCartesianSpinXFromPolar()

REAL8 XLALSimInspiralGetCartesianSpinXFromPolar	(	REAL8	spin_norm,
		REAL8	spin_tilt,
		REAL8	spin_phi
	)

Definition at line 943 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetCartesianSpinYFromPolar()

REAL8 XLALSimInspiralGetCartesianSpinYFromPolar	(	REAL8	spin_norm,
		REAL8	spin_tilt,
		REAL8	spin_phi
	)

Definition at line 951 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetCartesianSpinZFromPolar()

REAL8 XLALSimInspiralGetCartesianSpinZFromPolar	(	REAL8	spin_norm,
		REAL8	spin_tilt
	)

Definition at line 958 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetPolarSpin_normFromCartesian()

REAL8 XLALSimInspiralGetPolarSpin_normFromCartesian	(	REAL8	spinx,
		REAL8	spiny,
		REAL8	spinz
	)

Definition at line 965 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetPolarSpin_tiltFromCartesian()

REAL8 XLALSimInspiralGetPolarSpin_tiltFromCartesian	(	REAL8	spinx,
		REAL8	spiny,
		REAL8	spinz
	)

Definition at line 972 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralGetPolarSpin_phiFromCartesian()

REAL8 XLALSimInspiralGetPolarSpin_phiFromCartesian	(	REAL8	spiny,
		REAL8	spinz
	)

Definition at line 979 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin1x()

REAL8 XLALSimInspiralWaveformParamsLookupSpin1x

(

LALDict *

params

)

Definition at line 992 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin1y()

REAL8 XLALSimInspiralWaveformParamsLookupSpin1y

(

LALDict *

params

)

Definition at line 1015 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin1z()

REAL8 XLALSimInspiralWaveformParamsLookupSpin1z

(

LALDict *

params

)

Definition at line 1038 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin2x()

REAL8 XLALSimInspiralWaveformParamsLookupSpin2x

(

LALDict *

params

)

Definition at line 1058 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin2y()

REAL8 XLALSimInspiralWaveformParamsLookupSpin2y

(

LALDict *

params

)

Definition at line 1081 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin2z()

REAL8 XLALSimInspiralWaveformParamsLookupSpin2z

(

LALDict *

params

)

Definition at line 1104 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin1norm()

REAL8 XLALSimInspiralWaveformParamsLookupSpin1norm

(

LALDict *

params

)

Definition at line 1125 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin1tilt()

REAL8 XLALSimInspiralWaveformParamsLookupSpin1tilt

(

LALDict *

params

)

Definition at line 1146 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin1phi()

REAL8 XLALSimInspiralWaveformParamsLookupSpin1phi

(

LALDict *

params

)

Definition at line 1168 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin2norm()

REAL8 XLALSimInspiralWaveformParamsLookupSpin2norm

(

LALDict *

params

)

Definition at line 1188 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin2tilt()

REAL8 XLALSimInspiralWaveformParamsLookupSpin2tilt

(

LALDict *

params

)

Definition at line 1209 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupSpin2phi()

REAL8 XLALSimInspiralWaveformParamsLookupSpin2phi

(

LALDict *

params

)

Definition at line 1230 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupModeArray()

LALValue * XLALSimInspiralWaveformParamsLookupModeArray

(

LALDict *

params

)

Definition at line 1267 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsLookupModeArrayJframe()

LALValue * XLALSimInspiralWaveformParamsLookupModeArrayJframe

(

LALDict *

params

)

Definition at line 1279 of file LALSimInspiralWaveformParams.c.

DEFINE_LOOKUP_FUNC()

DEFINE_LOOKUP_FUNC	(	PhenomXPSpinTaylorCoarseFactor	,
		INT4	,
		"SpinTaylorCoarseFactor"	,
		10
	)

XLALSimInspiralWaveformParamsModeArrayIsDefault()

int XLALSimInspiralWaveformParamsModeArrayIsDefault

(

LALDict *

params

)

Definition at line 1518 of file LALSimInspiralWaveformParams.c.

XLALSimInspiralWaveformParamsModeArrayJframeIsDefault()

int XLALSimInspiralWaveformParamsModeArrayJframeIsDefault

(

LALDict *

params

)

Definition at line 1523 of file LALSimInspiralWaveformParams.c.

DEFINE_ISDEFAULT_FUNC()

DEFINE_ISDEFAULT_FUNC	(	PhenomXPSpinTaylorCoarseFactor	,
		INT4	,
		"SpinTaylorCoarseFactor"	,
		10
	)

XLALSimInspiralParamsDict()

LALDict * XLALSimInspiralParamsDict	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	S1x,
		const REAL8	S1y,
		const REAL8	S1z,
		const REAL8	S2x,
		const REAL8	S2y,
		const REAL8	S2z,
		const REAL8	distance,
		const REAL8	inclination,
		const REAL8	phiRef,
		const REAL8	longAscNodes,
		const REAL8	eccentricity,
		const REAL8	f_ref,
		LALDict *	LALparams
	)

Insert common waveform parameters into LALDict.

Definition at line 1737 of file LALSimInspiralWaveformParams.c.