Detailed Description

Routines to manipulate inspiral waveform flags structures.

Prototypes
LALSimInspiralWaveformFlags *	XLALSimInspiralCreateWaveformFlags (void)
	Create a new LALSimInspiralWaveformFlags struct with all flags set to their default values. More...

void	XLALSimInspiralDestroyWaveformFlags (LALSimInspiralWaveformFlags *waveFlags)
	Destroy a LALSimInspiralWaveformFlags struct. More...

bool	XLALSimInspiralWaveformParamsFlagsAreDefault (LALDict *params)
	Returns true if waveFlags is non-NULL and all of its fields have default value; returns false otherwise. More...

bool	XLALSimInspiralWaveformFlagsIsDefaultOLD (LALSimInspiralWaveformFlags *waveFlags)
	Returns true if waveFlags is non-NULL and all of its fields have default value; returns false otherwise. More...

bool	XLALSimInspiralWaveformFlagsEqualOLD (LALSimInspiralWaveformFlags waveFlags1, LALSimInspiralWaveformFlags waveFlags2)
	Checks if all flags in two LALSimInspiralWaveformFlags structs are equal. More...

bool	XLALSimInspiralWaveformFlagsEqual (LALDict LALpars1, LALDict LALpars2)
	Checks if all flags in two LALSimInspiralWaveformFlags structs are equal. More...

void	XLALSimInspiralSetSpinOrder (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralSpinOrder spinO)
	Set the LALSimInspiralSpinOrder within a LALSimInspiralWaveformFlags struct. More...

LALSimInspiralSpinOrder	XLALSimInspiralGetSpinOrder (LALSimInspiralWaveformFlags *waveFlags)
	Get the LALSimInspiralSpinOrder within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT if waveFlags is NULL. More...

bool	XLALSimInspiralSpinOrderIsDefault (LALSimInspiralSpinOrder spinO)
	Returns true if LALSimInspiralSpinOrder has default value returns false otherwise. More...

void	XLALSimInspiralSetTidalOrder (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralTidalOrder tideO)
	Set the LALSimInspiralTidalOrder within a LALSimInspiralWaveformFlags struct. More...

LALSimInspiralTidalOrder	XLALSimInspiralGetTidalOrder (LALSimInspiralWaveformFlags *waveFlags)
	Get the LALSimInspiralTidalOrder within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT if waveFlags is NULL. More...

bool	XLALSimInspiralTidalOrderIsDefault (LALSimInspiralTidalOrder tideO)
	Returns true if LALSimInspiralTidalOrder has default value returns false otherwise. More...

void	XLALSimInspiralSetFrameAxis (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralFrameAxis axisChoice)
	Set the LALSimInspiralFrameAxis within a LALSimInspiralWaveformFlags struct. More...

LALSimInspiralFrameAxis	XLALSimInspiralGetFrameAxis (LALSimInspiralWaveformFlags *waveFlags)
	Get the LALSimInspiralFrameAxis within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT if waveFlags is NULL. More...

bool	XLALSimInspiralFrameAxisIsDefault (LALSimInspiralFrameAxis axisChoice)
	Returns true if LALSimInspiralFrameAxis has default value returns false otherwise. More...

void	XLALSimInspiralSetModesChoice (LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralModesChoice modesChoice)
	Set the LALSimInspiralModesChoice within a LALSimInspiralWaveformFlags struct. More...

LALSimInspiralModesChoice	XLALSimInspiralGetModesChoice (LALSimInspiralWaveformFlags *waveFlags)
	Get the LALSimInspiralModesChoice within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT if waveFlags is NULL. More...

bool	XLALSimInspiralModesChoiceIsDefault (LALSimInspiralModesChoice modesChoice)
	Returns true if LALSimInspiralModesChoice has default value returns false otherwise. More...

void	XLALSimInspiralSetNumrelDataOLD (LALSimInspiralWaveformFlags waveFlags, const char numreldata)
	Set the numreldata string within a LALSimInspiralWaveformFlags struct. More...

char *	XLALSimInspiralGetNumrelDataOLD (LALSimInspiralWaveformFlags *waveFlags)
	Returns a deepcopy of the pointer of the numeraldata attribute of the waveFlags structure. More...

