Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/unpack_data.html
Jump to: Description · Example · PARAMETERS · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

unpack_data

Context: data

Synopsis

Create a sherpa data object from a file.

Syntax

unpack_data(filename, *args, **kwargs)

Description

The object returned by `unpack_data` can be used in a `set_data` call. The data types supported are those supported by `unpack_pha` , `unpack_image` , `unpack_table` , and `unpack_ascii` .


Example

Create a data object from the contents of the file "src.dat" and use it to create a Sherpa data set called "src":

>>> dat = unpack_data('src.dat')
>>> set_data('src', dat)

PARAMETERS

The parameters for this function are:

Parameter Definition
filename A file name or a data structure representing the data to use, as used by the I/O backend in use by Sherpa: e.g. a phacratedataset , tablecrate , or imagecrate for crates, as used by CIAO, or a list of AstroPy HDU objects.
args The arguments supported by `unpack_pha` , `unpack_image` , `unpack_table` , and `unpack_ascii` .
kwargs The keyword arguments supported by `unpack_pha` , `unpack_image` , `unpack_table` , and `unpack_ascii` .

Return value

The return value from this function is:

The data set object.


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_quality, 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_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