pypeit.dashboard.inspect module

Build the command lines that launch PypeIt’s existing inspection tools for a calibration step (Qt-free, so it is unit-testable without a display).

The dashboard does not embed plots; it launches the existing CLI tools (pypeit_chk_* / pypeit_view_fits) as subprocesses. Those scripts have non-uniform signatures, so this module exposes per-step command builders rather than a flat map:

  • bias / dark / arc / tiltimg — processed calibration images, opened directly in ``ginga`` (these already-oriented PypeIt FITS do not display correctly through pypeit_view_fits).

  • slits — pypeit_chk_edges <Edges_*> (the Edges file, not the slits step’s Slits_* output).

  • wv_calib / tilts / flats / align — a single output file with the matching pypeit_chk_* tool.

  • scattlight — pypeit_chk_scattlight <ScatteredLight_*> <Slits_*> --det.

This module also builds the pypeit_run_to_calibstep argv used by the Calibrations view’s (Re)Build control, and the science-product viewer / pypeit_reduce_by_step / run_pypeit argv used by the Science view.

Each builder takes the DashboardModel (for the Calibrations/ directory, the spectrograph, and file resolution) and returns an argv list, or None if the command cannot be built.

pypeit.dashboard.inspect._det_run_arg(det)[source]

Format a detector/mosaic for pypeit_run_to_calibstep --det, which parses its value with pypeit.core.parse.eval_detectors(): a single integer ("1") is one detector; a parenthesized tuple ("(1,2)") is a mosaic.

Parameters:

det (int, tuple, list) – Detector (int) or mosaic (tuple/list of ints).

Returns:

The --det argument string.

Return type:

str

pypeit.dashboard.inspect._edges_file(model, group, det)[source]

Path to the Edges_* file, derived from the slits step’s recorded Slits_* output (so it is correct even when calibrations are shared across groups and named *_all_*, as for fixed-format echelle).

Parameters:

  • model (DashboardModel) – The dashboard model.

  • group (int) – Calibration group ID.

  • det (int, tuple, list) – Detector (int) or mosaic (tuple/list).

Returns:

The Edges_* path.

Return type:

pathlib.Path or None

pypeit.dashboard.inspect._slits_output(model, group, det)[source]

Path to the slits step’s Slits_* output, or None.

Parameters:

  • model (DashboardModel) – The dashboard model.

  • group (int) – Calibration group ID.

  • det (int, tuple, list) – Detector (int) or mosaic (tuple/list).

Returns:

The Slits_* output path.

Return type:

pathlib.Path or None

pypeit.dashboard.inspect._spectrograph(model)[source]

Return the spectrograph name for the model, or None.

Parameters:

model (DashboardModel) – The dashboard model.

Returns:

The spectrograph name.

Return type:

str or None

pypeit.dashboard.inspect.output_command(model, step, group, det)[source]

Build the argv to inspect a step’s processed output.

Parameters:

  • model (DashboardModel) – The dashboard model.

  • step (str) – Calibration step name.

  • group (int) – Calibration group ID.

  • det (int, tuple, list) – Detector (int) or mosaic (tuple/list).

Returns:

The command argv, or None if it cannot be built (e.g. no output file / unknown spectrograph / step not viewable).

Return type:

list or None

pypeit.dashboard.inspect.output_target(model, step, group, det)[source]

Return the primary file the “Inspect output” command will open, so the view can enable the control only when that file exists on disk.

Parameters:

  • model (DashboardModel) – The dashboard model.

  • step (str) – Calibration step name.

  • group (int) – Calibration group ID.

  • det (int, tuple, list) – Detector (int) or mosaic (tuple/list).

Returns:

The file that would be opened, or None if there is no viewer for this step.

Return type:

pathlib.Path or None

pypeit.dashboard.inspect.run_command(model, step, group, det)[source]

Build the argv to (re)build a calibration step via the existing pypeit_run_to_calibstep script.

The dashboard always fixes the calibration group and detector (the scope drop-downs), so it passes --calib_group and --det (never the script’s alternative --science_frame form) plus --redux_path so the run writes to the same reduction directory. run_to_calibstep generates the requested step and every step that precedes it, reusing the ones already on disk.

