Detailed Description

Computation of instant and averaged velocities for a given detector and the like.

Author: Krishnan, B., Sintes, A.M.

Synopsis

#include <lal/Velocity.h>

To find the velocity of a given detetector at a given time, or the averaged velocity of a detector in a certain time interval.

Prototypes
void	LALAvgDetectorVel (LALStatus status, REAL8 v[3], VelocityPar in)
	This function outputs the average velocity REAL8 v[3] of the detector during a time interval. More...

void	LALAvgDetectorPos (LALStatus status, REAL8 x[3], VelocityPar in)
	Given a detector and a time interval, this function outputs the average position of the detector during the interval by using the trapeziodal rule for a given fractional accuracy. More...

void	LALDetectorVel (LALStatus status, REAL8 v[3], LIGOTimeGPS time0, LALDetector detector, EphemerisData *edat)
	This function finds the velocity of a given detector at a given time. More...

void	LALDetectorPos (LALStatus status, REAL8 x[3], LIGOTimeGPS time0, LALDetector detector, EphemerisData *edat)
	This finds velocity of a given detector at a given time. More...

Data Structures
struct	VelocityPar
	This structure stores the parameters required by XLALBarycenter() to calculate Earth velocity at a given detector location. More...

Files
file	VelocityTest.c
	Tests the calculation of the averaged velocity of a given detector.

Error Codes
#define	VELOCITYH_ENULL 1

#define	VELOCITYH_EVAL 2

#define	VELOCITYH_MSGENULL "Null Pointer"

#define	VELOCITYH_MSGEVAL "Invalid Value"

Function Documentation

◆ LALAvgDetectorVel()

void LALAvgDetectorVel	(	LALStatus *	status,
		REAL8	v[3],
		VelocityPar *	in
	)

This function outputs the average velocity REAL8 v[3] of the detector during a time interval.

The input structure is of type VelocityPar containing all the required parmaters.

Parameters

	status	pointer to LALStatus structure
[out]	v	velocity vector
[in]	in	input parameter structure

Definition at line 34 of file Velocity.c.

◆ LALAvgDetectorPos()

void LALAvgDetectorPos	(	LALStatus *	status,
		REAL8	x[3],
		VelocityPar *	in
	)

Given a detector and a time interval, this function outputs the average position of the detector during the interval by using the trapeziodal rule for a given fractional accuracy.

Definition at line 95 of file Velocity.c.

◆ LALDetectorVel()

void LALDetectorVel	(	LALStatus *	status,
		REAL8	v[3],
		LIGOTimeGPS *	time0,
		LALDetector	detector,
		EphemerisData *	edat
	)

This function finds the velocity of a given detector at a given time.

It is basically a wrapper for XLALBarycenter(). The output is of the form REAL8 vector v[3] and the input is a time LIGOTimeGPS , the detector LALDetector, and the ephemeris EphemerisData from XLALInitBarycenter().

Definition at line 200 of file Velocity.c.

◆ LALDetectorPos()

void LALDetectorPos	(	LALStatus *	status,
		REAL8	x[3],
		LIGOTimeGPS *	time0,
		LALDetector	detector,
		EphemerisData *	edat
	)

This finds velocity of a given detector at a given time.

Definition at line 258 of file Velocity.c.

Macro Definition Documentation

◆ VELOCITYH_ENULL

#define VELOCITYH_ENULL 1

Definition at line 70 of file Velocity.h.

◆ VELOCITYH_EVAL

#define VELOCITYH_EVAL 2

Definition at line 71 of file Velocity.h.

◆ VELOCITYH_MSGENULL

#define VELOCITYH_MSGENULL "Null Pointer"

Definition at line 72 of file Velocity.h.

◆ VELOCITYH_MSGEVAL

#define VELOCITYH_MSGEVAL "Invalid Value"

Definition at line 73 of file Velocity.h.