Module coh_PTF_pyutils

Calculate BestNR (coh_PTF detection statistic) through signal based vetoes:

The signal based vetoes are as follows:
  * Coherent SNR < 6
  * Bank chi-squared reduced (new) SNR < 6
  * Auto veto reduced (new) SNR < 6
  * Single-detector SNR (from two most sensitive IFOs) < 4
  * Null SNR (CoincSNR^2 - CohSNR^2)^(1/2) < nullthresh
Returns BestNR as float

Return detector response for complete set of IFOs for given sky location and time. Inclination and polarization are unused so are arbitrarily set to 0.

Veto events in a MultiInspiralTable based on their (coherent) SNR
value.

@param mi_table
    a MultiInspiralTable from which to veto events
@param snr
    the value of coherent SNR on which to threshold
@param return_index
    boolean to return the index array of non-vetoed elements rather
    than a new table containing the elements themselves

@returns
    a new MultiInspiralTable with those events not vetoed OR
    the indices of the original mi_table not vetoed if return_index=True

Veto events in a MultiInspiralTable based on their $\chi^2$
re-weighted coherent SNR.

@param mi_table
    a MultiInspiralTable from which to veto events
@param snr
    the value of coherent new SNR on which to threshold
@param chisq_index
    the index $\iota$ used in the newSNR calculation:
    [
ho_{\mbox{new}} =
        rac{
ho}{\left[rac{1}{2}
            \left(1 + \left(rac{\chi^2}{n_\mbox{dof}}
ight)^{\iota/3}
            
ight)
ight]^{1/\iota}}
    ]
@param return_index
    boolean to return the index array of non-vetoed elements rather
    than a new table containing the elements themselves

Veto events in a MultiInspiralTable based on their bank chisq-
weighted (new) coherent SNR.

@param mi_table
    a MultiInspiralTable from which to veto events
@param snr
    the value of coherent new SNR on which to threshold
@param chisq_index
    the index $\iota$ used in the newSNR calculation:
    [
ho_{\mbox{new}} =
        rac{
ho}{\left[rac{1}{2}
            \left(1 + \left(rac{\chi^2}{n_\mbox{dof}}
ight)^{\iota/3}
            
ight)
ight]^{1/\iota}}
    ]
@param return_index
    boolean to return the index array of non-vetoed elements rather
    than a new table containing the elements themselves

@returns
    a new MultiInspiralTable with those events not vetoed OR
    the indices of the original mi_table not vetoed if return_index=True

Veto events in a MultiInspiralTable based on their auto chisq-
weighted (new) coherent SNR.

@param mi_table
    a MultiInspiralTable from which to veto events
@param snr
    the value of coherent new SNR on which to threshold
@param chisq_index
    the index $\iota$ used in the newSNR calculation:
    [
ho_{\mbox{new}} =
        rac{
ho}{\left[rac{1}{2}
            \left(1 + \left(rac{\chi^2}{n_\mbox{dof}}
ight)^{\iota/3}
            
ight)
ight]^{1/\iota}}
    ]
@param return_index
    boolean to return the index array of non-vetoed elements rather
    than a new table containing the elements themselves

@returns
    a new MultiInspiralTable with those events not vetoed OR
    the indices of the original mi_table not vetoed if return_index=True

Veto events in a MultiInspiralTable based on their single-detector
snr in the most sensitive detectors.

@param mi_table
    a MultiInspiralTable from which to veto events
@param snrs
    an X-element list of single-detector SNRs on which to threshold
    for the X most sensitive detectors (in sensitivity order)
@param return_index
    boolean to return the index array of non-vetoed elements rather
    than a new table containing the elements themselves

@returns
    a new MultiInspiralTable with those events not vetoed OR
    the indices of the original mi_table not vetoed if return_index=True

Veto events in a MultiInspiralTable based on their null SNR.

@param mi_table
    a MultiInspiralTable from which to veto events
@param null_snr
    the value of null SNR on which to threshold
@param snr
    the value of coherent SNR on above which to grade the null SNR
    threshold
@param grad
    the rate at which to increase the null SNR threshold above snr
@param return_index
    boolean to return the index array of non-vetoed elements rather
    than a new table containing the elements themselves

@returns
    a new MultiInspiralTable with those events not vetoed OR
    the indices of the original mi_table not vetoed if return_index=True

Return a MultiInspiralTable with those row from self not lying inside (i.e. not vetoed by) any elements of seglist.

If time_slide_table is not None, any time shifts will be undone and each detector checked individually

Return a MultiInspiralTable with those row from self lying inside (i.e. vetoed by) any elements of seglist.

If time_slide_table is not None, any time shifts will be undone and each detector checked individually