get_dims

Context: data

Synopsis

Return the length of the x-dimension of a data set

Syntax

get_dims( [id, filter=False] )

The get_dims() function returns the dimensional length of the x-grid of a 1-D data set, by data id. If a data filter has been applied to the data set in question, e.g. ignore() or notice(), the length of either the filtered or unfiltered x-grid may be returned by setting the 'filter' argument to True or False . If set to True , the array returned by get_dims() will be filtered, i.e. the array will be shorter in length than the unfiltered array (not padded with zeros).

id - the id of the data set to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
filter - apply an established data filter to the data set before returning results? default=False

Example 1

sherpa> get_dims()

When called with no arguments, get_dims() returns the length of the x-dimension of the default data set.

sherpa> get_dims()
          (1024,)

Example 2

sherpa> get_dims(3)

If a data set ID is supplied to get_dims(), the unfiltered x-dimension length of the specified data set is returned, unless the 'filter' argument is set to True .

sherpa> notice()
sherpa> get_dims(3)
           (46,)
sherpa> notice(0,6)
sherpa> get_dims(3, filter=True)
           (44,)

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

confidence: get_conf, get_covar, get_int_proj, get_int_unc, get_proj, get_reg_proj, get_reg_unc
contrib: get_chart_spectrum
data: copy_data, dataspace1d, dataspace2d, delete_data, fake, get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_plot, get_bkg_scale, get_coord, get_counts, get_data, get_data_plot, get_dep, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, group, 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_fit, 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
modeling: clean, get_model, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_order_plot, get_par, get_pileup_model, get_response, get_source, get_source_component_image, get_source_component_plot, image_source
plotting: get_split_plot, plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs: get_kernel, get_psf
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
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, get_ratio, get_resid, histogram1d, histogram2d, image_data, image_getregion, rebin