Data Structures
class	LIGOLWContentHandlerExtractSimBurstTable

Functions
def	fractional_rank (x, xs)
	Returns the fraction of samples, `xs`, that fall below the value `x`. More...

def	pp_plot (ps, title=None, outfile=None)
	Generates a p-p plot for the given ps. More...

def	pp_kstest_pvalue (ps)
	Returns the K-S p-value for the test of the given `ps` against a uniform distribution on [0,1]. More...

def	read_posterior_samples (f)
	Returns a named numpy array of the posterior samples in the file `f`. More...

def	output_html (outdir, ks_pvalues, injnum, skypp=False)
	Outputs the HTML page summarizing the results. More...

Variables
dictionary	posterior_name_to_sim_burst_extractor

dictionary	posterior_name_to_latex_name

string	USAGE

	parser = optparse.OptionParser(USAGE)

	action

	type

	dest

	help

	default

	None

	options

	args

	injs = lsctables.SimBurstTable.get_table(utils.load_filename(options.injxml,contenthandler=LIGOLWContentHandlerExtractSimBurstTable))

list	parameters = ['frequency', 'quality', 'hrss', 'ra', 'dec', 'psi', 'time', 'alpha','polar_eccentricity']

dictionary	pvalues = { }

	posfiles = args

int	Ninj = 0

def	psamples = read_posterior_samples(posfile)

	true_params = injs[index]

def	samples = psamples[par]

dictionary	true_value = posterior_name_to_sim_burst_extractor[par](true_params)

def	p = fractional_rank(true_value, samples)

dictionary	ks_pvalues = {}

	ps

	title

	outfile

bool	skypp = False

int	found = 0

	inf = os.path.join(os.path.realpath(options.skypp),'p-p.%s'%i)

	outf = os.path.join(options.outdir,'sky_p-p.%s'%i)

	outdir

Function Documentation

◆ fractional_rank()

def cbcBayesBurstPPAnalysis.fractional_rank	(	x,
		xs
	)

Returns the fraction of samples, xs, that fall below the value x.

Definition at line 93 of file cbcBayesBurstPPAnalysis.py.

◆ pp_plot()

def cbcBayesBurstPPAnalysis.pp_plot	(	ps,
		title = `None`,
		outfile = `None`
	)

Generates a p-p plot for the given ps.

:param ps: The p-values whose cumulative distribution is to be plotted.

:param title: An (optional) title for the plot.

:param outfile: An (optional) basename for the plot file; both basename.png and basename.pdf will be created.

Definition at line 109 of file cbcBayesBurstPPAnalysis.py.

◆ pp_kstest_pvalue()

def cbcBayesBurstPPAnalysis.pp_kstest_pvalue ( ps )

Returns the K-S p-value for the test of the given ps against a uniform distribution on [0,1].

Definition at line 145 of file cbcBayesBurstPPAnalysis.py.

◆ read_posterior_samples()

def cbcBayesBurstPPAnalysis.read_posterior_samples ( f )

Returns a named numpy array of the posterior samples in the file f.

Definition at line 154 of file cbcBayesBurstPPAnalysis.py.

◆ output_html()

def cbcBayesBurstPPAnalysis.output_html	(	outdir,
		ks_pvalues,
		injnum,
		skypp = `False`
	)

Outputs the HTML page summarizing the results.

Definition at line 165 of file cbcBayesBurstPPAnalysis.py.

Variable Documentation

◆ posterior_name_to_sim_burst_extractor

dictionary cbcBayesBurstPPAnalysis.posterior_name_to_sim_burst_extractor

Initial value:

=  {
    'frequency' : lambda sb: sb.frequency,
    'duration' : lambda sb: sb.duration,
    'quality' : lambda sb: sb.q,
    'hrss' : lambda sb: sb.hrss,
    'psi' : lambda sb: sb.psi,
    'time' : lambda sb: sb.time_geocent_gps + 1e-9*sb.time_geocent_gps_ns,
    'ra' : lambda sb: sb.ra,
    'dec' : lambda sb: sb.dec,
    'polar_angle':lambda sb:sb.pol_ellipse_angle,
    'polar_eccentricity':lambda sb:sb.pol_ellipse_e,
    'alpha':lambda sb:sb.pol_ellipse_angle
}

Definition at line 58 of file cbcBayesBurstPPAnalysis.py.

◆ posterior_name_to_latex_name

dictionary cbcBayesBurstPPAnalysis.posterior_name_to_latex_name

Initial value:

=  {
    'frequency' : r'$f$',
    'quality' : r'$q$',
    'duration' : r'$\tau$',
    'hrss' : r'$hrss$',
    'time' : r'$t$',
    'ra' : r'$\alpha$',
    'dec' : r'$\delta$',
    'psi' : r'$\psi$',
    'polar_angle' : r'$\xi_a$',
    'polar_eccentricity' : r'$\xi_e$',
    'alpha' : r'$\zeta_{orb}$',
 
 
}

Definition at line 73 of file cbcBayesBurstPPAnalysis.py.

◆ USAGE

string cbcBayesBurstPPAnalysis.USAGE

Initial value:

1= '''%prog [options] posfile1.dat posfile2.dat ...

2 Generate PP analysis for a set of injections. posfiles must be in same order as injections.'''

Definition at line 221 of file cbcBayesBurstPPAnalysis.py.

◆ parser

cbcBayesBurstPPAnalysis.parser = optparse.OptionParser(USAGE)

Definition at line 223 of file cbcBayesBurstPPAnalysis.py.

◆ action

cbcBayesBurstPPAnalysis.action

Definition at line 224 of file cbcBayesBurstPPAnalysis.py.

◆ type

cbcBayesBurstPPAnalysis.type

Definition at line 224 of file cbcBayesBurstPPAnalysis.py.

◆ dest

cbcBayesBurstPPAnalysis.dest

Definition at line 224 of file cbcBayesBurstPPAnalysis.py.

◆ help

cbcBayesBurstPPAnalysis.help

Definition at line 225 of file cbcBayesBurstPPAnalysis.py.

◆ default

cbcBayesBurstPPAnalysis.default

Definition at line 230 of file cbcBayesBurstPPAnalysis.py.

◆ None

cbcBayesBurstPPAnalysis.None

Definition at line 235 of file cbcBayesBurstPPAnalysis.py.

◆ options

cbcBayesBurstPPAnalysis.options

Definition at line 237 of file cbcBayesBurstPPAnalysis.py.

◆ args

cbcBayesBurstPPAnalysis.args

Definition at line 237 of file cbcBayesBurstPPAnalysis.py.

◆ injs

cbcBayesBurstPPAnalysis.injs = lsctables.SimBurstTable.get_table(utils.load_filename(options.injxml,contenthandler=LIGOLWContentHandlerExtractSimBurstTable))

Definition at line 239 of file cbcBayesBurstPPAnalysis.py.