Parameters:

  • model (DashboardModel) – The dashboard model.

  • step (str) – Calibration step name (e.g. wv_calib).

  • group (int) – Calibration group ID.

  • det (int, tuple, list) – Detector (int) or mosaic (tuple/list).

Returns:

The pypeit_run_to_calibstep command argv, or None if the model has no .pypeit file.

Return type:

list or None

pypeit.dashboard.inspect.run_pypeit_command(model)[source]

Build the argv to run the full reduction via run_pypeit -o: process every science/standard frame, overwriting the existing outputs. This is the science analogue of a “build everything” action, distinct from the per-step (Re)Build controls.

Parameters:

model (DashboardModel) – The dashboard model.

Returns:

The run_pypeit command argv (with -o to overwrite and --redux_path to write to the reduction directory), or None if the model has no .pypeit file.

Return type:

list or None

pypeit.dashboard.inspect.science_object_name(spat_pixpos, slitid, det_name)[source]

Reconstruct a 1D object’s extension name (SPAT####-SLIT####-DET##), matching the format written by pypeit.specobj.SpecObj.set_name(), so pypeit_show_1dspec can be pointed at a specific object.

Note

pypeit.specobj.SpecObj.set_name() is the authoritative implementation of this format, but it is an instance method that requires a fully populated SpecObj; the dashboard only has the (spatial position, slit, detector) values recorded in the reduction state, so the name is reconstructed here. If a standalone name-construction utility is ever factored out of SpecObj, use it here instead.

Parameters:

  • spat_pixpos (float) – The object’s spatial pixel position.

  • slitid (int) – The slit (SPAT_ID) the object is on.

  • det_name (str) – The detector name (e.g. DET01).

Returns:

The object name, or None if it cannot be built.

Return type:

str or None

pypeit.dashboard.inspect.science_run_command(model, frame, det, step)[source]

Build the argv to (re)build a science step via the existing pypeit_reduce_by_step script.

reduce_by_step takes a raw frame filename (not the combined basename), so the raw frame is taken from the science entry’s recorded raw_files.

Parameters:

  • model (DashboardModel) – The dashboard model.

  • frame (str) – The science exposure basename (table key).

  • det (int, tuple, list) – Detector (int) or mosaic (tuple/list).

  • step (str) – One of process / findobj / extract.

Returns:

The pypeit_reduce_by_step command argv, or None if the model has no .pypeit file or no raw frame is known.

Return type:

list or None

pypeit.dashboard.inspect.spec1d_command(spec1d_file, obj_name=None)[source]

Build the argv to view a science 1D spectrum (pypeit_show_1dspec <spec1d> [--obj <name>]). The user picks an object; pass its reconstructed name (see science_object_name()).

Parameters:

  • spec1d_file (str, pathlib.Path) – Path to the spec1d product (or None).

  • obj_name (str, optional) – The object extension name to plot.

Returns:

The command argv, or None if no file.

Return type:

list or None

pypeit.dashboard.inspect.spec2d_command(spec2d_file, det=None)[source]

Build the argv to view a science 2D spectrum (pypeit_show_2dspec <spec2d> [--det]).

Parameters:

  • spec2d_file (str, pathlib.Path) – Path to the spec2d product (or None).

  • det (int, tuple, list, optional) – Detector (int) or mosaic (tuple/list) to show.

Returns:

The command argv, or None if no file.

Return type:

list or None

pypeit.dashboard.inspect.view_input_command(model, input_file, det=None)[source]

Build the argv to view a single input (raw) frame.

Uses pypeit_view_fits --proc so the raw frame is oriented/trimmed and shown properly formatted (not the bare, unoriented FITS).

Parameters:

  • model (DashboardModel) – The dashboard model.

  • input_file (str) – Path to the raw input frame.

  • det (int, tuple, list, optional) – The detector (int) or mosaic (tuple/list) the frame belongs to, passed to --det so the right detector is processed.

Returns:

The pypeit_view_fits command, or None if the spectrograph is unknown.

Return type:

list or None