lalburst_power_final Namespace Reference

Data Structures
class	EfficiencyData
class	RateData
class	RateVsThresholdData

Functions
def	parse_command_line ()
def	bb_id_likelihood_confidence_background (database)
def	create_sim_coinc_map_view (connection)
def	dump_confidence_likelihood_scatter_data (globs, live_time_program="lalapps_power", tmp_path=None, verbose=False)
def	plot_confidence_likelihood_scatter_data (slope, verbose=False)
def	measure_threshold (filenames, n_survivors, live_time_program="lalapps_power", tmp_path=None, open_box=False, verbose=False)
def	print_rate_vs_threshold_data (rate_vs_threshold_data, confidence_contour_slope)
def	plot_rate_vs_threshold (data)
	Input is a RateVsThresholdData instance. More...
def	diagnostic_plot (z, bins, title, ylabel, filename)
def	measure_efficiency (filenames, threshold, live_time_program="lalapps_power", upper_limit_scale="E", tmp_path=None, verbose=False)
def	plot_efficiency_data (efficiency_data)
def	mu_p_epsilon (xi, p)
	Given the background correction factor $\xi$, and the upper limit confidence p, solve. More...
def	rate_upper_limit (efficiency_data, mu_0primed, zero_lag_live_time, p)
def	plot_rate_upper_limit (rate_data)
def	coinc_detection_statistic (likelihood, confidence, m=options.confidence_contour_slope)

Variables
	PosInf = float("+inf")
	NegInf = float("-inf")
	options
	filenames = sorted(filename for g in options.background_glob for filename in glob.glob(g))
	file
	injections_glob
	live_time_program
	tmp_path
	tmp_space
	verbose
	confidence_contour_slope
def	rate_vs_threshold_data = measure_threshold(filenames, options.zero_lag_survivors, live_time_program = options.live_time_program, tmp_path = options.tmp_space, open_box = options.open_box, verbose = options.verbose)
	zero_lag_live_time
	amplitude_threshold
	mu_0primed
def	efficiency_data = measure_efficiency(filenames, rate_vs_threshold_data.amplitude_threshold, live_time_program = options.live_time_program, upper_limit_scale = options.upper_limit_scale, tmp_path = options.tmp_space, verbose = options.verbose)
def	rate_data = rate_upper_limit(efficiency_data, rate_vs_threshold_data.mu_0primed, rate_vs_threshold_data.zero_lag_live_time, options.upper_limit_confidence)

Function Documentation

parse_command_line()

def lalburst_power_final.parse_command_line

(

)

Definition at line 107 of file lalburst_power_final.py.

bb_id_likelihood_confidence_background()

def lalburst_power_final.bb_id_likelihood_confidence_background

(

database

)

Definition at line 156 of file lalburst_power_final.py.

create_sim_coinc_map_view()

def lalburst_power_final.create_sim_coinc_map_view

(

connection

)

Definition at line 187 of file lalburst_power_final.py.

dump_confidence_likelihood_scatter_data()

def lalburst_power_final.dump_confidence_likelihood_scatter_data	(		globs,
			live_time_program = "lalapps_power",
			tmp_path = None,
			verbose = False
	)

Definition at line 235 of file lalburst_power_final.py.

plot_confidence_likelihood_scatter_data()

def lalburst_power_final.plot_confidence_likelihood_scatter_data	(		slope,
			verbose = False
	)

Definition at line 344 of file lalburst_power_final.py.

measure_threshold()

def lalburst_power_final.measure_threshold	(		filenames,
			n_survivors,
			live_time_program = "lalapps_power",
			tmp_path = None,
			open_box = False,
			verbose = False
	)

Definition at line 589 of file lalburst_power_final.py.

print_rate_vs_threshold_data()

def lalburst_power_final.print_rate_vs_threshold_data	(		rate_vs_threshold_data,
			confidence_contour_slope
	)

Definition at line 645 of file lalburst_power_final.py.

plot_rate_vs_threshold()

def lalburst_power_final.plot_rate_vs_threshold

(

data

)

Input is a RateVsThresholdData instance.

Output is a matplotlib Figure instance.

Definition at line 676 of file lalburst_power_final.py.

diagnostic_plot()

def lalburst_power_final.diagnostic_plot	(		z,
			bins,
			title,
			ylabel,
			filename
	)

