lalburst.burca.StringCuspCoincTables Class Reference

Detailed Description

Definition at line 137 of file burca.py.

Inherits lalburst.snglcoinc.CoincTables.

Public Member Functions
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...
Public Member Functions inherited from lalburst.snglcoinc.CoincTables
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...

Additional Inherited Members
Data Fields inherited from lalburst.snglcoinc.CoincTables
	coinctable
	coincmaptable
	coinc_def_id
	time_slide_table
	time_slide_index

Member Function Documentation

coinc_rows()

def lalburst.burca.StringCuspCoincTables.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 138 of file burca.py.