ExtrapolatePulsarSpins.h File Reference

Author:: Reinhard Prix Contains prototype for XLALExtrapolatePulsarSpins().

#include <lal/PulsarDataTypes.h>
#include <lal/AVFactories.h>

Include dependency graph for ExtrapolatePulsarSpins.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define EXTRAPOLATEPULSARSPINS_ENULL   1

#define EXTRAPOLATEPULSARSPINS_ENONULL   2

#define EXTRAPOLATEPULSARSPINS_EMEM   3

#define EXTRAPOLATEPULSARSPINS_EINPUT   4

#define EXTRAPOLATEPULSARSPINS_ELIST   5

#define EXTRAPOLATEPULSARSPINS_EXLAL   6

#define EXTRAPOLATEPULSARSPINS_ENUMSPINS   7

#define EXTRAPOLATEPULSARSPINS_MSGENULL   "Arguments contained an unexpected null pointer"

#define EXTRAPOLATEPULSARSPINS_MSGENONULL   "Output pointer is not NULL"

#define EXTRAPOLATEPULSARSPINS_MSGEMEM   "Out of memory"

#define EXTRAPOLATEPULSARSPINS_MSGEINPUT   "Invald input parameter"

#define EXTRAPOLATEPULSARSPINS_MSGELIST   "Error occurred in list-handling ..."

#define EXTRAPOLATEPULSARSPINS_MSGEXLAL   "(X)LAL sub-routine failed"

#define EXTRAPOLATEPULSARSPINS_MSGENUMSPINS   "Inconsistent number of spins"

Functions

NRCSID (EXTRAPOLATEPULSARSPINSH,"$Id: ExtrapolatePulsarSpins.h,v 1.11 2008/04/08 09:42:33 reinhard Exp $")

void LALExtrapolatePulsarSpinRange (LALStatus *, PulsarSpinRange *range1, LIGOTimeGPS epoch1, const PulsarSpinRange *range0)

General pulsar-spin extraploation function: given a "spin-range" (ie spins + spin-bands) at time $\tau_0$ , propagate the whole spin-range to time $\tau_1$ .

void LALExtrapolatePulsarSpins (LALStatus *, PulsarSpins fkdot1, LIGOTimeGPS epoch1, const PulsarSpins fkdot0, LIGOTimeGPS epoch0)

Extrapolate the Pulsar spin-paramters $\{f, \stackrel{.}{f},\ddot{f},...\}$ (fkdotOld) from the initial reference-epoch $\tau_0$ (epoch0) to the new reference-epoch $\tau_1$ (epoch1).

void LALExtrapolatePulsarPhase (LALStatus *, REAL8 *phi1, PulsarSpins fkdot1, LIGOTimeGPS epoch1, REAL8 phi0, LIGOTimeGPS epoch0)

Extrapolate phase phi0 from epoch0 to epoch1, given the spins fkdot1 at epoch1 Returns phi1 in the range [0, 2pi].

int XLALExtrapolatePulsarSpins (PulsarSpins fkdotOut, const PulsarSpins fkdotIn, REAL8 DeltaTau)

Lightweight API to extrapolate PulsarSpins by a time-difference 'DeltaTau'.

Detailed Description

Author:: Reinhard Prix Contains prototype for XLALExtrapolatePulsarSpins().

Date:

Date: 2008/04/08 09:42:33

Definition in file ExtrapolatePulsarSpins.h.

Define Documentation

#define EXTRAPOLATEPULSARSPINS_ENULL 1

Definition at line 85 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_ENONULL 2

Definition at line 86 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_EMEM 3

Definition at line 87 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_EINPUT 4

Definition at line 88 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_ELIST 5

Definition at line 89 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_EXLAL 6

Definition at line 90 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_ENUMSPINS 7

Definition at line 91 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGENULL "Arguments contained an unexpected null pointer"

Definition at line 93 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGENONULL "Output pointer is not NULL"

Definition at line 94 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGEMEM "Out of memory"

Definition at line 95 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGEINPUT "Invald input parameter"

Definition at line 96 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGELIST "Error occurred in list-handling ..."

Definition at line 97 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGEXLAL "(X)LAL sub-routine failed"

Definition at line 98 of file ExtrapolatePulsarSpins.h.

#define EXTRAPOLATEPULSARSPINS_MSGENUMSPINS "Inconsistent number of spins"

Definition at line 99 of file ExtrapolatePulsarSpins.h.

Function Documentation

NRCSID	(	EXTRAPOLATEPULSARSPINSH	,
		"$Id: ExtrapolatePulsarSpins.	h,
		v 1.11 2008/04/08 09:42:33 reinhard Exp $"
	)

void LALExtrapolatePulsarSpinRange	(	LALStatus *	status,
		PulsarSpinRange *	range1,
		LIGOTimeGPS	epoch1,
		const PulsarSpinRange *	range0
	)

General pulsar-spin extraploation function: given a "spin-range" (ie spins + spin-bands) at time $\tau_0$ , propagate the whole spin-range to time $\tau_1$ .

NOTE: *range1 is allowed to point to the same spin-range as *range0: the input will be overwritten with the output.

NOTE2: The output-range is in the 'canonical' order of $[ f^{(k)}, f^{(k)} + \Delta f^{(k)}]$ , where $\Delta f^{(k)} \ge 0$ .

NOTE3: This function works correctly for both epoch1 > epoch0 and epoch1 <= epoch0 !

Definition at line 65 of file ExtrapolatePulsarSpins.c.

