RSSMOSPipeline Commands

The RSSMOSPipeline package includes a number of command-line programs, each of which is described below.

rss_mos_reducer

rss_mos_reducer reduces SALT RSS data taken in either longslit or multi-object spectroscopy (MOS) modes to extracted, sky subtracted spectra.

usage: rss_mos_reducer [-h] [-t THRESHOLD] [-T LONGSLITTHRESHOLD] [-i]
                       [-f SUBFRAC] [-e EXCLUDEMASKS] [-s EXTENSIONSLIST] [-S]
                       [-F SLITFILENAME] [-n] [-m MODELARCSDIR] [-v]
                       rawDir reducedDir maskName

Positional Arguments

rawDir

The directory that holds the partially-processed data. Usually called product.

reducedDir

The directory where the reduced data will be written, along with any diagnostic data. This directory will be created if it doesn’t already exist.

maskName

Use ‘all’ to reduce all data found under rawDir/, or ‘list’ to list all masks (by object) found under rawDir/. The maskName is made from the keyword combination OBJECT_MASKID found in the .fits headers.

Named Arguments

-t, --threshold

Threshold used for the MOS slit finding algorithm - check that all slits are being found using e.g. masterflat_0.fits and the .reg files produced by the pipeline. Values in the range 0.1-0.4 work best (default=0.1; increase this value if some slits are getting divided; decrease if slits missing). This option only applies to MOS masks.

Default: 0.1

-T, --longslit-threshold

Threshold used for the longslit pseudo-slit finding algorithm, in sigma (i.e., for detecting object traces).

Default: 2.0

-i, --iterative-extraction

Use the iterative spectral extraction method.

Default: False

-f, --skysub-fraction

Fraction of the sky background to be subtracted in each iteration of the iterative spectral extraction algorithm (default=0.8; increase this value for faster convergence). This only has an effect if the -i switch is also used.

Default: 0.8

-e, --exclude-masks

Names of masks to exclude (if using maskName = ‘all’). Separate mask names with , but no spaces (e.g., -e M1,M2). Useful for avoiding inclusion of e.g., standard stars.

Default: ''

-s, --slits

Reduce the data corresponding to the given slit names only. Separate slit names with , but no spaces (e.g., -s SLIT9,SLIT15).

Default: 'all'

-S, --skip-done

Skip previously processed masks, for which output already exists.

Default: False

-F, --slit-file

Specifies a plain text file from which to read slit locations instead of autmatically finding them (3 column format, where the first line must be the heading: ‘slitno ystart yend’, subsequent lines give slit number and rows defining the slit e.g., ‘10 988 1026’).

-n, --no-flat

If no flats, skips flag fielding. Likely will need to be run with -F.

Default: False

-m, --model-arcs-dir

If given, look in this directory for wavelength calibration model arc spectra, in addition to the default built-in location.

-v, --version

show program’s version number and exit

rss_mos_create_arc_model

rss_mos_create_arc_model is a tool for creating reference models for wavelength calibration from arc spectra.

usage: rss_mos_create_arc_model [-h] [-y YROW] [-v] arcFileName

Positional Arguments

arcFileName

Path to 2d arc file name

Named Arguments

-y, --y

row from which to extract arc spectrum

-v, --version

show program’s version number and exit

rss_mos_inspect_arc_model

rss_mos_inspect_arc_model is a tool for inspecting reference models used for wavelength calibration from arc spectra.

usage: rss_mos_inspect_arc_model [-h] [-v] refModelFileName

Positional Arguments

refModelFileName

The name of the RefModel_*.pickle file to inspect.

Named Arguments

-v, --version

show program’s version number and exit