Variables
string	htmlpage

string	description = """This script will collate results pages from multiple pulsars into a signal table."""

string	epilog

	parser

	help

	opts = parser.parse_args()

	inifile = opts.inifile

	cp = ConfigParser()

	file

	outpath = cp.get("output", "path")

	inpath = cp.get("input", "path")

	sorttype = cp.get("general", "sort_value")

	sortdirection = cp.get("general", "sort_direction")

bool	reverse = False

	ifos = ast.literal_eval(cp.get("general", "detectors"))

list	outputlims

list	outputvals

dictionary	htmlinput = {}

dictionary	latexinput = {}

	resdirs = os.listdir(inpath)

dictionary	resultsdata = {}

list	sourcedirs

	totalsources = len(sourcedirs)

int	cursources = 0

	ld = os.listdir(d)

	jsonfile = None

	fp = open(jsonfile, "r")

	pdata = json.load(fp)

bool	ifopresent = True

list	sortlist

list	sortedlist

	nifos = len(ifos)

int	numprepars = 1 + len(outputvals)

	numlims = len(outputlims)

int	showbci = 0

int	showbcin = 1

	restable = htmltable()

	ltable = latextable(ncolumns=(numprepars + numlims * nifos + showbci + showbcin))

	underline

	dataclass = "leftborder"

	header

	True

	colspan

	multicolumn

	ncolspan = numlims

	datastyle = "border-bottom:1px solid #000"

	ifo

	cr

dictionary	convdict

bool	dagger = False

bool	ddagger = False

dictionary	pulsar = resultsdata[pname]

string	htmlsdtag = ""

string	latexsdtag = ""

dictionary	pn = convdict[prepar]

dictionary	preval = pulsar["Pulsar data"][pn]

string	prevalhtml = "*"

string	prevallatex = "*"

	disphtmlfunc = paramhtmldispfunc.__dict__[prepar]

	displatexfunc = paramlatexdispfunc.__dict__[prepar]

dictionary	ln = convdict[limpar]

string	section = "Upper limits"

dictionary	limval = pulsar[ifo][section][ln]

string	limvalhtml = "*"

string	limvallatex = "*"

dictionary	bn = convdict[bu]

dictionary	bval = pulsar[ifo]["Bayes factors"][bn]

string	bvalhtml = "*"

string	bvallatex = "*"

	htmlfootnotes = htmltag("div", tagclass="footnotes")

	tagtext

	linktext

	cssfile = os.path.join(outpath, "table.css")

	now = datetime.datetime.now()

	htmlfile = os.path.join(outpath, "index.html")

	latexfile = os.path.join(outpath, "resultstable.tex")

Variable Documentation

◆ htmlpage

string lalpulsar_knope_collate_results.htmlpage

Definition at line 53 of file lalpulsar_knope_collate_results.py.

◆ description

string lalpulsar_knope_collate_results.description = """This script will collate results pages from multiple pulsars into a signal table."""

Definition at line 93 of file lalpulsar_knope_collate_results.py.

◆ epilog

string lalpulsar_knope_collate_results.epilog

Initial value:

 =  """An example configuration file could contain the following:
  
 # a section containing output information
 [output]
 path = path_to_output_directory  # the path to the output directory to contain the page [required]
  
 # a section containing input directory information
 [input]
 path = path_to_input_directory   # the path to the directory in which the individual results page directories live [required]
  
 # a section containing general information for the output table
 [general]
 detectors = ['H1', 'L1', 'Joint']   # a list of detctors (including 'Joint') whose results will be output
 sort_value = name                   # the pulsar parameter on which to sort the results (default: 'name') [Allowed: 'name', 'freq', 'ra', 'dec', 'sdlim', 'hul', 'ell', 'sdrat', 'dist']
 sort_direction = ascending          # sort in ascending or decending order (default: 'ascending')
 results = ['h0ul', 'ell']            # a list of result parameters to output (default: ['h0ul'] - the h0 upper limit) [Allowed: 'h0ul', 'ell', 'sdrat', 'q22', 'bsn', 'bci', 'bcin', 'C21ul', 'C22ul']
 parameters = ['f0rot', 'ra', 'dec'] # a list of pulsar parameters to output (default: ['f0rot'] - the pulsar's rotation frequency) [Allowed: 'f0rot', 'f0gw', 'f1rot', 'f1gw', 'sdlim', 'ra', 'dec', 'dist']
 """