LALValue *	XLALSimInspiralCreateModeArray (void)
	Create a LALValue pointer to store the mode array. More...

LALValue *	XLALSimInspiralModeArrayActivateMode (LALValue *modes, unsigned l, int m)

LALValue *	XLALSimInspiralModeArrayDeactivateMode (LALValue *modes, unsigned l, int m)

LALValue *	XLALSimInspiralModeArrayActivateAllModes (LALValue *modes)

LALValue *	XLALSimInspiralModeArrayDeactivateAllModes (LALValue *modes)

int	XLALSimInspiralModeArrayIsModeActive (LALValue *modes, unsigned l, int m)

LALValue *	XLALSimInspiralModeArrayActivateAllModesAtL (LALValue *modes, unsigned l)

LALValue *	XLALSimInspiralModeArrayDeactivateAllModesAtL (LALValue *modes, unsigned l)

int	XLALSimInspiralModeArrayPrintModes (LALValue *modes)

INT2Sequence *	XLALSimInspiralModeArrayReadModes (LALValue *modes)

char *	XLALSimInspiralModeArrayToModeString (LALValue *modes)

LALValue *	XLALSimInspiralModeArrayFromModeString (const char *modestr)

Variables
static char	empty_modes [((LAL_SIM_L_MAX_MODE_ARRAY+1) *(LAL_SIM_L_MAX_MODE_ARRAY+1))/CHAR_BIT+2] = { '\0' }

Function Documentation

◆ XLALSimInspiralCreateWaveformFlags()

LALSimInspiralWaveformFlags* XLALSimInspiralCreateWaveformFlags ( void )

Create a new LALSimInspiralWaveformFlags struct with all flags set to their default values.

Remember to destroy the struct when you are done with it.

Definition at line 61 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralDestroyWaveformFlags()

void XLALSimInspiralDestroyWaveformFlags ( LALSimInspiralWaveformFlags * waveFlags )

Destroy a LALSimInspiralWaveformFlags struct.

Definition at line 88 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralWaveformParamsFlagsAreDefault()

bool XLALSimInspiralWaveformParamsFlagsAreDefault ( LALDict * params )

Returns true if waveFlags is non-NULL and all of its fields have default value; returns false otherwise.

Definition at line 101 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralWaveformFlagsIsDefaultOLD()

bool XLALSimInspiralWaveformFlagsIsDefaultOLD ( LALSimInspiralWaveformFlags * waveFlags )

Returns true if waveFlags is non-NULL and all of its fields have default value; returns false otherwise.

Definition at line 115 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralWaveformFlagsEqualOLD()

bool XLALSimInspiralWaveformFlagsEqualOLD	(	LALSimInspiralWaveformFlags *	waveFlags1,
		LALSimInspiralWaveformFlags *	waveFlags2
	)

Checks if all flags in two LALSimInspiralWaveformFlags structs are equal.

Returns true if all flags are equal. Returns false if one or more differ.

Definition at line 132 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralWaveformFlagsEqual()

bool XLALSimInspiralWaveformFlagsEqual	(	LALDict *	LALpars1,
		LALDict *	LALpars2
	)

Checks if all flags in two LALSimInspiralWaveformFlags structs are equal.

Returns true if all flags are equal. Returns false if one or more differ.

Definition at line 159 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralSetSpinOrder()

void XLALSimInspiralSetSpinOrder	(	LALSimInspiralWaveformFlags *	waveFlags,
		LALSimInspiralSpinOrder	spinO
	)

Set the LALSimInspiralSpinOrder within a LALSimInspiralWaveformFlags struct.

Parameters

waveFlags	Struct whose flag will be set
spinO	value to set flag to

Definition at line 185 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralGetSpinOrder()

LALSimInspiralSpinOrder XLALSimInspiralGetSpinOrder ( LALSimInspiralWaveformFlags * waveFlags )

Get the LALSimInspiralSpinOrder within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT if waveFlags is NULL.

Definition at line 199 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralSpinOrderIsDefault()

