API Index

specreduce Package

Functions

test(**kwargs)

Run the tests for the package.

Classes

SpecreduceOperation()	An operation to perform as part of a spectroscopic reduction pipeline.
WavelengthCalibration1D(input_spectrum[, ...])	input_spectrum: Spectrum1D

specreduce.core Module

Classes

SpecreduceOperation()

An operation to perform as part of a spectroscopic reduction pipeline.

specreduce.utils.synth_data Module

Functions

make_2d_trace_image([nx, ny, background, ...])	Create synthetic 2D spectroscopic image with a single source.
make_2d_arc_image([nx, ny, wcs, extent, ...])	Create synthetic 2D spectroscopic image of reference emission lines, e.g. a calibration arc lamp.

specreduce.tracing Module

Classes

Trace(image)	Basic tracing class that by default traces the middle of the image.
FlatTrace(image, trace_pos)	Trace that is constant along the axis being traced.
ArrayTrace(image, trace)	Define a trace given an array of trace positions.
FitTrace(image, bins, guess, window, ...)	Trace the spectrum aperture in an image.

specreduce.background Module

Classes

Background(image, traces, width, statistic, ...)

Determine the background from an image for subtraction.

specreduce.extract Module

Classes

BoxcarExtract(image, trace_object[, width, ...])	Does a standard boxcar extraction.
HorneExtract(image, trace_object, ...)	Perform a Horne (a.k.a.
OptimalExtract(image, trace_object, ...)	An alias for HorneExtract.

specreduce.calibration_data Module

Utilities for defining, loading, and handling spectroscopic calibration data

Functions

get_reference_file_path([path, cache, ...])	Utility to load reference data via GitHub raw user content.
get_pypeit_data_path([path, cache, ...])	Convenience utility to facilitate access to pypeit reference data.
load_pypeit_calibration_lines([lamps, ...])	Load reference calibration lines from pypeit linelists.
load_MAST_calspec(filename[, cache, ...])	Load a standard star spectrum from the calspec database at MAST.
load_onedstds([dataset, specfile, cache, ...])	This is a convenience function for loading a standard star spectrum from the 'onedstds' dataset in the specreduce_data package.

Classes

AtmosphericExtinction([model, extinction, ...])	Spectrum container for atmospheric extinction in magnitudes as a function of wavelength.
AtmosphericTransmission([data_file, wave_unit])	Spectrum container for atmospheric transmission as a function of wavelength.