Detailed Description

A convenience interface to the XML document's coincidence tables, allowing for easy addition of coincidence events.

Definition at line 1470 of file snglcoinc.py.

Inherits object.

Inherited by lalburst.burca.ExcessPowerCoincTables, and lalburst.burca.StringCuspCoincTables.

Public Member Functions
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
	coinctable

	coincmaptable

	coinc_def_id

	time_slide_table

	time_slide_index

Constructor & Destructor Documentation

◆ init()

def lalburst.snglcoinc.CoincTables.__init__	(	self,
		xmldoc,
		coinc_definer_row
	)

Reimplemented in lalburst.burca.ExcessPowerCoincTables.

Definition at line 1471 of file snglcoinc.py.

Member Function Documentation

◆ coinc_rows()

def lalburst.snglcoinc.CoincTables.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 in lalburst.burca.ExcessPowerCoincTables, and lalburst.burca.StringCuspCoincTables.

Definition at line 1518 of file snglcoinc.py.

◆ append_coinc()

def lalburst.snglcoinc.CoincTables.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.

Returns the coinc_event row object.

Reimplemented in lalburst.burca.ExcessPowerCoincTables.

Definition at line 1544 of file snglcoinc.py.

Field Documentation

◆ coinctable

lalburst.snglcoinc.CoincTables.coinctable

Definition at line 1474 of file snglcoinc.py.

◆ coincmaptable

lalburst.snglcoinc.CoincTables.coincmaptable

Definition at line 1482 of file snglcoinc.py.

◆ coinc_def_id

lalburst.snglcoinc.CoincTables.coinc_def_id

Definition at line 1488 of file snglcoinc.py.

◆ time_slide_table

lalburst.snglcoinc.CoincTables.time_slide_table

Definition at line 1491 of file snglcoinc.py.

◆ time_slide_index

lalburst.snglcoinc.CoincTables.time_slide_index

Definition at line 1492 of file snglcoinc.py.