summaryclassification
The summaryclassification executable allows the user to generate source based classification probabilities given the samples in a GW specific result file by interacting with the pesummary.gw.pepredicates and pesummary.gw.p_astro modules and PEPredicates and ligo.em-bright packages.
To see help for this executable please run:
$ summaryclassification --help
usage: summaryclassification [-h] [-w DIR] [-s SAMPLES [SAMPLES ...]]
[--labels LABELS [LABELS ...]] [--plot {bar}]
[--pastro_category_file PASTRO_CATEGORY_FILE]
[--terrestrial_probability TERRESTRIAL_PROBABILITY]
[--catch_terrestrial_probability_error]
This executable is used to generate a txt file containing the source
classification probailities
options:
-h, --help show this help message and exit
-w DIR, --webdir DIR make page and plots in DIR
-s SAMPLES [SAMPLES ...], --samples SAMPLES [SAMPLES ...]
Path to posterior samples file(s). See documentation
for allowed formats. If path is on a remote server,
add username and servername in the form
{username}@{servername}:{path}. If path is on a public
webpage, ensure the path starts with https://. You may
also pass a string such as posterior_samples*.dat and
all matching files will be used
--labels LABELS [LABELS ...]
labels used to distinguish runs
--plot {bar} Name of the plot you wish to make
--pastro_category_file PASTRO_CATEGORY_FILE
path to yml file containing summary data for each
category (BBH, BNS, NSBH). This includes e.g. rates,
mass bounds etc. This is used when computing PAstro
--terrestrial_probability TERRESTRIAL_PROBABILITY
Terrestrial probability for the candidate you are
analysing. This is used when computing PAstro
--catch_terrestrial_probability_error
Catch the ValueError raised when no terrestrial
probability is provided when computing PAstro
Generating classification probabilities
Below is an example of the output from summary summaryclassification on a result file,
$ summaryclassification --webdir ./ --samples posterior_samples.hdf5 \
--labels GW150914
$ ls ./
GW150914_default_prior_pe_classification.json
GW150914_population_prior_pe_classification.json
GW150914_population_pepredicates_bar.png