PtoleMetric.h File Reference

Prototypes
void	LALPtoleMetric (LALStatus *status, REAL8Vector *metric, PtoleMetricIn *input)
	Computes metric components for a pulsar search in the `‘Ptolemaic’' approximation; both the Earth's spin and orbit are included. More...
void	LALPulsarMetric (LALStatus *status, REAL8Vector **metric, PtoleMetricIn *input)
	Unified "wrapper" to provide a uniform interface to LALPtoleMetric() and LALCoherentMetric(). More...
void	LALProjectMetric (LALStatus *, REAL8Vector *metric, BOOLEAN errors)
	Project out the zeroth dimension of a metric. More...
int	XLALFindMetricDim (const REAL8Vector *metric)
	Figure out dimension of a REAL8Vector -encoded metric (see PMETRIC_INDEX() ). More...
int	XLALSpindownMetric (gsl_matrix *metric, double Tspan)
	Frequency and frequency derivative components of the metric, suitable for a directed search with only one fixed sky position. More...

Go to the source code of this file.

Data Structures
struct	PtoleMetricIn
	This structure will likely be changed to match up better with those under StackMetric.h; it contains the bare necessities, not needing function pointers etc. More...

Macros
#define	PMETRIC_MIN(x, y)   ((x) < (y) ? (x) : (y))
#define	PMETRIC_MAX(x, y)   ((x) > (y) ? (x) : (y))
#define	PMETRIC_INDEX(a, b)   (PMETRIC_MIN((a),(b))+PMETRIC_MAX((a),(b))*(PMETRIC_MAX((a),(b)) + 1 ) / 2 )
	Translate metrix matrix-indices (a,b) into vector-index l. More...
Error conditions
#define	PTOLEMETRICH_ENULL   1
#define	PTOLEMETRICH_EPARM   2
#define	PTOLEMETRICH_EDIM   3
#define	PTOLEMETRICH_ENONULL   4
#define	PTOLEMETRICH_EMETRIC   5
#define	PTOLEMETRICH_MSGENULL   "unexpected null pointer"
#define	PTOLEMETRICH_MSGEPARM   "bad parameter value"
#define	PTOLEMETRICH_MSGEDIM   "bad array length"
#define	PTOLEMETRICH_MSGENONULL   "unexpected non-null pointer"
#define	PTOLEMETRICH_MSGEMETRIC   "unknown metric type"

Enumerations
enum	LALPulsarMetricType { LAL_PMETRIC_NONE = 0 , LAL_PMETRIC_COH_PTOLE_ANALYTIC , LAL_PMETRIC_LAST }
	Constants defining different types of pulsar-metrics. More...