Tests InpsiralSpinBank(). More...

Detailed Description

Tests InpsiralSpinBank().

Author: Hanna, C.R. and Owen, B. J.

Usage

InspiralSpinBankTest

This program uses InspiralSpinBank() to generate a template bank from command line parameter input. It also has the option to make a MATHEMATICA notebook using LALMath3DPlot() which will plot the 3D template bank. If the -b option is specified, the program will read the template bank from an XML file instead of generating it. (This only works if LAL is compiled with metaio.)

Command line options

-b: Specifies the XML file to read template bank from. (Only with metaio.)
-n: Specifies the minimum smaller mass between 0 and 5.0 \(M\odot\).
-x: Specifies the maximum smaller mass between 0 and 5.0 \(M\odot\).
-m: Specifies the minimum mismatch threshold (typically 0.03) but for the sake of testing it is best to pick a value \(O[1]\) to save compiling time.
-p: Specifies that the program should generate a MATHEMATICA notebook "Math3DNotebook.nb".

Notes

The metric used in InspiralSpinBank() is only valid for binary systems with a total mass \(<15M\odot\) where the minimum larger mass is at least twice the maximum smaller mass. Choosing mass values that violate these conditions will cause an error message.
Only up to 20,000 templates will be read from an XML file. Making an animated image will start bogging most systems down with more than a few thousand templates, so you can switch the option off by editing the notebook within Mathematica.

Definition in file InspiralSpinBankTest.c.

Go to the source code of this file.

Macros
Error Codes
#define	INSPIRALSPINBANKTESTC_ENORM 0
	Normal exit. More...

#define	INSPIRALSPINBANKTESTC_EMEM 1
	Memory allocation error. More...

#define	INSPIRALSPINBANKTESTC_ESUB 2
	Subroutine error. More...

#define	INSPIRALSPINBANKTESTC_EFILE 4
	File I/O error. More...

Macro Definition Documentation

◆ INSPIRALSPINBANKTESTC_ENORM

#define INSPIRALSPINBANKTESTC_ENORM 0

Normal exit.

Definition at line 100 of file InspiralSpinBankTest.c.

◆ INSPIRALSPINBANKTESTC_EMEM

#define INSPIRALSPINBANKTESTC_EMEM 1

Memory allocation error.

Definition at line 101 of file InspiralSpinBankTest.c.

◆ INSPIRALSPINBANKTESTC_ESUB

#define INSPIRALSPINBANKTESTC_ESUB 2

Subroutine error.

Definition at line 102 of file InspiralSpinBankTest.c.

◆ INSPIRALSPINBANKTESTC_EFILE

#define INSPIRALSPINBANKTESTC_EFILE 4

File I/O error.

Definition at line 103 of file InspiralSpinBankTest.c.