lal » packages » pulsar » src

ExtrapolatePulsarSpins.c File Reference

Author:
Reinhard Prix Defines functions to extrapolate the pulsar spin-paramters $\{f, \stackrel{.}{f},\ddot{f},...\}$ from one SSB epoch to another.
More...

#include <math.h>
#include <lal/LALError.h>
#include <lal/Date.h>
#include "ExtrapolatePulsarSpins.h"

Include dependency graph for ExtrapolatePulsarSpins.c:

Go to the source code of this file.

Defines

#define MYMAX(x, y)   ( (x) > (y) ? (x) : (y) )
#define MYMIN(x, y)   ( (x) < (y) ? (x) : (y) )
#define GPS2REAL8(gps)   (1.0 * (gps).gpsSeconds + 1.e-9 * (gps).gpsNanoSeconds )
#define TRUE   (1==1)
#define FALSE   (1==0)

Functions

 NRCSID (EXTRAPOLATEPULSARSPINSC,"$Id: ExtrapolatePulsarSpins.c,v 1.14 2008/04/30 18:53:06 kipp 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$.
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).
int XLALExtrapolatePulsarSpins (PulsarSpins fkdotOut, const PulsarSpins fkdotIn, REAL8 DeltaTau)
 Lightweight API to extrapolate PulsarSpins by a time-difference 'DeltaTau'.
void LALExtrapolatePulsarPhase (LALStatus *status, 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].

Detailed Description

Author:
Reinhard Prix Defines functions to extrapolate the pulsar spin-paramters $\{f, \stackrel{.}{f},\ddot{f},...\}$ from one SSB epoch to another.

Date:
Date
2008/04/30 18:53:06

Definition in file ExtrapolatePulsarSpins.c.

Define Documentation

#define MYMAX ( x,
y   )     ( (x) > (y) ? (x) : (y) )

Definition at line 41 of file ExtrapolatePulsarSpins.c.

#define MYMIN ( x,
y   )     ( (x) < (y) ? (x) : (y) )

Definition at line 42 of file ExtrapolatePulsarSpins.c.

#define GPS2REAL8 ( gps   )     (1.0 * (gps).gpsSeconds + 1.e-9 * (gps).gpsNanoSeconds )

Definition at line 44 of file ExtrapolatePulsarSpins.c.

#define TRUE   (1==1)

Definition at line 46 of file ExtrapolatePulsarSpins.c.

#define FALSE   (1==0)

Definition at line 47 of file ExtrapolatePulsarSpins.c.

Function Documentation

NRCSID ( EXTRAPOLATEPULSARSPINSC  ,
"$Id: ExtrapolatePulsarSpins.  c,
v 1.14 2008/04/30 18:53:06 kipp 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.

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.

void LALExtrapolatePulsarPhase ( LALStatus *  status,
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.

Generated on Sat Sep 6 03:07:58 2008 for LAL by  doxygen 1.5.2