sherlockpipe.single_transits.report.MoriartyReport
- class sherlockpipe.single_transits.report.MoriartyReport(data_dir, object_id, ra, dec, v, j, h, k, candidates_df)
Bases:
objectThis class creates a report for the single transits module of SHERLOCK.
- __init__(data_dir, object_id, ra, dec, v, j, h, k, candidates_df)
Initialize the Moriarty PDF report generator.
Parameters
- data_dirstr
Directory containing the single-transit search results.
- object_idstr
Target identifier.
- rafloat
Right ascension in degrees.
- decfloat
Declination in degrees.
- vfloat
V-band magnitude.
- jfloat
J-band magnitude.
- hfloat
H-band magnitude.
- kfloat
K-band magnitude.
- candidates_dfpandas.DataFrame
DataFrame of known SHERLOCK candidates for context.
Methods
__init__(data_dir, object_id, ra, dec, v, j, ...)Initialize the Moriarty PDF report generator.
create_footer(canvas, doc)Draw the page footer with page number and attribution for the PDF report.
create_header(canvas, doc)Draw the page header with logo, title, and date for the PDF report.
Build the Moriarty single-transit search PDF report.
is_float(element)Check whether a value can be converted to a float.
row_colors(df, table_object)Apply alternating row colors to a ReportLab table.
Attributes
CANDIDATE_COLORSLOGO_IMAGEDraw the page footer with page number and attribution for the PDF report.
Parameters
- canvasreportlab.pdfgen.canvas.Canvas
ReportLab canvas to draw on.
- docreportlab.platypus.BaseDocTemplate
The document template.
- create_header(canvas, doc)
Draw the page header with logo, title, and date for the PDF report.
Parameters
- canvasreportlab.pdfgen.canvas.Canvas
ReportLab canvas to draw on.
- docreportlab.platypus.BaseDocTemplate
The document template.
- create_report()
Build the Moriarty single-transit search PDF report.
Reads fit results and diagnostic plots from the data directory, compiles tables of parameters and figures, and outputs the final PDF document.