bool XLALSimInspiralSpinOrderIsDefault ( LALSimInspiralSpinOrder spinO )

Returns true if LALSimInspiralSpinOrder has default value returns false otherwise.

Definition at line 213 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralSetTidalOrder()

void XLALSimInspiralSetTidalOrder	(	LALSimInspiralWaveformFlags *	waveFlags,
		LALSimInspiralTidalOrder	tideO
	)

Set the LALSimInspiralTidalOrder within a LALSimInspiralWaveformFlags struct.

Parameters

waveFlags	Struct whose flag will be set
tideO	value to set flag to

Definition at line 226 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralGetTidalOrder()

LALSimInspiralTidalOrder XLALSimInspiralGetTidalOrder ( LALSimInspiralWaveformFlags * waveFlags )

Get the LALSimInspiralTidalOrder within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT if waveFlags is NULL.

Definition at line 240 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralTidalOrderIsDefault()

bool XLALSimInspiralTidalOrderIsDefault ( LALSimInspiralTidalOrder tideO )

Returns true if LALSimInspiralTidalOrder has default value returns false otherwise.

Definition at line 254 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralSetFrameAxis()

void XLALSimInspiralSetFrameAxis	(	LALSimInspiralWaveformFlags *	waveFlags,
		LALSimInspiralFrameAxis	axisChoice
	)

Set the LALSimInspiralFrameAxis within a LALSimInspiralWaveformFlags struct.

Parameters

waveFlags	Struct whose flag will be set
axisChoice	value to set flag to

Definition at line 267 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralGetFrameAxis()

LALSimInspiralFrameAxis XLALSimInspiralGetFrameAxis ( LALSimInspiralWaveformFlags * waveFlags )

Get the LALSimInspiralFrameAxis within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT if waveFlags is NULL.

Definition at line 280 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralFrameAxisIsDefault()

bool XLALSimInspiralFrameAxisIsDefault ( LALSimInspiralFrameAxis axisChoice )

Returns true if LALSimInspiralFrameAxis has default value returns false otherwise.

Definition at line 294 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralSetModesChoice()

void XLALSimInspiralSetModesChoice	(	LALSimInspiralWaveformFlags *	waveFlags,
		LALSimInspiralModesChoice	modesChoice
	)

Set the LALSimInspiralModesChoice within a LALSimInspiralWaveformFlags struct.

Parameters

waveFlags	Struct whose flag will be set
modesChoice	value to set flag to

Definition at line 307 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralGetModesChoice()

LALSimInspiralModesChoice XLALSimInspiralGetModesChoice ( LALSimInspiralWaveformFlags * waveFlags )

Get the LALSimInspiralModesChoice within a LALSimInspiralWaveformFlags struct, or LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT if waveFlags is NULL.

Definition at line 320 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModesChoiceIsDefault()

bool XLALSimInspiralModesChoiceIsDefault ( LALSimInspiralModesChoice modesChoice )

Returns true if LALSimInspiralModesChoice has default value returns false otherwise.

Definition at line 334 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralSetNumrelDataOLD()

void XLALSimInspiralSetNumrelDataOLD	(	LALSimInspiralWaveformFlags *	waveFlags,
		const char *	numreldata
	)

Set the numreldata string within a LALSimInspiralWaveformFlags struct.

Parameters

waveFlags	Struct whose value will be set
numreldata	value to set numreldata to

Definition at line 347 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralGetNumrelDataOLD()

char* XLALSimInspiralGetNumrelDataOLD ( LALSimInspiralWaveformFlags * waveFlags )

Returns a deepcopy of the pointer of the numeraldata attribute of the waveFlags structure.

If this is NULL then NULL will be returned. The returned value is independent of the waveFlags structure and will need to be LALFree-d.

Definition at line 362 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralCreateModeArray()

LALValue* XLALSimInspiralCreateModeArray ( void )

Create a LALValue pointer to store the mode array.

Definition at line 386 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayActivateMode()

LALValue* XLALSimInspiralModeArrayActivateMode	(	LALValue *	modes,
		unsigned	l,
		int	m
	)

Definition at line 391 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayDeactivateMode()

