lalpulsar_knope_result_page Namespace Reference

Data Structures
class	create_background
	Get information (evidence ratios and SNRs) from any the background analyses. More...
class	create_data_table
class	posteriors
	Get sample posteriors and created a set of functions for outputting tables, plots and posterior statistics. More...

Functions
def	set_spin_down (p1_I, assoc, f0, f1, n=5.0)
	Set the spin-down of the source based on the intrinsic period derivative (p1_I) corrected for any proper motion/ globular cluster acceleration if available, or if not give AND the pulsar is in a globular cluster base the spin-down on assuming an age of 10^9 years (defaulting to the source being a gravitar, with n=5). More...
def	create_psr_table (par)
	Create a html table of some information from the pulsar parameter file. More...

Variables
	file
string	htmlpage
string	description = """This script will create a results page for a single pulsar from the known pulsar analysis pipeline. A configuration (.ini) file is required."""
string	epilog
	parser
	help
	opts = parser.parse_args()
	inifile = opts.inifile
	cp = ConfigParser()
	outdir = cp.get("output", "path")
	indexpage = cp.get("output", "indexpage")
	parfile = None
	par = psr_par(parfile)
	pname = par["PSRJ"]
	f0 = par["F0"]
	f1 = par["F1"]
	upperlim = ast.literval_eval(cp.get("general", "upper_limit"))
	credints = ast.literval_eval(cp.get("general", "credible_interval"))
	injection = cp.getboolean("general", "injection")
	usegwphase = cp.getboolean("general", "use_gw_phase")
	priorfile = cp.get("general", "priorfile")
	dist = None
	atnfurl = None
	jsonfile = os.path.join(outdir, pname + ".json")
bool	tryatnf = True
	fp = open(jsonfile, "r")
	info = json.load(fp)
	p1_I = info["Pulsar data"]["P1_I"]
	assoc = info["Pulsar data"]["ASSOC"]
	pinfo = get_atnf_info(pname)
	atnfurlref
def	f1sd = set_spin_down(p1_I, assoc, f0, f1)
	sdlim = spin_down_limit(f0, f1sd, dist)
	jointonly = cp.getboolean("general", "joint_only")
	harmonics = ast.literal_eval(cp.get("general", "harmonics"))
	modeltype = cp.get("general", "model_type")
	biaxial = cp.getboolean("general", "biaxial")
	with_background = cp.getboolean("general", "with_background")
	backgrounddir
	allposteriors = cp.getboolean("plotting", "all_posteriors")
	subtracttruths = cp.getboolean("plotting", "subtract_truths")
	showcontours = cp.getboolean("plotting", "show_contours")
list	figformat = ["png"]
	witheps = cp.getboolean("plotting", "eps_output")
	withpdf = cp.getboolean("plotting", "pdf_output")
list	ifos = []
bool	withjoint = False
	preprocdat = None
	datatable = None
	postfiles = ast.literal_eval(cp.get("parameter_estimation", "posteriors"))
	ifo
	linktable = htmltag("div", tagstyle="text-align: left; float: left")
	linkstable = htmltable()
dictionary	htmlinput = {}
string	titlename = "INJ " + pname
	linktext
def	psrtable = create_psr_table(par)
	postinfo
	ul
	title
	allparams
	dataclass
	bginfo
	text
	figformats
	indexlink
	indexlinktxt = indexlink.text
	cssfile = os.path.join(outdir, "resultspage.css")
	now = datetime.datetime.now()
	htmlfile = os.path.join(outdir, pname + ".html")
	indent

Function Documentation

set_spin_down()

def lalpulsar_knope_result_page.set_spin_down	(		p1_I,
			assoc,
			f0,
			f1,
			n = 5.0
	)

Set the spin-down of the source based on the intrinsic period derivative (p1_I) corrected for any proper motion/ globular cluster acceleration if available, or if not give AND the pulsar is in a globular cluster base the spin-down on assuming an age of 10^9 years (defaulting to the source being a gravitar, with n=5).

Otherwise just return the unadjusted spin-down.

