Synopsis
Load the quality array from a file and add to a PHA data set.
Syntax
load_quality(id, filename=None, bkg_id=None, *args, **kwargs) id - int or str, optional filename - str bkg_id - int or str, optional colkeys - array of str, optional sep - str, optional comment - str, optional
Description
This function sets the quality column but does not automatically ignore any columns marked as "bad". Use the `ignore_bad` function to apply the new quality information.
Examples
Example 1
When using Crates as the I/O library, select the quality column from the file 'src.pi', and use it to set the values in the default data set:
>>> load_quality('src.pi[cols quality]')Example 2
Use the colkeys option to define the column in the input file:
>>> load_quality('src.pi', colkeys=['quality'])Example 3
Load the first column in 'grp.dat' and use it to populate the quality array of the data set called 'core'.
>>> load_quality('core', 'grp.dat')PARAMETERS
The parameters for this function are:
| Parameter | Definition |
|---|---|
| id | The identifier for the data set to use. If not given then the default identifier is used, as returned by `get_default_id` . |
| filename | The name of the file that contains the quality information. This file can be a FITS table or an ASCII file. Selection of the relevant column depends on the I/O library in use (Crates or AstroPy). |
| bkg_id | Set if the quality array should be associated with the background associated with the data set. |
| colkeys | An array of the column name to read in. The default is none . |
| sep | The separator character. The default is ' ' . |
| comment | The comment character. The default is '#' . |
Notes
The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with a single un-named argument, it is taken to be the `filename` parameter. If given two un-named arguments, then they are interpreted as the `id` and `filename` parameters, respectively. The remaining parameters are expected to be given as named arguments.
There is no check made to see if the quality array contains valid data.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- data
- copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_axes, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_source_plot, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_dims, get_error, get_quality, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, load_arf, load_arrays, load_ascii, load_bkg, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, load_image, load_multi_arfs, load_multi_rmfs, load_pha, load_rmf, load_staterror, load_syserror, load_table, pack_image, pack_pha, pack_table, set_data, set_quality, ungroup, unpack_arf, unpack_arrays, unpack_ascii, unpack_bkg, unpack_data, unpack_image, unpack_pha, unpack_rmf, unpack_table
- filtering
- get_filter, load_filter, set_filter
- info
- get_default_id, list_bkg_ids, list_data_ids, list_response_ids
- modeling
- add_model, add_user_pars, clean, load_table_model, load_template_interpolator, load_template_model, load_user_model, save_model, save_source
- plotting
- plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
- saving
- save_arrays, save_data, save_delchi, save_error, save_filter, save_grouping, save_image, save_pha, save_quality, save_resid, save_staterror, save_syserror, save_table
- statistics
- load_user_stat
- utilities
- calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_rate
- visualization
- contour, contour_data, contour_ratio, histogram1d, histogram2d, image_data, rebin