Reports

Note

Class and additional functions for making reports with analysis results.

Base Report class

class fast_response.reports.ReportGenerator.ReportGenerator(analysis)

Generate report from a FastResponseAnalysis object

generate_report()

Generate the report! This function does most of the heavy lifting. Starts making the source LaTeX file (named r.tex), queries runs, makes detector status plots, includes all plots for the analysis, makes all tables for analysis parameters, runs, events, etc.

get_report_source()

Find base path of the general report TeX document Looks for the directory location fast_response, returns fast_response/latex/report_general.tex

make_coinc_events_table(f)

Make a table of ontime events, in LaTeX format

Parameters:

f (I/O file object) – Opened file that is being written to

make_new_command(f, name, command)

Define a new command, in LaTeX, for the report

Parameters:

• f (I/O file object) – Opened file that is being written to

• name (str) – Name of the command being defined

• command (str) – Value of the command being defined

make_pdf()

Makes the PDF compiled version of the LaTeX report using pdflatex, and saves to the analysis folder

static ontime_table(query_dict)

Makes a DataFrame of events, queried from IceCube Live

Parameters:

query_dict (dict) – Queried events in a particular time window

Returns:

Event parameters for the given events

Return type:

pandas DataFrame

query_db_runs(time_window)

Queries IceCube Live for the ontime window, plus 8 hours on either side (or as much as possible, if in realtime)

Parameters:

time_window (tuple of astropy.time Time objects) – (start, stop) for the analysis, in mjd

Returns:

table of runs loaded, and status of the runs

Return type:

dict

write_table(file, name, header, table, prefix='')

Write a table in latex format for the generated reports

Parameters:

• file (I/O file object) – Opened file that is being written to

• name (str) – Name of the table

• header (list) – Headers for each column (can be empty if none)

• table (array of tuples) – set of values to put in the table. tuples give individual rows

• prefix (str) – prefix to latex command, if needed (default “”)

Analysis-specific report classes

class fast_response.reports.ReportGenerator.FastResponseReport(analysis)

Generates a general FastResponse Report for a point source. Includes additional plots of the 1D LLH ns scan

generate_report()

Generate the report! This function does most of the heavy lifting. Starts making the source LaTeX file (named r.tex), queries runs, makes detector status plots, includes all plots for the analysis, makes all tables for analysis parameters, runs, events, etc.

class fast_response.reports.ReportGenerator.AlertReport(analysis)

Generates a FastResponse Report for an Alert event.

get_report_source()

Find base path of the general report TeX document. Looks for the directory location fast_response, returns fast_response/latex/report_alert.tex

class fast_response.reports.ReportGenerator.GravitationalWaveReport(analysis)

Generates a FastResponse Report for a GW. Includes additional plot of skymap PDF versus dec, with PS sensitivity overlaid

get_report_source()

Find base path of the general report TeX document. Looks for the directory location fast_response, returns fast_response/latex/report_gw.tex

Additional report functions

fast_response.reports.report_utils.interptime(tstr)

Check time format of a given input

Parameters:

tstr (str) – time value to check. Expects either a unit at the end (allowed units are sec, s, min, hr, mjd, d) or to have an ISO time

Returns:

Formatted time value

Return type:

Time, TimeDelta, or None

fast_response.reports.report_utils.get_times(trig, sta, sto)

Get correctly formatted start, stop, and trigger times

Parameters:

• trig (str) – trigger time, with unit at end, or ISO format

• sta (str) – start time, with unit at end, or ISO format

• sto (str) – stop time, with unit at end, or ISO format

fast_response.reports.report_utils.valid_location(ra, dec)

For a point source, check if location is valid

Parameters:

• ra (float) – Right ascension in radians

• dec (float) – Declination in radians

Returns:

Whether or not the location is valid

Return type:

bool