Definition at line 777 of file lalburst_power_final.py.

measure_efficiency()

def lalburst_power_final.measure_efficiency	(		filenames,
			threshold,
			live_time_program = "lalapps_power",
			upper_limit_scale = "E",
			tmp_path = None,
			verbose = False
	)

Definition at line 969 of file lalburst_power_final.py.

plot_efficiency_data()

def lalburst_power_final.plot_efficiency_data

(

efficiency_data

)

Definition at line 1029 of file lalburst_power_final.py.

mu_p_epsilon()

def lalburst_power_final.mu_p_epsilon	(		xi,
			p
	)

Given the background correction factor $\xi$, and the upper limit confidence p, solve.

$p = 1 - \ee^{-\mu_{p} \epsilon} (1 + \xi \mu_{p} \epsilon)$

for ($\mu_{p} \epsilon$), the product of the foreground rate upper limit times the efficiency. Note that this product is always well defined by this relation (i.e., even when the efficiency is 0).

Definition at line 1071 of file lalburst_power_final.py.

rate_upper_limit()

def lalburst_power_final.rate_upper_limit	(		efficiency_data,
			mu_0primed,
			zero_lag_live_time,
			p
	)

Definition at line 1091 of file lalburst_power_final.py.

plot_rate_upper_limit()

def lalburst_power_final.plot_rate_upper_limit

(

rate_data

)

Definition at line 1153 of file lalburst_power_final.py.

coinc_detection_statistic()

def lalburst_power_final.coinc_detection_statistic	(		likelihood,
			confidence,
			m = options.confidence_contour_slope
	)

Definition at line 1229 of file lalburst_power_final.py.

Variable Documentation

PosInf

lalburst_power_final.PosInf = float("+inf")

Definition at line 71 of file lalburst_power_final.py.

NegInf

lalburst_power_final.NegInf = float("-inf")

Definition at line 72 of file lalburst_power_final.py.

options

lalburst_power_final.options

Definition at line 1216 of file lalburst_power_final.py.

filenames

lalburst_power_final.filenames = sorted(filename for g in options.background_glob for filename in glob.glob(g))

Definition at line 1216 of file lalburst_power_final.py.

file

lalburst_power_final.file

Definition at line 1269 of file lalburst_power_final.py.

injections_glob

lalburst_power_final.injections_glob

Definition at line 1271 of file lalburst_power_final.py.

live_time_program

lalburst_power_final.live_time_program

Definition at line 1271 of file lalburst_power_final.py.

tmp_path

lalburst_power_final.tmp_path

Definition at line 1271 of file lalburst_power_final.py.

tmp_space

lalburst_power_final.tmp_space

Definition at line 1271 of file lalburst_power_final.py.

verbose

lalburst_power_final.verbose

Definition at line 1271 of file lalburst_power_final.py.

confidence_contour_slope

lalburst_power_final.confidence_contour_slope

Definition at line 1280 of file lalburst_power_final.py.

rate_vs_threshold_data

lalburst_power_final.rate_vs_threshold_data = measure_threshold(filenames, options.zero_lag_survivors, live_time_program = options.live_time_program, tmp_path = options.tmp_space, open_box = options.open_box, verbose = options.verbose)

Definition at line 1305 of file lalburst_power_final.py.

zero_lag_live_time

lalburst_power_final.zero_lag_live_time

Definition at line 1311 of file lalburst_power_final.py.

amplitude_threshold

lalburst_power_final.amplitude_threshold

Definition at line 1312 of file lalburst_power_final.py.

mu_0primed

lalburst_power_final.mu_0primed

Definition at line 1313 of file lalburst_power_final.py.

efficiency_data

def lalburst_power_final.efficiency_data = measure_efficiency(filenames, rate_vs_threshold_data.amplitude_threshold, live_time_program = options.live_time_program, upper_limit_scale = options.upper_limit_scale, tmp_path = options.tmp_space, verbose = options.verbose)

Definition at line 1334 of file lalburst_power_final.py.

rate_data

def lalburst_power_final.rate_data = rate_upper_limit(efficiency_data, rate_vs_threshold_data.mu_0primed, rate_vs_threshold_data.zero_lag_live_time, options.upper_limit_confidence)

Definition at line 1355 of file lalburst_power_final.py.