Definition at line 94 of file lalpulsar_knope_collate_results.py.

◆ parser

lalpulsar_knope_collate_results.parser

Initial value:

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

Definition at line 113 of file lalpulsar_knope_collate_results.py.

◆ help

lalpulsar_knope_collate_results.help

Definition at line 118 of file lalpulsar_knope_collate_results.py.

◆ opts

lalpulsar_knope_collate_results.opts = parser.parse_args()

Definition at line 121 of file lalpulsar_knope_collate_results.py.

◆ inifile

lalpulsar_knope_collate_results.inifile = opts.inifile

Definition at line 123 of file lalpulsar_knope_collate_results.py.

◆ cp

lalpulsar_knope_collate_results.cp = ConfigParser()

Definition at line 125 of file lalpulsar_knope_collate_results.py.

◆ file

lalpulsar_knope_collate_results.file

Definition at line 130 of file lalpulsar_knope_collate_results.py.

◆ outpath

lalpulsar_knope_collate_results.outpath = cp.get("output", "path")

Definition at line 136 of file lalpulsar_knope_collate_results.py.

◆ inpath

lalpulsar_knope_collate_results.inpath = cp.get("input", "path")

Definition at line 158 of file lalpulsar_knope_collate_results.py.

◆ sorttype

string lalpulsar_knope_collate_results.sorttype = cp.get("general", "sort_value")

Definition at line 172 of file lalpulsar_knope_collate_results.py.

◆ sortdirection

lalpulsar_knope_collate_results.sortdirection = cp.get("general", "sort_direction")

Definition at line 196 of file lalpulsar_knope_collate_results.py.

◆ reverse

bool lalpulsar_knope_collate_results.reverse = False

Definition at line 198 of file lalpulsar_knope_collate_results.py.

◆ ifos

lalpulsar_knope_collate_results.ifos = ast.literal_eval(cp.get("general", "detectors"))

Definition at line 208 of file lalpulsar_knope_collate_results.py.

◆ outputlims

list lalpulsar_knope_collate_results.outputlims

Initial value:

 =  [
             ol.upper() for ol in ast.literal_eval(cp.get("general", "results"))
         ]

Definition at line 215 of file lalpulsar_knope_collate_results.py.

◆ outputvals

list lalpulsar_knope_collate_results.outputvals

Initial value:

 =  [
             ov.upper() for ov in ast.literal_eval(cp.get("general", "parameters"))
         ]

Definition at line 223 of file lalpulsar_knope_collate_results.py.

◆ htmlinput

dictionary lalpulsar_knope_collate_results.htmlinput = {}

Definition at line 230 of file lalpulsar_knope_collate_results.py.

◆ latexinput

dictionary lalpulsar_knope_collate_results.latexinput = {}

Definition at line 231 of file lalpulsar_knope_collate_results.py.

◆ resdirs

lalpulsar_knope_collate_results.resdirs = os.listdir(inpath)

Definition at line 234 of file lalpulsar_knope_collate_results.py.

◆ resultsdata

dictionary lalpulsar_knope_collate_results.resultsdata = {}

Definition at line 242 of file lalpulsar_knope_collate_results.py.

◆ sourcedirs

list lalpulsar_knope_collate_results.sourcedirs

Initial value:

 =  [
         os.path.join(inpath, rd)
         for rd in resdirs
         if os.path.isfile(os.path.join(inpath, rd, "{}.ini".format(rd)))
     ]

Definition at line 243 of file lalpulsar_knope_collate_results.py.

◆ totalsources

lalpulsar_knope_collate_results.totalsources = len(sourcedirs)

Definition at line 248 of file lalpulsar_knope_collate_results.py.

◆ cursources

int lalpulsar_knope_collate_results.cursources = 0

Definition at line 249 of file lalpulsar_knope_collate_results.py.

◆ ld

lalpulsar_knope_collate_results.ld = os.listdir(d)

Definition at line 251 of file lalpulsar_knope_collate_results.py.

◆ jsonfile

lalpulsar_knope_collate_results.jsonfile = None

