Resolve "Add injection matched filter and optimal snrs to output h5 file"

Closes #217 (closed)

added 1 commit

• 80ed1ac5 - Adds SNR calculations to the meta_data

Compare with previous version

As an example of the stored output

$ ddls outdir/basic_tutorial_result.h5 --ipython
Python 3.6.4 |Anaconda, Inc.| (default, Jan 16 2018, 18:10:19) 
Type 'copyright', 'credits' or 'license' for more information
IPython 6.3.1 -- An enhanced Interactive Python. Type '?' for help.


Loaded outdir/basic_tutorial_result.h5 into 'data':

In [1]: data['meta_data']
Out[1]: 
{'likelihood': {'H1': {'matched_filter_SNR': 12.46066672725827,
   'optimal_SNR': 12.016195356711142},
  'L1': {'matched_filter_SNR': 9.945734531889679,
   'optimal_SNR': 9.726393906160698}}}

This closes #217 (closed) by the way.

unmarked as a Work In Progress

I think this is a really great idea.

Just a couple of thoughts, some of these may well be outside the scope of this MR. If so feel free to say so and we can make issues:

• I think it's worth keeping the complex matched filter SNR, the phase can be useful.
• Can we also store the injection parameters in the interferometer meta data?
• I know this is going to lead to very nested meta_data, but is it worth specifying in the likelihood metadata that this is specific to the detectors, or do you think the names are sufficient specifiers?
• It would also be nice to have the likelihood of the injected parameters stored, although there's some subtlety with the marginalisations that might complicate things.

Also, I had no idea ddls had an --ipython option.

added 1 commit

• d4e28669 - Store the complex optimal SNR and add parameters to the meta_data

Compare with previous version

@colm.talbot , I've updated to resolve the first two issues. It is a little messy and will require people to look into the code to understand what is going on, but perhaps until we know better how we'll use this it isn't clear how to pass this data around anyway.

I'll leave the last two for future issues (feel free to actually make issues there).

Yeah, I think it's fair to keep the last two for later.

It should have been the matched filter SNR that is complex, not the optimal. The optimal SNR should be real by definition.

added 1 commit

• 788d8e8f - Store the complex optimal SNR and add parameters to the meta_data

Compare with previous version

Eugh, sorry, I did a last minute change and didn't check it

FYI: this closes #221 (closed).

approved this merge request

added 60 commits

• 788d8e8f...ba428499 - 59 commits from branch master
• 2bcce6f5 - Merge branch 'master' into '217-add-injection-matched-filter-and-optimal-snrs-to-output-h5-file'

Compare with previous version

approved this merge request

approved this merge request

enabled an automatic merge when the pipeline for 2bcce6f5 succeeds

merged

mentioned in commit 8bf37565