Tests the various LAL metric functions, by outputting the metric at a point in parameter space, and also producing an array of ellipses of constant mismatch. More...

Detailed Description

Tests the various LAL metric functions, by outputting the metric at a point in parameter space, and also producing an array of ellipses of constant mismatch.

Author: Jones, D. I., Owen, B. J.

Program <tt>GeneralMetricTest.c</tt>

Usage

GeneralMetricTest

Description

This program computes metric components using a metric function of the user's specification. The ordering of the components is \( (f_0, \alpha, \delta, f_1\ldots) \) for the unprojected metric, and \( (\alpha, \delta, f_1\ldots) \) for the metric with \( f_0 \) projected out.

With no options, this program displays metric components for a single point in parameter space for the default parameter values.

The -c option determines the point on the sky where the metric is evaluated. This option is hard-coded to use equatorial coordinates and the argument should be given in hh:mm:ss:dd:mm:ss format. (Default is the center of the globular cluster 47 Tuc).

The -f option sets the maximum frequency (in Hz) to search. (The default is 1000.)

The -l option determines the limits in right ascension and declination of the rectangular region over which the mismatch contours are computed. The argument should be given in degrees as RA(min):RA(max):dec(min):dec(max). (The default is the octant of the sky defined by \( 0 < \textrm{RA} < 90 \) and \( 0< \textrm{dec} < 85 \) ; this avoids the coordinate singularity at the poles.)

The -m option sets the mismatch (default is \( 0.02 \) ).

The -n option sets the number of spindown parameters (default 0).

The -p option is provided for users who wish to view the power mismatch contours provided by the -x option (see below) but don't have xmgrace installed. All necessary data is simply written to a file `‘nongrace.data’'; it's probably best to look at the code to see the exact format. The user should then write a small script to convert the data into the format appropriate to their favorite graphics package.

The -t option sets the duration of integration in seconds. (The default is \( 39600 \) seconds \( = 11 \) hours, which is chosen because it is of the right size for S2 analyses).

The -x option produces a graph of the 2% power mismatch contours on the sky. Dimensions of the ellipses have been exaggerated by a factor of MAGNIFY (specified within the code) for legibility. The purpose of the graph is to get a feel for how ellipses are varying across parameter space. Note that this option makes a system call to the xmgrace program, and will not work if that program is not installed on your system.

Algorithm

Uses

lalDebugLevel
LALCheckMemoryLeaks()
LALCreateVector()
LALDestroyVector()
LALDCreateVector()
LALDDestroyVector()
LALProjectMetric()
LALPtoleMetric()
xmgrace

Notes

The code does not yet really work with more than one spindown parameter.

Definition in file GeneralMetricTest.c.

Go to the source code of this file.

Macros
Error Codes
#define	GENERALMETRICTESTC_EMEM 1

#define	GENERALMETRICTESTC_ESUB 2

#define	GENERALMETRICTESTC_ESYS 3

#define	GENERALMETRICTESTC_EMET 4

#define	GENERALMETRICTESTC_MSGEMEM "memory (de)allocation error"

#define	GENERALMETRICTESTC_MSGESUB "subroutine failed"

#define	GENERALMETRICTESTC_MSGESYS "system call failed"

#define	GENERALMETRICTESTC_MSGEMET "determinant of projected metric negative"

Macro Definition Documentation

◆ GENERALMETRICTESTC_EMEM

#define GENERALMETRICTESTC_EMEM 1

Definition at line 112 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_ESUB

#define GENERALMETRICTESTC_ESUB 2

Definition at line 113 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_ESYS

#define GENERALMETRICTESTC_ESYS 3

Definition at line 114 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_EMET

#define GENERALMETRICTESTC_EMET 4

Definition at line 115 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_MSGEMEM

#define GENERALMETRICTESTC_MSGEMEM "memory (de)allocation error"

Definition at line 117 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_MSGESUB

#define GENERALMETRICTESTC_MSGESUB "subroutine failed"

Definition at line 118 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_MSGESYS

#define GENERALMETRICTESTC_MSGESYS "system call failed"

Definition at line 119 of file GeneralMetricTest.c.

◆ GENERALMETRICTESTC_MSGEMET

#define GENERALMETRICTESTC_MSGEMET "determinant of projected metric negative"

Definition at line 120 of file GeneralMetricTest.c.