LALBurst 2.0.7.1-eeff03c
lalburst.burca.ExcessPowerCoincTables Class Reference

Detailed Description

Definition at line 60 of file burca.py.

Inherits lalburst.snglcoinc.CoincTables.

Public Member Functions

def __init__ (self, xmldoc)
 
def make_multi_burst (self, process_id, coinc_event_id, events, offset_vector)
 
def coinc_rows (self, process_id, time_slide_id, events, table_name)
 From a process ID, a time slide ID, and a sequence of events (generator expressions are OK), constructs and initializes a coinc_event table row object and a sequence of coinc_event_map table row objects describing the coincident event. More...
 
def append_coinc (self, coinc, coincmaps, multiburst)
 Appends the coinc_event row object and coinc_event_map row objects to the coinc_event and coinc_event_map tables respectively after assigning a coinc_event_id to the coincidence. More...
 
def __init__ (self, xmldoc, coinc_definer_row)
 
def coinc_rows (self, process_id, time_slide_id, events, table_name)
 From a process ID, a time slide ID, and a sequence of events (generator expressions are OK), constructs and initializes a coinc_event table row object and a sequence of coinc_event_map table row objects describing the coincident event. More...
 
def append_coinc (self, coinc_event_row, coinc_event_map_rows)
 Appends the coinc_event row object and coinc_event_map row objects to the coinc_event and coinc_event_map tables respectively after assigning a coinc_event_id to the coincidence. More...
 

Data Fields

 multibursttable
 
- Data Fields inherited from lalburst.snglcoinc.CoincTables
 coinctable
 
 coincmaptable
 
 coinc_def_id
 
 time_slide_table
 
 time_slide_index
 

Constructor & Destructor Documentation

◆ __init__()

def lalburst.burca.ExcessPowerCoincTables.__init__ (   self,
  xmldoc 
)

Reimplemented from lalburst.snglcoinc.CoincTables.

Definition at line 61 of file burca.py.

Member Function Documentation

◆ make_multi_burst()

def lalburst.burca.ExcessPowerCoincTables.make_multi_burst (   self,
  process_id,
  coinc_event_id,
  events,
  offset_vector 
)

Definition at line 71 of file burca.py.

◆ coinc_rows()

def lalburst.burca.ExcessPowerCoincTables.coinc_rows (   self,
  process_id,
  time_slide_id,
  events,
  table_name 
)

From a process ID, a time slide ID, and a sequence of events (generator expressions are OK), constructs and initializes a coinc_event table row object and a sequence of coinc_event_map table row objects describing the coincident event.

The return value is the coinc_event row and a sequence of the coinc_event_map rows.

The coinc_event is not assigned a coinc_event_id by this method. It is expected that will be done in .append_coinc(). This allows sub-classes to defer the question of whether or not to include the coincidence in the search results without consuming additional IDs.

The coinc_event row's .instruments and .likelihood attributes are initialized to null values. The calling code should populate as needed.

When subclassing this method, if the time shifts that were applied to the events in constructing the coincidence are required to compute additional metadata, they can be retrieved from self.time_slide_index using the time_slide_id.

Reimplemented from lalburst.snglcoinc.CoincTables.

Definition at line 117 of file burca.py.

◆ append_coinc()

def lalburst.burca.ExcessPowerCoincTables.append_coinc (   self,
  coinc_event_row,
  coinc_event_map_rows,
  multiburst 
)

Appends the coinc_event row object and coinc_event_map row objects to the coinc_event and coinc_event_map tables respectively after assigning a coinc_event_id to the coincidence.

Returns the coinc_event row object.

Reimplemented from lalburst.snglcoinc.CoincTables.

Definition at line 122 of file burca.py.

Field Documentation

◆ multibursttable

lalburst.burca.ExcessPowerCoincTables.multibursttable

Definition at line 66 of file burca.py.