void LALExtrapolatePulsarSpins	(	LALStatus *	status,
		PulsarSpins	fkdot1,
		LIGOTimeGPS	epoch1,
		const PulsarSpins	fkdot0,
		LIGOTimeGPS	epoch0
	)

Extrapolate the Pulsar spin-paramters $\{f, \stackrel{.}{f},\ddot{f},...\}$ (fkdotOld) from the initial reference-epoch $\tau_0$ (epoch0) to the new reference-epoch $\tau_1$ (epoch1).

This is equivalent to LALExtrapolatePulsarSpins(), but uses the fixed-size array-type 'PulsarSpins' = REAL8[PULSAR_MAX_SPINS] instead, which is easier to handle and avoids any dynamic-memory hassles.

NOTE: this can be called with fkdot1 == fkdot0, in which case the input will be correctly replaced by the output.

Parameters:

fkdot1	[out] spin-parameters at epoch1
epoch1	[in] GPS SSB-time of new epoch1
fkdot0	[in] spin-params at reference epoch0
epoch0	[in] GPS SSB-time of reference-epoch0

Definition at line 137 of file ExtrapolatePulsarSpins.c.

void LALExtrapolatePulsarPhase	(	LALStatus *	,
		REAL8 *	phi1,
		PulsarSpins	fkdot1,
		LIGOTimeGPS	epoch1,
		REAL8	phi0,
		LIGOTimeGPS	epoch0
	)

Extrapolate phase phi0 from epoch0 to epoch1, given the spins fkdot1 at epoch1 Returns phi1 in the range [0, 2pi].

Parameters:

phi1	[out] phase at epoch1
fkdot1	[in] spin-params at reference epoch1
epoch1	[in] GPS SSB-time of epoch1
phi0	[in] initial phase at epoch 0
epoch0	[in] GPS SSB-time of reference-epoch

Definition at line 203 of file ExtrapolatePulsarSpins.c.

int XLALExtrapolatePulsarSpins	(	PulsarSpins	fkdotOut,
		const PulsarSpins	fkdotIn,
		REAL8	DeltaTau
	)

Lightweight API to extrapolate PulsarSpins by a time-difference 'DeltaTau'.

NOTE: This allows fkdotIn to point to the same memory as fkdotOut !

Parameters:

fkdotOut	output fkdot array
fkdotIn	inptut fkdot array
DeltaTau	time-difference to extrapolate fkdot to

Definition at line 165 of file ExtrapolatePulsarSpins.c.

Generated on Sun Sep 7 03:07:40 2008 for LAL by

1.5.2


Defines
#define	EXTRAPOLATEPULSARSPINS_ENULL 1
#define	EXTRAPOLATEPULSARSPINS_ENONULL 2
#define	EXTRAPOLATEPULSARSPINS_EMEM 3
#define	EXTRAPOLATEPULSARSPINS_EINPUT 4
#define	EXTRAPOLATEPULSARSPINS_ELIST 5
#define	EXTRAPOLATEPULSARSPINS_EXLAL 6
#define	EXTRAPOLATEPULSARSPINS_ENUMSPINS 7
#define	EXTRAPOLATEPULSARSPINS_MSGENULL "Arguments contained an unexpected null pointer"
#define	EXTRAPOLATEPULSARSPINS_MSGENONULL "Output pointer is not NULL"
#define	EXTRAPOLATEPULSARSPINS_MSGEMEM "Out of memory"
#define	EXTRAPOLATEPULSARSPINS_MSGEINPUT "Invald input parameter"
#define	EXTRAPOLATEPULSARSPINS_MSGELIST "Error occurred in list-handling ..."
#define	EXTRAPOLATEPULSARSPINS_MSGEXLAL "(X)LAL sub-routine failed"
#define	EXTRAPOLATEPULSARSPINS_MSGENUMSPINS "Inconsistent number of spins"
Functions
	NRCSID (EXTRAPOLATEPULSARSPINSH,"$Id: ExtrapolatePulsarSpins.h,v 1.11 2008/04/08 09:42:33 reinhard Exp $")
void	LALExtrapolatePulsarSpinRange (LALStatus , PulsarSpinRange range1, LIGOTimeGPS epoch1, const PulsarSpinRange *range0)
	General pulsar-spin extraploation function: given a "spin-range" (ie spins + spin-bands) at time $\tau_0$ , propagate the whole spin-range to time $\tau_1$ .
void	LALExtrapolatePulsarSpins (LALStatus *, PulsarSpins fkdot1, LIGOTimeGPS epoch1, const PulsarSpins fkdot0, LIGOTimeGPS epoch0)
	Extrapolate the Pulsar spin-paramters $\{f, \stackrel{.}{f},\ddot{f},...\}$ (fkdotOld) from the initial reference-epoch $\tau_0$ (epoch0) to the new reference-epoch $\tau_1$ (epoch1).
void	LALExtrapolatePulsarPhase (LALStatus , REAL8 phi1, PulsarSpins fkdot1, LIGOTimeGPS epoch1, REAL8 phi0, LIGOTimeGPS epoch0)
	Extrapolate phase phi0 from epoch0 to epoch1, given the spins fkdot1 at epoch1 Returns phi1 in the range [0, 2pi].
int	XLALExtrapolatePulsarSpins (PulsarSpins fkdotOut, const PulsarSpins fkdotIn, REAL8 DeltaTau)
	Lightweight API to extrapolate PulsarSpins by a time-difference 'DeltaTau'.