lalburst.bucluster Namespace Reference

Functions
def	append_process (xmldoc, cluster_algorithm, comment)
def	add_ms_columns (xmldoc)
def	add_ms_columns_to_table (sngl_burst_table)
def	ExcessPowerPreFunc (sngl_burst_table)
	For speed, convert peak times to floats relative to epoch. More...
def	ExcessPowerPostFunc (sngl_burst_table, offset)
	Restore peak times to absolute LIGOTimeGPS values. More...
def	ExcessPowerSortKeyFunc (a)
	Sort key for grouping excess power triggers near triggers with which they might cluster. More...
def	ExcessPowerBailoutFunc (a, b)
	Returns True if a's and b's (ifo, channel, seach) are different or if the periods they span are disjoint. More...
def	ExcessPowerTestFunc (a, b)
	Return False if a and b cluster. More...
def	ExcessPowerClusterFunc (a, b)
	Modify a in place to be a cluster constructed from a and b. More...
def	OmegaClusterFunc (a, b)
	Modify a in place to be a cluster constructed from a and b. More...
def	bucluster (xmldoc, program, process, prefunc, postfunc, testfunc, clusterfunc, sortkeyfunc=None, bailoutfunc=None, verbose=False)
	Run the clustering algorithm on the list of burst candidates. More...

Variables
string	process_program_name = "lalburst_cluster"

Function Documentation

append_process()

def lalburst.bucluster.append_process	(		xmldoc,
			cluster_algorithm,
			comment
	)

Definition at line 55 of file bucluster.py.

add_ms_columns()

def lalburst.bucluster.add_ms_columns

(

xmldoc

)

Definition at line 85 of file bucluster.py.

add_ms_columns_to_table()

def lalburst.bucluster.add_ms_columns_to_table

(

sngl_burst_table

)

Definition at line 89 of file bucluster.py.

ExcessPowerPreFunc()

def lalburst.bucluster.ExcessPowerPreFunc

(

sngl_burst_table

)

For speed, convert peak times to floats relative to epoch.

Definition at line 128 of file bucluster.py.

ExcessPowerPostFunc()

def lalburst.bucluster.ExcessPowerPostFunc	(		sngl_burst_table,
			offset
	)

Restore peak times to absolute LIGOTimeGPS values.

Definition at line 141 of file bucluster.py.

ExcessPowerSortKeyFunc()

def lalburst.bucluster.ExcessPowerSortKeyFunc

(

a

)

Sort key for grouping excess power triggers near triggers with which they might cluster.

Definition at line 150 of file bucluster.py.

ExcessPowerBailoutFunc()

def lalburst.bucluster.ExcessPowerBailoutFunc	(		a,
			b
	)

Returns True if a's and b's (ifo, channel, seach) are different or if the periods they span are disjoint.

Knowing excess power triggers have been ordered according to ExcessPowerSortKeyFunc(), then if for a pair of events this function returns False, we know the result will also be False for all other events farther apart in the list. This is used to terminate the scan for events to cluster.

Definition at line 163 of file bucluster.py.

ExcessPowerTestFunc()

def lalburst.bucluster.ExcessPowerTestFunc	(		a,
			b
	)

Return False if a and b cluster.

To cluster, two events must be from the same channel of the same instrument, and their time-frequency tiles must be non-disjoint.

Definition at line 172 of file bucluster.py.

ExcessPowerClusterFunc()

def lalburst.bucluster.ExcessPowerClusterFunc	(		a,
			b
	)

Modify a in place to be a cluster constructed from a and b.

The cluster's time-frequency tile is the smallest tile that contains the original two tiles, and the "most signficiant" contributor for the cluster is the tile whose boundaries are the SNR^{2} weighted average boundaries of the two contributing tiles. The "most signficiant" contributor's h_{rss}, SNR, and confidence, are copied verbatim from whichever of the two contributing tiles has the highest confidence. The modified event a is returned.

Definition at line 186 of file bucluster.py.

OmegaClusterFunc()

def lalburst.bucluster.OmegaClusterFunc	(		a,
			b
	)

Modify a in place to be a cluster constructed from a and b.

The cluster's time-frequency tile is the smallest tile that contains the original two tiles, and the "most signficiant" contributor for the cluster is the tile whose boundaries are the SNR^{2} weighted average boundaries of the two contributing tiles. The "most signficiant" contributor's h_{rss}, SNR, and confidence, are copied verbatim from whichever of the two contributing tiles has the highest confidence. The modified event a is returned.

Definition at line 267 of file bucluster.py.

bucluster()

def lalburst.bucluster.bucluster	(		xmldoc,
			program,
			process,
			prefunc,
			postfunc,
			testfunc,
			clusterfunc,
			sortkeyfunc = None,
			bailoutfunc = None,
			verbose = False
	)

Run the clustering algorithm on the list of burst candidates.

The return value is the tuple (xmldoc, changed), where xmldoc is the input document, and changed is a boolean that is True if the contents of the sngl_burst table were altered, and False if the triggers were not modified by the clustering process.

If the document does not contain a sngl_burst table, then the document is not modified (including no modifications to the process metadata tables).

Definition at line 349 of file bucluster.py.

Variable Documentation

process_program_name

string lalburst.bucluster.process_program_name = "lalburst_cluster"

Definition at line 52 of file bucluster.py.