Skip to content
Snippets Groups Projects
Commit 7450cda2 authored by Chad Hanna's avatar Chad Hanna
Browse files

gstlal_compute_far_from_snr_chisq_histograms: NEW DOC

parent 85ecfc92
No related branches found
No related tags found
No related merge requests found
......@@ -16,16 +16,7 @@
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
## @file
# Compute FAR and FAP distributions from the likelihood CCDFs.
#
# ### Command line interface
#
# + `--background-bins-file` [filename]: Set the name of the xml file containing the marginalized likelihood (required).
# + `--tmp-space` [dir]: Set the name of the tmp space if working with sqlite.
# + `--non-injection-db` [filename]: Provide the name of a database from a non-injection run. Can be given multiple times (default = []).
# + `--injection-db` [filename]: Provide the name of a database from an injection run. Can be given multiple times. Databases are assumed to be over the same time period as the non injection databases using the same templates. If not the results will be nonsense (default = []).
# + `--verbose`: Be verbose.
### Compute FAR and FAP distributions from the likelihood CCDFs.
#
# =============================================================================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment