| | |
|
a | |
|
avoidregion |
Create AvoidRegions in wavelength space that will not be used
when determining the optimal y-axis plot rangex. |
| | |
|
c | |
|
calc_covering_fraction |
Calculates the ratio of the number of pixels containing plot data
vs. empty (background) plot pixels. |
|
calc_plot_metrics |
Calculates metrics related to a plot, including flux statistics,
avoid regions, and optimal x- and y-axis ranges for plots. |
|
check_segments |
Checks that the array of segment names in the COS FITS extension
table are some combination of allowed values. |
|
cosspectrum |
Class definitions for a COS Spectrum object. |
| | |
|
d | |
|
debug_oplot |
Plots spectral data points color-coded based on a suite of
rejection criteria, primarily for debugging purposes. |
|
dq_has_flag |
Utility function that returns True if a given Data Quality bitmask
contains a specific flag. |
| | |
|
e | |
|
edge_trim |
Returns the start and end indices of a spectrum that represent the
`best` wavelengths to use when defining the optimal plot axis ranges. |
|
extract_subspec |
Extracts a sub-spectrum from the provided COS spectrum object.
Modifies the COS spectrum object to replace that segment's spectrum with
the specified sub-spectrum. |
| | |
|
g | |
|
get_association_indices |
Determines which indices in the array of STIS associations to
plot in the preview plots. |
|
get_flux_stats |
Calculates statistics on an arrays of fluxes and corresponding
flux uncertainties, such as the median values and the 95th percentile
values. |
|
get_segment_names |
Returns a list of segment names such that the bluest segment
comes first. |
| | |
|
h | |
|
haspspectrum |
Defines the class for HASP spectra. |
| | |
|
i | |
|
is_bad_dq |
Returns True if a given DQ (or array of DQ values) fail(s) a test
defined in this module, otherwise returns False. If an array of DQ
values was given, then an array of True/False values is returned for each
element in the array, otherwise a single True/False value is returned. |
| | |
|
j | |
|
jwstspectrum |
Class definitions for a JWST Spectrum object. |
| | |
|
m | |
|
make_hst_spec_previews |
Given an HST spectrum file name, this script will read in the
data and generate preview plots of the spectra. The plots are generated
in different dimensions (large, thumbnail) and, depending on the
instrument / configuration, are plotted in different formats to maximize
readability and usability. |
|
make_html |
Creates a webpage of thumbnail and full-size previews for review
purposes. |
|
make_jwst_spec_previews |
Given a JWST spectrum file name, this script will read in the
data and generate preview plots of the spectra. The plots are generated
in different dimensions (large, thumbnail) and, depending on the
instrument / configuration, are plotted in different formats to maximize
readability and usability. |
| | |
|
r | |
|
rms |
Calculates the root-mean-square of an array of input values.
Optionally, a constant offset value can be subtracted before calculating
the rms. |
| | |
|
s | |
|
set_plot_xrange |
Determines the optimal x-axis plot range, in wavelength space. |
|
set_plot_yrange |
Determines the optimal y-axis plot range. |
|
specutilserror |
Defines a custom Error class for use with spec_plots utility
functions. |
|
stis1dspectrum |
Defines the class for STIS 1D spectra. |
|
stitch_components |
Given a COS or STIS spectrum, will stitch each segment/order,
respectively, into a contiguous array. Does not handle any overlap in
wavelength between sections. |
| | |
|
u | |
 |
utils |
|
|
utils.specutils_cos.check_segments |
|
|
utils.specutils_cos.cosspectrum |
|
|
utils.specutils_cos.extract_subspec |
|
|
utils.specutils_cos.get_segment_names |
|
|
utils.specutils_hasp.haspspectrum |
|
|
utils.specutils_jwst.jwstspectrum |
|
|
utils.specutils_stis.get_association_indices |
|
|
utils.specutils_stis.stis1dspectrum |
|