pypeit.core.qa module

Module for QA in PypeIt

pypeit.core.qa.close_qa(pypeit_file, qa_path)

Tie off QA under a crash

Parameters:

• pypeit_file (str) – PypeIt file name

• qa_path (str) – Path to QA directory

pypeit.core.qa.gen_exp_html()

Generate the HTML for an Exposure set

pypeit.core.qa.gen_mf_html(pypeit_file, qa_path)

Generate the HTML for QA

Parameters:

• pypeit_file (str) – Name of the PypeIt file, no path

• qa_path (str) – Path to the QA folder

pypeit.core.qa.gen_qa_dir(qa_path)

Make the QA directory if it doesn’t already exist

Parameters:

qa_path (str) – Path to the QA folder

pypeit.core.qa.get_dimen(x, maxp=25)

Assign the plotting dimensions to be the “most square”

Parameters:

• x (int) – An integer that equals the number of panels to be plot

• maxp (int (optional)) – The maximum number of panels to plot on a single page

Return type:

tuple[list, list]

Returns:

• pages (list) – The number of panels in the x and y direction on each page

• npp (list) – The number of panels on each page

pypeit.core.qa.html_end(f, body, links=None)

Fill in the HTML file with a proper ending

Parameters:

• f (io.TextIOWrapper)

• body (str)

• links (str, optional)

Returns:

end – The text written to the end of the HTML file

Return type:

str

pypeit.core.qa.html_exp_pngs(exp_name, det)

Generate HTML for Exposure PNGs

Parameters:

• exp_name (str) – PypeIt-standard exposure name

• det (int) – Detector number

Return type:

tuple[str, str]

Returns:

• links – Links to the individual images

• body – Body HTML for the page showing the images

pypeit.core.qa.html_header(title)

Generate a simple HTML header

Parameters:

title (str) – Title for the header

Returns:

head – An HTML header as a long string

Return type:

str

pypeit.core.qa.html_init(f, title)

Initialize the HTML file

Parameters:

• f (io.TextIOWrapper) – file object to write to

• title (str) – title

Returns:

Initial HTML text incluing the header and links

Return type:

str

pypeit.core.qa.html_mf_pngs(idval)

Generate HTML for QA PNGs

Parameters:

idval (str) – str Key identifier of the calibration set

Returns:

• links – HTML links to the PNGs

• body – HTML edits for the main body

Return type:

tuple

pypeit.core.qa.set_qa_filename(root, method, det=None, slit=None, prefix=None, mode=None, out_dir=None)

Generate the filename for the QA file from the input parameters.

Parameters:

• root (str) – Root name for the output file

• method (str) – Describes the QA routine

• det (str | None) – The name of the detector or mosaic (e.g., DET01)

• slit (int | None) – Name of the slit / order being plotted

• prefix (str | None) – Start the name of the QA file (used for multiple-PNG PCA plots)

• mode (str | None) – Additional differentiating information (e.g., gloabl vs local flexure correction)

• out_dir (str | None) – Path to the QA/ directory

Return type:

str

Returns:

Output filename