get_filter

Synopsis

Return the filter of a data set

get_filter( [id] )

Description

The get_filter() function returns the filter expression of a data set resulting from the application of the ignore() or notice() filter functions. In other words, this function returns the range of data being considered in the analysis of a specified data set, by data id.

• 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")

Example 1

sherpa> get_filter()

When called with no arguments, get_filter() returns the filter expression of the default data set.

sherpa> get_filter()
           '0.010950000258:14.943099975586'

Example 2

sherpa> get_filter(3)

If supplied with a data set ID, get_filter() returns the range of data included in the analysis of the specified data set.

sherpa> ignore(10.0,15.0)
sherpa> get_filter(3)
          '0.010950000258:9.979099750519'

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

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_dims, 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

ignore, ignore2d, ignore2d_id, ignore_bad, ignore_id, load_filter, notice, notice2d, notice2d_id, notice_id, set_filter, show_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