Data Structures
class	DocContents
	A wrapper interface to the XML document. More...

class	SimInspiral

class	SnglBurst

Functions
def	append_process (xmldoc, match_algorithm, comment)
	Convenience wrapper for adding process metadata to the document. More...

def	StringCuspSnglCompare (sim, burst, offsetvector)
	Return False (injection matches event) if an autocorrelation-width window centred on the injection is continuous with the time interval of the burst. More...

def	ExcessPowerSnglCompare (sim, burst, offsetvector)
	Return False (injection matches event) if the peak time and centre frequency of sim lie within the time-frequency tile of burst. More...

def	OmegaSnglCompare (sim, burst, offsetvector, delta_t=10.0)
	Return False (injection matches event) if the time of the sim and the peak time of the burst event differ by less than or equal to delta_t seconds. More...

def	CWBSnglCompare (sim, burst, offsetvector, delta_t=10.0)
	Return False (injection matches event) if the time of the sim and the peak time of the burst event differ by less than or equal to delta_t seconds. More...

def	StringCuspNearCoincCompare (sim, burst, offsetvector)
	Return False (injection matches coinc) if the peak time of the sim is "near" the burst event. More...

def	ExcessPowerNearCoincCompare (sim, burst, offsetvector)
	Return False (injection matches coinc) if the peak time of the sim is "near" the burst event. More...

def	OmegaNearCoincCompare (sim, burst, offsetvector)
	Return False (injection matches coinc) if the peak time of the sim is "near" the burst event. More...

def	CWBNearCoincCompare (sim, burst, offsetvector)
	Return False (injection matches coinc) if the peak time of the sim is "near" the burst event. More...

def	find_sngl_burst_matches (contents, sim, comparefunc, sieve_window)
	Scan the burst table for triggers matching sim. More...

def	add_sim_burst_coinc (contents, sim, events, coinc_def_id)
	Create a coinc_event in the coinc table, and add arcs in the coinc_event_map table linking the sim_burst row and the list of sngl_burst rows to the new coinc_event row. More...

def	find_exact_coinc_matches (coincs, sim, comparefunc, seglists, offsetvector)
	Return a set of the coinc_event_ids of the burst<-->burst coincs in which all burst events match sim and to which all instruments on at the time of the sim contributed events. More...

def	find_near_coinc_matches (coincs, sim, comparefunc, offsetvector)
	Return a set of the coinc_event_ids of the burst<-->burst coincs in which at least one burst event matches sim. More...

def	add_sim_coinc_coinc (contents, sim, coinc_event_ids, coinc_def_id)
	Create a coinc_event in the coinc table, and add arcs in the coinc_event_map table linking the sim_burst row and the list of coinc_event rows to the new coinc_event row. More...

def	binjfind (xmldoc, process, search, snglcomparefunc, nearcoinccomparefunc, verbose=False)

Variables
	ExcessPowerSBBCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

	ExcessPowerSIBCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

	ExcessPowerSBCCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

	ExcessPowerSBCNearCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

	ExcessPowerSICCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

	ExcessPowerSICNearCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

	StringCuspSBBCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

	StringCuspSIBCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

	StringCuspSBCCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

	StringCuspSBCNearCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

	StringCuspSICCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

	StringCuspSICNearCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

	OmegaBBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 0, description = "sngl_burst<-->sngl_burst coincidences")

	OmegaSBBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

	OmegaSIBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

	OmegaSBCCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

	OmegaSBCNearCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

	OmegaSICCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

	OmegaSICNearCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

	CWBBBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 0, description = "sngl_burst<-->sngl_burst coincidences")

	CWBSBBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

	CWBSIBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

	CWBSBCCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

	CWBSBCNearCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

	CWBSICCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

	CWBSICNearCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

string	process_program_name = "lalburst_injfind"

Function Documentation

◆ append_process()

def lalburst.binjfind.append_process	(	xmldoc,
		match_algorithm,
		comment
	)

Convenience wrapper for adding process metadata to the document.

Definition at line 397 of file binjfind.py.

◆ StringCuspSnglCompare()

def lalburst.binjfind.StringCuspSnglCompare	(	sim,
		burst,
		offsetvector
	)

Return False (injection matches event) if an autocorrelation-width window centred on the injection is continuous with the time interval of the burst.

Definition at line 425 of file binjfind.py.

◆ ExcessPowerSnglCompare()

def lalburst.binjfind.ExcessPowerSnglCompare	(	sim,
		burst,
		offsetvector
	)

Return False (injection matches event) if the peak time and centre frequency of sim lie within the time-frequency tile of burst.

Definition at line 436 of file binjfind.py.

◆ OmegaSnglCompare()

def lalburst.binjfind.OmegaSnglCompare	(	sim,
		burst,
		offsetvector,
		delta_t = `10.0`
	)

