Creating an injection set
This a command line tool for the generation of injection files for consumption by bilby_pipe. Injection files can be generated in a variety of formats, see below, and are generated from a bilby-style prior_file.
Available formats: A dat file consists of a space-separated list of parameters with a header; A json formatted file.
If a geocent_time prior is given in the file, this will be used to create the time prior. Otherwise, the trigger-time & deltaT or gps-time and deltaT options are used (see below).
Command line interface for creating an injection set
This a command line tool for the generation of injection files for consumption by bilby_pipe. Injection files can be generated in a variety of formats, see below, and are generated from a bilby-style prior_file.
Available formats: A dat file consists of a space-separated list of parameters with a header; A json formatted file.
If a geocent_time prior is given in the file, this will be used to create the time prior. Otherwise, the trigger-time & deltaT or gps-time and deltaT options are used (see below).
usage: fancytool [-h] [-f FILENAME] [-e {json,dat}] [-n N_INJECTION]
[-t TRIGGER_TIME] [-g GPS_FILE | --gps-tuple GPS_TUPLE]
[--deltaT DELTAT]
[--post-trigger-duration POST_TRIGGER_DURATION]
[--duration DURATION] [--minimum-frequency MINIMUM_FREQUENCY]
[-s GENERATION_SEED] [--default-prior DEFAULT_PRIOR]
[--enforce-signal-duration ENFORCE_SIGNAL_DURATION]
prior_file
Positional Arguments
- prior_file
The prior file from which to generate injections
Named Arguments
- -f, --filename
Default: “injection”
- -e, --extension
Possible choices: json, dat
Prior file format
Default: “dat”
- -n, --n-injection
The number of injections to generate: not required if –gps-file is also given
- -t, --trigger-time
The trigger time to use for setting a geocent_time prior (default=0). Ignored if a geocent_time prior exists in the prior_file or –gps-file is given.
Default: 0
- -g, --gps-file
File containing segment GPS start times. This can be a multi-column file if (a) it is comma-separated and (b) the zeroth column contains the gps-times to use
- --gps-tuple
Tuple of the (start, step, number) of GPS start times. For example, (10, 1, 3) produces the gps start times [10, 11, 12]. If given, gps-file is ignored.
- --deltaT
The symmetric width (in s) around the trigger time to search over the coalescence time. Ignored if a geocent_time prior exists in the prior_file
Default: 0.2
- --post-trigger-duration
The post trigger duration (default=2s), used only in conjunction with –gps-file
Default: 2
- --duration
The segment duration (default=4s), used only in conjunction with –gps-file
Default: 4
- --minimum-frequency
The minimum frequency, this is needed when enforce-signal-duration is true.
- -s, --generation-seed
Random seed used during data generation
- --default-prior
The name of the prior set to base the prior on. Can be one of[PriorDict, BBHPriorDict, BNSPriorDict, CalibrationPriorDict]
Default: “BBHPriorDict”
- --enforce-signal-duration
Whether to require that all signals fit within the segment duration. The signal duration is calculated using a post-Newtonian approximation.
Default: False