LAL: FlatPulsarMetric.h File Reference

#include <gsl/gsl_block.h>
#include <gsl/gsl_vector.h>
#include <gsl/gsl_matrix.h>
#include <lal/LALStdlib.h>
#include <lal/LALDatatypes.h>
#include <lal/AVFactories.h>
#include <lal/DetectorSite.h>
#include <lal/DetectorStates.h>
#include <lal/PtoleMetric.h>

Detailed Description

Define Documentation

#define SIN_EPS 0.3977771557

sin(LAL_IEARTH)

Definition at line 55 of file FlatPulsarMetric.h.

#define COS_EPS 0.9174820622

cos(LAL_IEARTH)

Definition at line 56 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_ENULL 1

Definition at line 59 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_ENONULL 2

Definition at line 60 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_EMEM 3

Definition at line 61 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_EINPUT 4

Definition at line 62 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_ELIST 5

Definition at line 63 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_EFUNC 6

Definition at line 64 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_MSGENULL "Arguments contained an unexpected null pointer"

Definition at line 66 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_MSGENONULL "Output pointer is not NULL"

Definition at line 67 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_MSGEMEM "Out of memory"

Definition at line 68 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_MSGEINPUT "Invald input parameter"

Definition at line 69 of file FlatPulsarMetric.h.

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

Definition at line 70 of file FlatPulsarMetric.h.

#define FLATPULSARMETRIC_MSGEFUNC "Sub-routine failed"

Definition at line 71 of file FlatPulsarMetric.h.

Function Documentation

NRCSID	(	FLATPULSARMETRICH	,
		"$Id: FlatPulsarMetric.	h,
		v 1.1 2007/10/26 16:03:01 reinhard Exp $"
	)

int XLALFlatMetricCW	(	gsl_matrix *	gij,
		LIGOTimeGPS	refTime,
		LIGOTimeGPS	startTime,
		REAL8	Tspan,
		const EphemerisData *	edat
	)

Compute a flat approximation for the continuous-wave metric (by neglecting the z-motion of the detector in ecliptic coordinates.

gij has to be an allocated symmetric matrix of dimension dim: the order of coordinates is $[ \omega_0, \tilde{n}_x, \tilde{n}_y, \omega_1, \omega_2, ... ]$ , but dim must be at least 3 and maximally 6 (Freq + 2 sky + 3 spin-downs) The dimensionless coordinates are defined as $\omega_s \equiv 2\pi \, f^{(s)}\, T^{s+1} / (s+1)!$ in terms of the observation time $T$ , and $\tilde{n}_l \equiv 2\pi \bar{f} \hat{n} R_{orb} / c$ , where $R_{orb}$ is the orbital radius (AU).

Parameters:

gij	[out] metric
refTime	[in] reference time for spin-parameters
startTime	[in] startTime
Tspan	[in] total observation time spanned
edat	[in] ephemeris data

Definition at line 227 of file FlatPulsarMetric.c.

void LALFlatPulsarMetric	(	LALStatus *	status,
		REAL8Vector **	metric,
		LIGOTimeGPS	startTime,
		REAL8	duration,
		const LALDetector *	site
	)

[OBSOLETE?] Compute the constant-coefficient approximate pulsar-metric.

The returned metric symmetric matrix $g_{\alpha \beta}$ is encoded in a 1D vector $v_l$ in the same way as in LALPulsarMetric(), namely: $g_{\alpha \beta} = v_l$ , where for $\alpha<=\beta$ the vector-index $l$ is $l = \alpha + \beta \,(\beta + 1)/2$ .

The (dimensionless) parameter-space coordinates (and their order) are: $\{ \kappa^X, \kappa^Y, \varpi_0, \varpi_1, \varpi_2, ...\}$ , defined as

$\kappa^i \equiv R_{ES} {2\pi \over c} f \, n^i\,,$

$\varpi_s \equiv T^{s+1}\, 2\pi f^{(s)}\,$

where $R_{ES} = 1\,\textrm{AU} \sim 1.5\times10^{11}$ m is the orbital radius, $f$ is the frequency, $n^i$ is the unit-vector pointing to a sky-location, $T$ is the observation time and $f^{(s)}$ is the s-th time-derivative of the frequency.

The two cartesian coordinate-directions $X, Y$ are referring to the ecliptic cartesian reference-frame.

Parameters:

metric	[out] constant pulsar-metric
startTime	start time of observation
duration	duration of observation in seconds
site	[in] detector location

Definition at line 338 of file FlatPulsarMetric.c.

FlatPulsarMetric.h File Reference

Defines

Functions

Detailed Description

Define Documentation

Function Documentation


Defines
#define	SIN_EPS 0.3977771557
	sin(LAL_IEARTH)
#define	COS_EPS 0.9174820622
	cos(LAL_IEARTH)
#define	FLATPULSARMETRIC_ENULL 1
#define	FLATPULSARMETRIC_ENONULL 2
#define	FLATPULSARMETRIC_EMEM 3
#define	FLATPULSARMETRIC_EINPUT 4
#define	FLATPULSARMETRIC_ELIST 5
#define	FLATPULSARMETRIC_EFUNC 6
#define	FLATPULSARMETRIC_MSGENULL "Arguments contained an unexpected null pointer"
#define	FLATPULSARMETRIC_MSGENONULL "Output pointer is not NULL"
#define	FLATPULSARMETRIC_MSGEMEM "Out of memory"
#define	FLATPULSARMETRIC_MSGEINPUT "Invald input parameter"
#define	FLATPULSARMETRIC_MSGELIST "Error occurred in list-handling ..."
#define	FLATPULSARMETRIC_MSGEFUNC "Sub-routine failed"
Functions
	NRCSID (FLATPULSARMETRICH,"$Id: FlatPulsarMetric.h,v 1.1 2007/10/26 16:03:01 reinhard Exp $")
int	XLALFlatMetricCW (gsl_matrix gij, LIGOTimeGPS refTime, LIGOTimeGPS startTime, REAL8 Tspan, const EphemerisData edat)
	Compute a flat approximation for the continuous-wave metric (by neglecting the z-motion of the detector in ecliptic coordinates.
void	LALFlatPulsarMetric (LALStatus , REAL8Vector metric, LIGOTimeGPS startTime, REAL8 duration, const LALDetector site)
	[OBSOLETE?] Compute the constant-coefficient approximate pulsar-metric.