Definition at line 191 of file lalpulsar_knope_result_page.py.

create_psr_table()

def lalpulsar_knope_result_page.create_psr_table

(

par

)

Create a html table of some information from the pulsar parameter file.

Definition at line 207 of file lalpulsar_knope_result_page.py.

Variable Documentation

file

lalpulsar_knope_result_page.file

Definition at line 69 of file lalpulsar_knope_result_page.py.

htmlpage

string lalpulsar_knope_result_page.htmlpage

Definition at line 74 of file lalpulsar_knope_result_page.py.

description

string lalpulsar_knope_result_page.description = """This script will create a results page for a single pulsar from the known pulsar analysis pipeline. A configuration (.ini) file is required."""

Definition at line 2340 of file lalpulsar_knope_result_page.py.

epilog

string lalpulsar_knope_result_page.epilog

Definition at line 2341 of file lalpulsar_knope_result_page.py.

parser

lalpulsar_knope_result_page.parser

Initial value:

=  argparse.ArgumentParser(
        description=description,
        epilog=epilog,
        formatter_class=argparse.RawDescriptionHelpFormatter,
    )

Definition at line 2383 of file lalpulsar_knope_result_page.py.

help

lalpulsar_knope_result_page.help

Definition at line 2388 of file lalpulsar_knope_result_page.py.

opts

lalpulsar_knope_result_page.opts = parser.parse_args()

Definition at line 2391 of file lalpulsar_knope_result_page.py.

inifile

lalpulsar_knope_result_page.inifile = opts.inifile

Definition at line 2393 of file lalpulsar_knope_result_page.py.

cp

lalpulsar_knope_result_page.cp = ConfigParser()

Definition at line 2396 of file lalpulsar_knope_result_page.py.

outdir

lalpulsar_knope_result_page.outdir = cp.get("output", "path")

Definition at line 2407 of file lalpulsar_knope_result_page.py.

indexpage

lalpulsar_knope_result_page.indexpage = cp.get("output", "indexpage")

Definition at line 2429 of file lalpulsar_knope_result_page.py.

parfile

lalpulsar_knope_result_page.parfile = None

Definition at line 2434 of file lalpulsar_knope_result_page.py.

par

lalpulsar_knope_result_page.par = psr_par(parfile)

Definition at line 2446 of file lalpulsar_knope_result_page.py.

pname

lalpulsar_knope_result_page.pname = par["PSRJ"]

Definition at line 2455 of file lalpulsar_knope_result_page.py.

f0

lalpulsar_knope_result_page.f0 = par["F0"]

Definition at line 2463 of file lalpulsar_knope_result_page.py.

f1

float lalpulsar_knope_result_page.f1 = par["F1"]

Definition at line 2471 of file lalpulsar_knope_result_page.py.

upperlim

int lalpulsar_knope_result_page.upperlim = ast.literval_eval(cp.get("general", "upper_limit"))

Definition at line 2477 of file lalpulsar_knope_result_page.py.

credints

list lalpulsar_knope_result_page.credints = ast.literval_eval(cp.get("general", "credible_interval"))

Definition at line 2483 of file lalpulsar_knope_result_page.py.

injection

tuple lalpulsar_knope_result_page.injection = cp.getboolean("general", "injection")

Definition at line 2489 of file lalpulsar_knope_result_page.py.

usegwphase

bool lalpulsar_knope_result_page.usegwphase = cp.getboolean("general", "use_gw_phase")

Definition at line 2497 of file lalpulsar_knope_result_page.py.

priorfile

lalpulsar_knope_result_page.priorfile = cp.get("general", "priorfile")

Definition at line 2503 of file lalpulsar_knope_result_page.py.

dist

lalpulsar_knope_result_page.dist = None

Definition at line 2508 of file lalpulsar_knope_result_page.py.

atnfurl

tuple lalpulsar_knope_result_page.atnfurl = None

Definition at line 2509 of file lalpulsar_knope_result_page.py.

jsonfile

lalpulsar_knope_result_page.jsonfile = os.path.join(outdir, pname + ".json")

