Package pylal :: Module MultiInspiralUtils
[hide private]
[frames] | no frames]

Module MultiInspiralUtils

source code

Functions [hide private]
 
ReadMultiInspiralFromFiles(fileList)
Read the multiInspiral tables from a list of files
source code
 
ReadMultiInspiralTimeSlidesFromFiles(fileList, generate_output_tables=False)
Read time-slid multiInspiral tables from a list of files
source code
 
CompareMultiInspiralByEndTime(a, b)
Orders a and b by peak time.
source code
 
CompareMultiInspiralBySnr(a, b)
Orders a and b by peak time.
source code
 
CompareMultiInspiral(a, b, twindow=LIGOTimeGPS(0))
Returns 0 if a and b are less than twindow appart.
source code
 
cluster_multi_inspirals(mi_table, dt, loudest_by="snr")
Cluster a MultiInspiralTable with a given ranking statistic and clustering window.
source code
Function Details [hide private]

ReadMultiInspiralFromFiles(fileList)

source code 

Read the multiInspiral tables from a list of files

Parameters:
  • fileList - list of input files

ReadMultiInspiralTimeSlidesFromFiles(fileList, generate_output_tables=False)

source code 

Read time-slid multiInspiral tables from a list of files

Parameters:
  • fileList - list of input files

cluster_multi_inspirals(mi_table, dt, loudest_by="snr")

source code 
Cluster a MultiInspiralTable with a given ranking statistic and
clustering window.

This method separates the table rows into time bins, returning those
row that are
    * loudest in their own bin, and
    * louder than those events in the preceeding and following bins
      that are within the clustering time window

@return: a new MultiInspiralTable containing those clustered events

@param mi_table:
    MultiInspiralTable to cluster
@param dt:
    width (seconds) of clustering window
@keyword loudest_by:
    column by which to rank events, default: 'snr'

@type mi_table: glue.ligolw.lsctables.MultiInspiralTable
@type dt: float
@type loudest_by: string
@rtype: glue.ligolw.lsctables.MultiInspiralTable