Gather Summary Statistics (ligoskymapstats
)¶
Calculate summary statistics for a batch of sky maps.
Under the hood, this script is little more than a commandline interface for
the ligo.skymap.postprocess.crossmatch
module.
The filenames of the sky maps may be provided as positional command line
arguments, and may also be provided as globs (such as *.fits.gz
). If
supplied with the optional database
argument, then also match sky maps
with injections from an inspinjfindstyle sqlite database.
All angular separations are in degrees, all areas are in square degrees, and all volumes are in cubic megaparsecs. The output is written as tabseparated values with the following columns:
From the search pipeline database 


event identifier 

injection identifier 

false alarm rate 

signal to noise ratio 
Injection finding 


area of 2D credible region containing the true sky location 

probability in that 2D credible region 

marginal distance CDF at the true distance 

volume of 3D credible region containing the true position 

probability contained in that volume 

angular separation between the maximum a posteriori position and the true sky position 
Additional metadata from the sky maps 


wall clock run time to generate sky map 

mean a posteriori distance 

a posteriori standard deviation of distance 

natural log Bayes factor, coherent vs. incoherent 

natural log Bayes factor, signal vs. noise 
Credible levels (if 


area of the P percent 2D credible region 

probability contained within the 2D credible level of area A 

distance for a cumulative marginal probability of P percent 

volume of the P percent 3D credible region 
Modes (if 


number of simply connected figures in the 2D credible region containing the true sky location 

number of simply connected figures in the P percent 2D credible region 
usage: ligoskymapstats [h] [version]
[l CRITICALERRORWARNINGINFODEBUGNOTSET]
[o OUT.dat] [j [JOBS]] [p PERCENT [PERCENT ...]]
[a DEG2 [DEG2 ...]] [modes] [d DB.sqlite]
[cosmology]
GLOB.fits[.gz] [GLOB.fits[.gz] ...]
Positional Arguments¶
 GLOB.fits[.gz]
Input FITS filenames and/or globs
Named Arguments¶
 version
show program’s version number and exit
 l, loglevel
Default: INFO
 o, output
Name of output file
Default: 
 j, jobs
Number of threads
Default: 1
 p, contour
Report the area of the smallest contour and the number of modes containing this much probability.
Default: []
 a, area
Report the largest probability contained within any region of this area in square degrees. Can be repeated multiple times.
Default: []
 modes
Compute number of disjoint modes
Default: False
 d, database
Input SQLite database from search pipeline
 cosmology
Report volume localizations as comoving volumes.
Default: False