get_analysis

Synopsis

Return the current units setting for a PHA data set

get_analysis( [id] )

Description

The function get_analysis() returns the units which are being used in the analysis of a Sherpa PHA dataset, by data set ID. The possible return values are channel, wavelength, and energy:

'channel' or 'chan' or 'bin'

'energy' or 'ener'

'wavelength' or 'wave'

The units of a data set may be changed with set_analysis().

Arguments:

• id - the id of the dataset to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")

Example 1

sherpa> get_analysis()

When get_analysis() is called with no arguments, a string identifying the units setting of the default dataset is returned.

sherpa> get_analysis()
           'channel'

Example 2

sherpa> get_analysis(3)

Here, a string identifying the units setting of data set 3 is returned.

sherpa> get_analysis(3)
           'energy'

Example 3

sherpa> get_analysis("SgrA")

The string identifying the units used in the analysis of a data set with string ID "SgrA" is returned.

sherpa> get_analysis("SgrA")
           'wavelength'

Bugs

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

See Also

confidence

get_conf, get_covar, get_int_proj, get_int_unc, get_proj, get_reg_proj, get_reg_unc

contrib

get_chart_spectrum

data

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_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror

filtering

get_filter

fitting

calc_stat_info, get_fit, get_stat_info

info

get_default_id, list_stats

methods

get_draws, get_iter_method_name, get_iter_method_opt, get_method

modeling

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

psfs

get_kernel, get_psf

statistics

get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat

utilities

get_rate

visualization

get_ratio, get_resid, image_getregion