LALBarycenter.h File Reference

Author:: Curt Cutler This header defines the API for LALBarycenter.c.

#include <stdio.h>
#include <math.h>
#include <lal/LALStdio.h>
#include <lal/LALStdlib.h>
#include <lal/LALConstants.h>
#include <lal/DetectorSite.h>

Include dependency graph for LALBarycenter.h:

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

Go to the source code of this file.

Data Structures

struct EphemerisFilenames

This structure contains two pointers to data files containing arrays of center-of-mass positions for the Earth and Sun, respectively. More...

struct PosVelAcc

Structure holding a REAL8 time, and a position, velocity and acceleration vector. More...

struct EphemerisData

This structure contains all information about the center-of-mass positions of the Earth and Sun, listed at regular time intervals. More...

struct EarthState

Basic output structure of LALBarycenterEarth.c. More...

struct BarycenterInput

Basic input structure to LALBarycenter.c. More...

struct EmissionTime

Basic output structure produced by LALBarycenter.c. More...

Defines

#define LALBARYCENTERH_ENULL   2

#define LALBARYCENTERH_EOUTOFRANGEE   4

#define LALBARYCENTERH_EOUTOFRANGES   8

#define LALBARYCENTERH_EBADSOURCEPOS   16

#define LALBARYCENTERH_MSGENULL   "Null input to Barycenter routine."

#define LALBARYCENTERH_MSGEOUTOFRANGEE   "tgps not in range of earth.dat file"

#define LALBARYCENTERH_MSGEOUTOFRANGES   "tgps not in range of sun.dat file"

#define LALBARYCENTERH_MSGEBADSOURCEPOS   "source position not in standard range"

Functions

NRCSID (LALBARYCENTERH,"$Id: LALBarycenter.h,v 1.12 2007/06/08 14:41:50 bema Exp $")

void LALBarycenterEarth (LALStatus *, EarthState *, const LIGOTimeGPS *, const EphemerisData *)

Computes the position and orientation of the Earth, at some arrival time $t_a$ , specified LIGOTimeGPS input structure.

void LALBarycenter (LALStatus *, EmissionTime *, const BarycenterInput *, const EarthState *)

Transforms from detector arrival time $t_a$ in GPS (as specified in the LIGOTimeGPS structure) to pulse emission time $t_e$ , in TDB.

Detailed Description

Author:: Curt Cutler This header defines the API for LALBarycenter.c.

Date:: 2001

Id: LALBarycenter.h,v 1.12 2007/06/08 14:41:50 bema Exp

Definition in file LALBarycenter.h.

Define Documentation

#define LALBARYCENTERH_ENULL 2

Definition at line 74 of file LALBarycenter.h.

#define LALBARYCENTERH_EOUTOFRANGEE 4

Definition at line 75 of file LALBarycenter.h.

#define LALBARYCENTERH_EOUTOFRANGES 8

Definition at line 76 of file LALBarycenter.h.

#define LALBARYCENTERH_EBADSOURCEPOS 16

Definition at line 77 of file LALBarycenter.h.

#define LALBARYCENTERH_MSGENULL "Null input to Barycenter routine."

Definition at line 79 of file LALBarycenter.h.

#define LALBARYCENTERH_MSGEOUTOFRANGEE "tgps not in range of earth.dat file"

Definition at line 80 of file LALBarycenter.h.

#define LALBARYCENTERH_MSGEOUTOFRANGES "tgps not in range of sun.dat file"

Definition at line 81 of file LALBarycenter.h.

#define LALBARYCENTERH_MSGEBADSOURCEPOS "source position not in standard range"

Definition at line 82 of file LALBarycenter.h.

Function Documentation

NRCSID	(	LALBARYCENTERH	,
		"$Id: LALBarycenter.	h,
		v 1.12 2007/06/08 14:41:50 bema Exp $"
	)

void LALBarycenterEarth	(	LALStatus *	stat,
		EarthState *	earth,
		const LIGOTimeGPS *	tGPS,
		const EphemerisData *	edat
	)

Computes the position and orientation of the Earth, at some arrival time $t_a$ , specified LIGOTimeGPS input structure.

The Einstein delay is also calculated. The results are stored in the EarthState output structure, which can then be fed as input to LALBarycenter(). The idea is that LALBarycenterEarth() calculates quantities that are independent of the source location and detector position on Earth. Thus this function is called ONCE for every desired arrival time; the results are then re-used as one steps around the sky (and/or changes detector) at that time.

Parameters:

earth	[out] the earth's state at time tGPS
tGPS	[in] GPS time tgps
edat	[in] ephemeris-files

Definition at line 108 of file LALBarycenter.c.

void LALBarycenter	(	LALStatus *	stat,
		EmissionTime *	emit,
		const BarycenterInput *	baryinput,
		const EarthState *	earth
	)

Transforms from detector arrival time $t_a$ in GPS (as specified in the LIGOTimeGPS structure) to pulse emission time $t_e$ , in TDB.

Actually, the returned $t_e$ is the emission time plus the constant light-travel-time from source to SSB.) The inputs to LALBarycenter(), through the BarycenterInput structure, are the source location, detector site identifier, and GPS arrival time. The function returns the emission time $t_e(t_a)$ , the derivative $d t_e/d t_a$ , and the difference $t_e(t_a) - t_a $ through the EmissionTime structure. The emission time is returned in the LIGOTimeGPS format, while the other two quantities are REAL8's.

Parameters:

emit	[out] emission-time information
baryinput	[in] info about detector and source-location
earth	[in] earth-state (from LALBarycenterEarth())

Definition at line 514 of file LALBarycenter.c.

Generated on Sat Sep 6 03:08:10 2008 for LAL by

1.5.2


Data Structures
struct	EphemerisFilenames
	This structure contains two pointers to data files containing arrays of center-of-mass positions for the Earth and Sun, respectively. More...
struct	PosVelAcc
	Structure holding a REAL8 time, and a position, velocity and acceleration vector. More...
struct	EphemerisData
	This structure contains all information about the center-of-mass positions of the Earth and Sun, listed at regular time intervals. More...
struct	EarthState
	Basic output structure of LALBarycenterEarth.c. More...
struct	BarycenterInput
	Basic input structure to LALBarycenter.c. More...
struct	EmissionTime
	Basic output structure produced by LALBarycenter.c. More...
Defines
#define	LALBARYCENTERH_ENULL 2
#define	LALBARYCENTERH_EOUTOFRANGEE 4
#define	LALBARYCENTERH_EOUTOFRANGES 8
#define	LALBARYCENTERH_EBADSOURCEPOS 16
#define	LALBARYCENTERH_MSGENULL "Null input to Barycenter routine."
#define	LALBARYCENTERH_MSGEOUTOFRANGEE "tgps not in range of earth.dat file"
#define	LALBARYCENTERH_MSGEOUTOFRANGES "tgps not in range of sun.dat file"
#define	LALBARYCENTERH_MSGEBADSOURCEPOS "source position not in standard range"
Functions
	NRCSID (LALBARYCENTERH,"$Id: LALBarycenter.h,v 1.12 2007/06/08 14:41:50 bema Exp $")
void	LALBarycenterEarth (LALStatus , EarthState , const LIGOTimeGPS , const EphemerisData )
	Computes the position and orientation of the Earth, at some arrival time , specified `LIGOTimeGPS` input structure.
void	LALBarycenter (LALStatus , EmissionTime , const BarycenterInput , const EarthState )
	Transforms from detector arrival time in GPS (as specified in the LIGOTimeGPS structure) to pulse emission time , in TDB.