Return False (injection matches event) if the time of the sim and the peak time of the burst event differ by less than or equal to delta_t seconds.

Definition at line 445 of file binjfind.py.

◆ CWBSnglCompare()

def lalburst.binjfind.CWBSnglCompare	(	sim,
		burst,
		offsetvector,
		delta_t = `10.0`
	)

Return False (injection matches event) if the time of the sim and the peak time of the burst event differ by less than or equal to delta_t seconds.

Definition at line 453 of file binjfind.py.

◆ StringCuspNearCoincCompare()

def lalburst.binjfind.StringCuspNearCoincCompare	(	sim,
		burst,
		offsetvector
	)

Return False (injection matches coinc) if the peak time of the sim is "near" the burst event.

Definition at line 461 of file binjfind.py.

◆ ExcessPowerNearCoincCompare()

def lalburst.binjfind.ExcessPowerNearCoincCompare	(	sim,
		burst,
		offsetvector
	)

Return False (injection matches coinc) if the peak time of the sim is "near" the burst event.

Definition at line 471 of file binjfind.py.

◆ OmegaNearCoincCompare()

def lalburst.binjfind.OmegaNearCoincCompare	(	sim,
		burst,
		offsetvector
	)

Return False (injection matches coinc) if the peak time of the sim is "near" the burst event.

Definition at line 481 of file binjfind.py.

◆ CWBNearCoincCompare()

def lalburst.binjfind.CWBNearCoincCompare	(	sim,
		burst,
		offsetvector
	)

Return False (injection matches coinc) if the peak time of the sim is "near" the burst event.

Definition at line 488 of file binjfind.py.

◆ find_sngl_burst_matches()

def lalburst.binjfind.find_sngl_burst_matches	(	contents,
		sim,
		comparefunc,
		sieve_window
	)

Scan the burst table for triggers matching sim.

sieve_window is used in a bisection search to quickly identify burst events within that many seconds of the injection's peak time at the geocentre; it should be larger than the greatest time difference that can separate a burst event's peak time from an injection's peak time at the geocentre and the two still be considered a match.

Definition at line 509 of file binjfind.py.

◆ add_sim_burst_coinc()

def lalburst.binjfind.add_sim_burst_coinc	(	contents,
		sim,
		events,
		coinc_def_id
	)

Create a coinc_event in the coinc table, and add arcs in the coinc_event_map table linking the sim_burst row and the list of sngl_burst rows to the new coinc_event row.

Definition at line 519 of file binjfind.py.

◆ find_exact_coinc_matches()

def lalburst.binjfind.find_exact_coinc_matches	(	coincs,
		sim,
		comparefunc,
		seglists,
		offsetvector
	)

Return a set of the coinc_event_ids of the burst<-->burst coincs in which all burst events match sim and to which all instruments on at the time of the sim contributed events.

Definition at line 555 of file binjfind.py.

◆ find_near_coinc_matches()

def lalburst.binjfind.find_near_coinc_matches	(	coincs,
		sim,
		comparefunc,
		offsetvector
	)

Return a set of the coinc_event_ids of the burst<-->burst coincs in which at least one burst event matches sim.

Definition at line 572 of file binjfind.py.

◆ add_sim_coinc_coinc()

def lalburst.binjfind.add_sim_coinc_coinc	(	contents,
		sim,
		coinc_event_ids,
		coinc_def_id
	)

Create a coinc_event in the coinc table, and add arcs in the coinc_event_map table linking the sim_burst row and the list of coinc_event rows to the new coinc_event row.

Definition at line 589 of file binjfind.py.

◆ binjfind()

def lalburst.binjfind.binjfind	(	xmldoc,
		process,
		search,
		snglcomparefunc,
		nearcoinccomparefunc,
		verbose = `False`
	)

Definition at line 619 of file binjfind.py.

Variable Documentation

◆ ExcessPowerSBBCoincDef

lalburst.binjfind.ExcessPowerSBBCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

Definition at line 129 of file binjfind.py.

◆ ExcessPowerSIBCoincDef

lalburst.binjfind.ExcessPowerSIBCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

Definition at line 130 of file binjfind.py.

◆ ExcessPowerSBCCoincDef

lalburst.binjfind.ExcessPowerSBCCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

Definition at line 131 of file binjfind.py.

◆ ExcessPowerSBCNearCoincDef

lalburst.binjfind.ExcessPowerSBCNearCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

Definition at line 132 of file binjfind.py.

◆ ExcessPowerSICCoincDef

lalburst.binjfind.ExcessPowerSICCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

Definition at line 133 of file binjfind.py.

◆ ExcessPowerSICNearCoincDef

lalburst.binjfind.ExcessPowerSICNearCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

Definition at line 134 of file binjfind.py.