LALValue* XLALSimInspiralModeArrayDeactivateMode	(	LALValue *	modes,
		unsigned	l,
		int	m
	)

Definition at line 411 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayActivateAllModes()

LALValue* XLALSimInspiralModeArrayActivateAllModes ( LALValue * modes )

Definition at line 431 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayDeactivateAllModes()

LALValue* XLALSimInspiralModeArrayDeactivateAllModes ( LALValue * modes )

Definition at line 448 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayIsModeActive()

int XLALSimInspiralModeArrayIsModeActive	(	LALValue *	modes,
		unsigned	l,
		int	m
	)

Definition at line 458 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayActivateAllModesAtL()

LALValue* XLALSimInspiralModeArrayActivateAllModesAtL	(	LALValue *	modes,
		unsigned	l
	)

Definition at line 481 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayDeactivateAllModesAtL()

LALValue* XLALSimInspiralModeArrayDeactivateAllModesAtL	(	LALValue *	modes,
		unsigned	l
	)

Definition at line 490 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayPrintModes()

int XLALSimInspiralModeArrayPrintModes ( LALValue * modes )

Definition at line 499 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayReadModes()

INT2Sequence* XLALSimInspiralModeArrayReadModes ( LALValue * modes )

Definition at line 511 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayToModeString()

char* XLALSimInspiralModeArrayToModeString ( LALValue * modes )

Definition at line 528 of file LALSimInspiralWaveformFlags.c.

◆ XLALSimInspiralModeArrayFromModeString()

LALValue* XLALSimInspiralModeArrayFromModeString ( const char * modestr )

Definition at line 544 of file LALSimInspiralWaveformFlags.c.

Variable Documentation

◆ empty_modes

char empty_modes[((LAL_SIM_L_MAX_MODE_ARRAY+1) *(LAL_SIM_L_MAX_MODE_ARRAY+1))/CHAR_BIT+2] = { '\0' }

static

Definition at line 380 of file LALSimInspiralWaveformFlags.c.

Detailed Description

Prototypes

Variables

Function Documentation

◆ XLALSimInspiralCreateWaveformFlags()

◆ XLALSimInspiralDestroyWaveformFlags()

◆ XLALSimInspiralWaveformParamsFlagsAreDefault()

◆ XLALSimInspiralWaveformFlagsIsDefaultOLD()

◆ XLALSimInspiralWaveformFlagsEqualOLD()

◆ XLALSimInspiralWaveformFlagsEqual()

◆ XLALSimInspiralSetSpinOrder()

◆ XLALSimInspiralGetSpinOrder()

◆ XLALSimInspiralSpinOrderIsDefault()

◆ XLALSimInspiralSetTidalOrder()

◆ XLALSimInspiralGetTidalOrder()

◆ XLALSimInspiralTidalOrderIsDefault()

◆ XLALSimInspiralSetFrameAxis()

◆ XLALSimInspiralGetFrameAxis()

◆ XLALSimInspiralFrameAxisIsDefault()

◆ XLALSimInspiralSetModesChoice()

◆ XLALSimInspiralGetModesChoice()

◆ XLALSimInspiralModesChoiceIsDefault()

◆ XLALSimInspiralSetNumrelDataOLD()

◆ XLALSimInspiralGetNumrelDataOLD()

◆ XLALSimInspiralCreateModeArray()

◆ XLALSimInspiralModeArrayActivateMode()

◆ XLALSimInspiralModeArrayDeactivateMode()

◆ XLALSimInspiralModeArrayActivateAllModes()

◆ XLALSimInspiralModeArrayDeactivateAllModes()

◆ XLALSimInspiralModeArrayIsModeActive()

◆ XLALSimInspiralModeArrayActivateAllModesAtL()

◆ XLALSimInspiralModeArrayDeactivateAllModesAtL()

◆ XLALSimInspiralModeArrayPrintModes()

◆ XLALSimInspiralModeArrayReadModes()

◆ XLALSimInspiralModeArrayToModeString()

◆ XLALSimInspiralModeArrayFromModeString()

Variable Documentation

◆ empty_modes