Synopsis
Return the dimensions of the data set.
Syntax
get_dims(id=None, filter=False)
Examples
Example 1
Display the dimensions for the default data set:
>>> print(get_dims())
Example 2
Find the number of bins in dataset 'a2543' without and with any filters applied to it:
>>> nall = get_dims('a2543')
>>> nfilt = get_dims('a2543', filter=True)PARAMETERS
The parameters for this function are:
| Parameter | Type information | Definition |
|---|---|---|
| id | int, str, or None, optional | The data set. If not given then the default identifier is used, as returned by `get_default_id` . |
| filter | bool, optional | If True then apply any filter to the data set before returning the dimensions. The default is False . |
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- confidence
- get_conf, get_conf_results, get_covar, get_covar_opt, get_covar_results, get_covariance_results, get_int_proj, get_int_unc, get_proj, get_proj_opt, get_proj_results, get_projection_results, get_reg_proj, get_reg_unc
- contrib
- get_chart_spectrum, get_marx_spectrum
- data
- copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_scale, get_bkg_source, get_bkg_source_plot, get_coord, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, load_ascii, load_data, load_grouping, load_quality, set_data, set_quality, ungroup, unpack_ascii, unpack_data
- filtering
- get_filter, load_filter, set_filter
- fitting
- calc_stat_info, get_stat_info
- info
- get_default_id, list_data_ids, list_response_ids, list_stats
- methods
- get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
- modeling
- clean, get_model, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_response, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, image_source
- plotting
- get_split_plot, plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
- psfs
- get_psf, get_psf_contour, get_psf_image, get_psf_plot
- saving
- save_error, save_filter, save_grouping, save_quality, save_staterror, save_syserror
- statistics
- get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
- utilities
- calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_analysis, get_rate
- visualization
- contour, contour_data, contour_ratio, histogram1d, histogram2d, image_data, image_getregion, rebin