Definition at line 2520 of file lalpulsar_knope_result_page.py.

tryatnf

bool lalpulsar_knope_result_page.tryatnf = True

Definition at line 2521 of file lalpulsar_knope_result_page.py.

fp

lalpulsar_knope_result_page.fp = open(jsonfile, "r")

Definition at line 2524 of file lalpulsar_knope_result_page.py.

info

dictionary lalpulsar_knope_result_page.info = json.load(fp)

Definition at line 2525 of file lalpulsar_knope_result_page.py.

p1_I

lalpulsar_knope_result_page.p1_I = info["Pulsar data"]["P1_I"]

Definition at line 2530 of file lalpulsar_knope_result_page.py.

assoc

lalpulsar_knope_result_page.assoc = info["Pulsar data"]["ASSOC"]

Definition at line 2531 of file lalpulsar_knope_result_page.py.

pinfo

lalpulsar_knope_result_page.pinfo = get_atnf_info(pname)

Definition at line 2540 of file lalpulsar_knope_result_page.py.

atnfurlref

lalpulsar_knope_result_page.atnfurlref

Definition at line 2542 of file lalpulsar_knope_result_page.py.

f1sd

def lalpulsar_knope_result_page.f1sd = set_spin_down(p1_I, assoc, f0, f1)

Definition at line 2549 of file lalpulsar_knope_result_page.py.

sdlim

lalpulsar_knope_result_page.sdlim = spin_down_limit(f0, f1sd, dist)

Definition at line 2553 of file lalpulsar_knope_result_page.py.

jointonly

bool lalpulsar_knope_result_page.jointonly = cp.getboolean("general", "joint_only")

Definition at line 2557 of file lalpulsar_knope_result_page.py.

harmonics

list lalpulsar_knope_result_page.harmonics = ast.literal_eval(cp.get("general", "harmonics"))

Definition at line 2563 of file lalpulsar_knope_result_page.py.

modeltype

string lalpulsar_knope_result_page.modeltype = cp.get("general", "model_type")

Definition at line 2569 of file lalpulsar_knope_result_page.py.

biaxial

bool lalpulsar_knope_result_page.biaxial = cp.getboolean("general", "biaxial")

Definition at line 2580 of file lalpulsar_knope_result_page.py.

with_background

bool lalpulsar_knope_result_page.with_background = cp.getboolean("general", "with_background")

Definition at line 2586 of file lalpulsar_knope_result_page.py.

backgrounddir

lalpulsar_knope_result_page.backgrounddir

Initial value:

=  ast.literal_eval(
                cp.get("parameter_estimation", "background")
            )

Definition at line 2592 of file lalpulsar_knope_result_page.py.

allposteriors

bool lalpulsar_knope_result_page.allposteriors = cp.getboolean("plotting", "all_posteriors")

Definition at line 2600 of file lalpulsar_knope_result_page.py.

subtracttruths

bool lalpulsar_knope_result_page.subtracttruths = cp.getboolean("plotting", "subtract_truths")

Definition at line 2606 of file lalpulsar_knope_result_page.py.

showcontours

bool lalpulsar_knope_result_page.showcontours = cp.getboolean("plotting", "show_contours")

Definition at line 2612 of file lalpulsar_knope_result_page.py.

figformat

list lalpulsar_knope_result_page.figformat = ["png"]

Definition at line 2616 of file lalpulsar_knope_result_page.py.

witheps

bool lalpulsar_knope_result_page.witheps = cp.getboolean("plotting", "eps_output")

Definition at line 2619 of file lalpulsar_knope_result_page.py.

withpdf

bool lalpulsar_knope_result_page.withpdf = cp.getboolean("plotting", "pdf_output")

Definition at line 2628 of file lalpulsar_knope_result_page.py.

ifos

lalpulsar_knope_result_page.ifos = []

Definition at line 2636 of file lalpulsar_knope_result_page.py.

withjoint

bool lalpulsar_knope_result_page.withjoint = False

Definition at line 2637 of file lalpulsar_knope_result_page.py.

preprocdat

lalpulsar_knope_result_page.preprocdat = None

