pyhrs:docs

PyHRS

The PyHRS package is for the reduction of data from the High Resolution Spectrograph on the Southern African Large Telescope. The goals of the package are to provide tools to be able to produce scientific quality reductions for the the low, medium, and high resolution modes for HRS and to prepare data for more specialized code for the reduction of high stability observations.

The package includes the following classes and functions: - HRSModel - hrsprocess - HRSOrder - hrstools

HRSModel

HRSModel is a class for producing synthetic HRS spectra. HRSModel is based on the PySpectrograph.Spectrograph class. It only includes a simple model based on the instrument confirguration and the spectrograph equation.

hrs_process

hrsprocess includes steps for the basic CCD processing necessary for HRS data. It also includes steps necessary for creating calibration frames.

HRSOrder

HRSOrder is a class descirbe a single order from an HRS image. The order then has different tools for identifying regions, extracting orders, and defining properties of different orders such as wavelengths and calibrations.

hrsextract

hrsextract includes all steps necessary to extract a single, one-dimensional HRS spectrum.

HRStools

HRStools includes generally utilies used across different functions and classes.

Reference/API

pyhrs Module

pyhrs is a package for reducing data from the High Resolution Spectrograph on the Southern African Large Telescope

background(b_arr[, niter]) Determine the background for an array
blue_process(infile[, masterbias, error, ...]) Process a blue frame
calc_weights(x, y, m[, yerr]) Calculate weights for each value based on deviation from best fit model
ccd_process(ccd[, oscan, trim, error, ...]) Perform basic processing on ccd data.
create_masterbias(image_list) Create a master bias frame from a list of images
create_masterflat(image_list[, masterbias]) Create a master flat frame from a list of images
create_orderframe(data, first_order, xc, ...) Create an order frame from from an observation.
fit_order(data, detect_kernal, xc[, order, ...]) Given an array and an overlapping detect_kernal,
fit_wavelength_solution(sol_dict) Determine the best fit solution and re-fit each line with that solution
hrs_process(image_name[, ampsec, oscansec, ...]) Processing required for HRS observations.
iterfit1D(x, y, fitter, model[, yerr, ...]) Iteratively fit a function.
match_lines(xarr, farr, sw, sf, ws[, rw, ...]) Match lines in the spectra with specific wavleengths
ncor(x, y) Calculate the normalized correlation of two arrays
normalize_image(data, func_init, mask[, ...]) Normalize an HRS image.
red_process(infile[, masterbias, error, rdnoise]) Process a blue frame
test([package, test_path, args, plugins, ...]) Run the tests using py.test.
wavelength_calibrate_arc(arc, order_frame, ...) Wavelength calibrate an arc spectrum from HRS
wavelength_calibrate_order(hrs, slines, ...) Wavelength calibration of a single order from the HRS arc spectra
xcross_fit(warr, farr, sw_arr, sf_arr[, dw, nw]) Calculate a zeropoint shift between the observed arc
CCD([name, height, width, xpos, ypos, ...]) Defines a CCD by x and y position, size, and pixel size.
Detector([name, ccd, zpos, xpos, ypos, ...]) A class that describing the Detector.
Grating([name, spacing, order, height, ...]) A class that describing gratings.
HRSModel([grating_name, camera_name, slit, ...]) HRSModel is a class that describes the High Resolution Specotrgraph on SALT
HRSOrder(order[, region, flux, wavelength, ...]) A class describing a single order for a High Resolutoin Spectrograph observation.
Optics([name, diameter, focallength, width, ...]) A class that describing optics.
Slit([name, height, width, zpos, xpos, ...]) A class that describing the slit.
Spectrograph([camang, gratang, grating, ...]) A class describing a spectrograph and functions related to a spectrograph.
SpectrographError Exception Raised for Spectrograph errors

Inheritance diagram of pyhrs.hrsmodel.HRSModel, pyhrs.hrsorder.HRSOrder