◆ StringCuspSBBCoincDef

lalburst.binjfind.StringCuspSBBCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

Definition at line 137 of file binjfind.py.

◆ StringCuspSIBCoincDef

lalburst.binjfind.StringCuspSIBCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

Definition at line 138 of file binjfind.py.

◆ StringCuspSBCCoincDef

lalburst.binjfind.StringCuspSBCCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

Definition at line 139 of file binjfind.py.

◆ StringCuspSBCNearCoincDef

lalburst.binjfind.StringCuspSBCNearCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

Definition at line 140 of file binjfind.py.

◆ StringCuspSICCoincDef

lalburst.binjfind.StringCuspSICCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

Definition at line 141 of file binjfind.py.

◆ StringCuspSICNearCoincDef

lalburst.binjfind.StringCuspSICNearCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

Definition at line 142 of file binjfind.py.

◆ OmegaBBCoincDef

lalburst.binjfind.OmegaBBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 0, description = "sngl_burst<-->sngl_burst coincidences")

Definition at line 145 of file binjfind.py.

◆ OmegaSBBCoincDef

lalburst.binjfind.OmegaSBBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

Definition at line 146 of file binjfind.py.

◆ OmegaSIBCoincDef

lalburst.binjfind.OmegaSIBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

Definition at line 147 of file binjfind.py.

◆ OmegaSBCCoincDef

lalburst.binjfind.OmegaSBCCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

Definition at line 148 of file binjfind.py.

◆ OmegaSBCNearCoincDef

lalburst.binjfind.OmegaSBCNearCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

Definition at line 149 of file binjfind.py.

◆ OmegaSICCoincDef

lalburst.binjfind.OmegaSICCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

Definition at line 150 of file binjfind.py.

◆ OmegaSICNearCoincDef

lalburst.binjfind.OmegaSICNearCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

Definition at line 151 of file binjfind.py.

◆ CWBBBCoincDef

lalburst.binjfind.CWBBBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 0, description = "sngl_burst<-->sngl_burst coincidences")

Definition at line 153 of file binjfind.py.

◆ CWBSBBCoincDef

lalburst.binjfind.CWBSBBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")

Definition at line 154 of file binjfind.py.

◆ CWBSIBCoincDef

lalburst.binjfind.CWBSIBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")

Definition at line 155 of file binjfind.py.

◆ CWBSBCCoincDef

lalburst.binjfind.CWBSBCCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")

Definition at line 156 of file binjfind.py.

◆ CWBSBCNearCoincDef

lalburst.binjfind.CWBSBCNearCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")

Definition at line 157 of file binjfind.py.

◆ CWBSICCoincDef

lalburst.binjfind.CWBSICCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")

Definition at line 158 of file binjfind.py.

◆ CWBSICNearCoincDef

lalburst.binjfind.CWBSICNearCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")

Definition at line 159 of file binjfind.py.

◆ process_program_name

string lalburst.binjfind.process_program_name = "lalburst_injfind"

Definition at line 391 of file binjfind.py.

Data Structures

Functions

Variables

Function Documentation

◆ append_process()

◆ StringCuspSnglCompare()

◆ ExcessPowerSnglCompare()

◆ OmegaSnglCompare()

◆ CWBSnglCompare()

◆ StringCuspNearCoincCompare()

◆ ExcessPowerNearCoincCompare()

◆ OmegaNearCoincCompare()

◆ CWBNearCoincCompare()

◆ find_sngl_burst_matches()

◆ add_sim_burst_coinc()

◆ find_exact_coinc_matches()

◆ find_near_coinc_matches()

◆ add_sim_coinc_coinc()

◆ binjfind()

Variable Documentation

◆ ExcessPowerSBBCoincDef

◆ ExcessPowerSIBCoincDef

◆ ExcessPowerSBCCoincDef

◆ ExcessPowerSBCNearCoincDef

◆ ExcessPowerSICCoincDef

◆ ExcessPowerSICNearCoincDef

◆ StringCuspSBBCoincDef

◆ StringCuspSIBCoincDef

◆ StringCuspSBCCoincDef

◆ StringCuspSBCNearCoincDef

◆ StringCuspSICCoincDef

◆ StringCuspSICNearCoincDef

◆ OmegaBBCoincDef

◆ OmegaSBBCoincDef

◆ OmegaSIBCoincDef

◆ OmegaSBCCoincDef

◆ OmegaSBCNearCoincDef

◆ OmegaSICCoincDef

◆ OmegaSICNearCoincDef

◆ CWBBBCoincDef

◆ CWBSBBCoincDef

◆ CWBSIBCoincDef

◆ CWBSBCCoincDef

◆ CWBSBCNearCoincDef

◆ CWBSICCoincDef

◆ CWBSICNearCoincDef

◆ process_program_name