Definition at line 2638 of file lalpulsar_knope_result_page.py.

datatable

lalpulsar_knope_result_page.datatable = None

Definition at line 2639 of file lalpulsar_knope_result_page.py.

postfiles

lalpulsar_knope_result_page.postfiles = ast.literal_eval(cp.get("parameter_estimation", "posteriors"))

Definition at line 2708 of file lalpulsar_knope_result_page.py.

ifo

lalpulsar_knope_result_page.ifo

Definition at line 2726 of file lalpulsar_knope_result_page.py.

linktable

lalpulsar_knope_result_page.linktable = htmltag("div", tagstyle="text-align: left; float: left")

Definition at line 2739 of file lalpulsar_knope_result_page.py.

linkstable

lalpulsar_knope_result_page.linkstable = htmltable()

Definition at line 2740 of file lalpulsar_knope_result_page.py.

htmlinput

dictionary lalpulsar_knope_result_page.htmlinput = {}

Definition at line 2744 of file lalpulsar_knope_result_page.py.

titlename

string lalpulsar_knope_result_page.titlename = "INJ " + pname

Definition at line 2749 of file lalpulsar_knope_result_page.py.

linktext

lalpulsar_knope_result_page.linktext

Definition at line 2753 of file lalpulsar_knope_result_page.py.

psrtable

def lalpulsar_knope_result_page.psrtable = create_psr_table(par)

Definition at line 2758 of file lalpulsar_knope_result_page.py.

postinfo

lalpulsar_knope_result_page.postinfo

Initial value:

=  posteriors(
        postfiles,
        outdir,
        ifos=ifos,
        harmonics=harmonics,
        modeltype=modeltype,
        biaxial=biaxial,
        parfile=parfile,
        usegwphase=usegwphase,
        subtracttruths=subtracttruths,
        priorfile=priorfile,
        showcontours=showcontours,
    )

Definition at line 2762 of file lalpulsar_knope_result_page.py.

ul

lalpulsar_knope_result_page.ul

Definition at line 2778 of file lalpulsar_knope_result_page.py.

title

lalpulsar_knope_result_page.title

Definition at line 2782 of file lalpulsar_knope_result_page.py.

allparams

lalpulsar_knope_result_page.allparams

Definition at line 2786 of file lalpulsar_knope_result_page.py.

dataclass

lalpulsar_knope_result_page.dataclass

Definition at line 2793 of file lalpulsar_knope_result_page.py.

bginfo

lalpulsar_knope_result_page.bginfo

Initial value:

=  create_background(
            backgrounddir,
            postinfo.snrs,
            postinfo.bsn,
            outdir,
            Bci=postinfo.bci,
            Bcin=postinfo.bcin,
        )

Definition at line 2803 of file lalpulsar_knope_result_page.py.

text

lalpulsar_knope_result_page.text

Definition at line 2815 of file lalpulsar_knope_result_page.py.

figformats

lalpulsar_knope_result_page.figformats

Definition at line 2829 of file lalpulsar_knope_result_page.py.

indexlink

lalpulsar_knope_result_page.indexlink

Initial value:

=  htmltag(
            "div", tagstyle="text-align: left; float: right; padding-right: 8px"
        )

Definition at line 2843 of file lalpulsar_knope_result_page.py.

indexlinktxt

string lalpulsar_knope_result_page.indexlinktxt = indexlink.text

Definition at line 2847 of file lalpulsar_knope_result_page.py.

cssfile

lalpulsar_knope_result_page.cssfile = os.path.join(outdir, "resultspage.css")

Definition at line 2854 of file lalpulsar_knope_result_page.py.

now

lalpulsar_knope_result_page.now = datetime.datetime.now()

Definition at line 2862 of file lalpulsar_knope_result_page.py.

htmlfile

lalpulsar_knope_result_page.htmlfile = os.path.join(outdir, pname + ".html")

Definition at line 2871 of file lalpulsar_knope_result_page.py.

indent

lalpulsar_knope_result_page.indent

Definition at line 2974 of file lalpulsar_knope_result_page.py.