sherlockpipe.observation_plan.observation_report.ObservationReport

class sherlockpipe.observation_plan.observation_report.ObservationReport(df_observatories, df, alert_date, object_id, name, working_path, ra, dec, t0, t0_low_err, t0_up_err, period, period_low_err, period_up_err, duration, duration_low_err, duration_up_err, depth, depth_low_err, depth_up_err, observable, min_dist, max_dist, min_altitude, max_days, v, j, h, k)

Bases: object

Used to create a pdf file from the parameters and images generated in the plan stage.

__init__(df_observatories, df, alert_date, object_id, name, working_path, ra, dec, t0, t0_low_err, t0_up_err, period, period_low_err, period_up_err, duration, duration_low_err, duration_up_err, depth, depth_low_err, depth_up_err, observable, min_dist, max_dist, min_altitude, max_days, v, j, h, k)

Methods

__init__(df_observatories, df, alert_date, ...)

create_footer(canvas, doc)

Initializes the common footer for all the pages

create_header(canvas, doc)

Initializes the common header for all the pages.

create_report()

Creates the final report with all the star parameters, the candidate information and the observation nights data, storing it in a pdf.

df_manipulations()

Performs changes of data from the initial dataframe for better formatting in the report.

row_colors(df, table_object)

Attributes

ALERT_IMAGE

LOGO_IMAGE

Initializes the common footer for all the pages

Parameters:

  • canvas – the report canvas

  • doc – the report document

create_header(canvas, doc)

Initializes the common header for all the pages.

Parameters:

  • canvas – the report canvas

  • doc – the report document

create_report()

Creates the final report with all the star parameters, the candidate information and the observation nights data, storing it in a pdf.

df_manipulations()

Performs changes of data from the initial dataframe for better formatting in the report.

Returns:

the final dataframe