Definition at line 252 of file lalpulsar_knope_collate_results.py.

◆ fp

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

Definition at line 262 of file lalpulsar_knope_collate_results.py.

◆ pdata

lalpulsar_knope_collate_results.pdata = json.load(fp)

Definition at line 263 of file lalpulsar_knope_collate_results.py.

◆ ifopresent

bool lalpulsar_knope_collate_results.ifopresent = True

Definition at line 289 of file lalpulsar_knope_collate_results.py.

◆ sortlist

list lalpulsar_knope_collate_results.sortlist

Initial value:

 =  [
             (resultsdata[pname]["Pulsar data"]["F0"], pname) for pname in resultsdata
         ]

Definition at line 314 of file lalpulsar_knope_collate_results.py.

◆ sortedlist

list lalpulsar_knope_collate_results.sortedlist

Initial value:

 =  [
         p[1] for p in sorted(sortlist, reverse=reverse)
     ]

Definition at line 368 of file lalpulsar_knope_collate_results.py.

◆ nifos

lalpulsar_knope_collate_results.nifos = len(ifos)

Definition at line 372 of file lalpulsar_knope_collate_results.py.

◆ numprepars

int lalpulsar_knope_collate_results.numprepars = 1 + len(outputvals)

Definition at line 373 of file lalpulsar_knope_collate_results.py.

◆ numlims

lalpulsar_knope_collate_results.numlims = len(outputlims)

Definition at line 374 of file lalpulsar_knope_collate_results.py.

◆ showbci

int lalpulsar_knope_collate_results.showbci = 0

Definition at line 377 of file lalpulsar_knope_collate_results.py.

◆ showbcin

int lalpulsar_knope_collate_results.showbcin = 1

Definition at line 385 of file lalpulsar_knope_collate_results.py.

◆ restable

lalpulsar_knope_collate_results.restable = htmltable()

Definition at line 390 of file lalpulsar_knope_collate_results.py.

◆ ltable

lalpulsar_knope_collate_results.ltable = latextable(ncolumns=(numprepars + numlims * nifos + showbci + showbcin))

Definition at line 391 of file lalpulsar_knope_collate_results.py.

◆ underline

lalpulsar_knope_collate_results.underline

Definition at line 396 of file lalpulsar_knope_collate_results.py.

◆ dataclass

string lalpulsar_knope_collate_results.dataclass = "leftborder"

Definition at line 397 of file lalpulsar_knope_collate_results.py.

◆ header

lalpulsar_knope_collate_results.header

Definition at line 397 of file lalpulsar_knope_collate_results.py.

◆ True

lalpulsar_knope_collate_results.True

Definition at line 397 of file lalpulsar_knope_collate_results.py.

◆ colspan

lalpulsar_knope_collate_results.colspan

Definition at line 397 of file lalpulsar_knope_collate_results.py.

◆ multicolumn

lalpulsar_knope_collate_results.multicolumn

Definition at line 398 of file lalpulsar_knope_collate_results.py.

◆ ncolspan

lalpulsar_knope_collate_results.ncolspan = numlims

Definition at line 400 of file lalpulsar_knope_collate_results.py.

◆ datastyle

string lalpulsar_knope_collate_results.datastyle = "border-bottom:1px solid #000"

Definition at line 407 of file lalpulsar_knope_collate_results.py.

◆ ifo

lalpulsar_knope_collate_results.ifo

Definition at line 410 of file lalpulsar_knope_collate_results.py.

◆ cr

lalpulsar_knope_collate_results.cr

Initial value:

 =  list(resultsdata.values())[0][ifo]["Upper limits"][
                     "credible region"
                 ]

Definition at line 426 of file lalpulsar_knope_collate_results.py.

◆ convdict

dictionary lalpulsar_knope_collate_results.convdict

Initial value:

 =  {
         "RA": "RA",
         "DEC": "DEC",
         "H0UL": "H0",
         "C21UL": "C21",
         "C22UL": "C22",
         "I21UL": "I21",
         "I31UL": "I31",
         "SDLIM": "spin-down limit",
         "SDRAT": "spin-down ratio",
         "BSN": "Signal vs Noise",
         "BCI": "Coherent vs Incoherent",
         "BCIN": "Coherent vs Incoherent or Noise",
     }