show_filter

Synopsis

Display the filters applied to a dataset

show_filter([id, outfile=None, clobber=False] )

Description

The show_filter command displays the filters which are currently applied to the data.

• id - the id of the dataset to use; default is to show filter information for all available datasets.
• outfile - name of the file in which to store the information
• clobber - a Boolean switch which indicates whether or not the 'outfile' should be overwritten, if the file already exists; default=False

The command output looks like:

Data Set Filter: 1
0.2993-7.0007 Energy (keV)

The behavior of the screen output is determined by the user's $PAGER environment variable setting, which is usually a variant of "more." To disable paging within show_all() - i.e. print the entire contents, even if it scrolls offscreen - change this setting to "cat" before starting Sherpa:

unix% setenv PAGER cat

unix% sherpa

Example 1

sherpa> show_filter()

Print the filter information to the screen for all datasets.

Example 2

sherpa> show_filter(2, "sherpa.filter", True)

Write the filter information for dataset id=2 to the file "sherpa.filter", clobbering any existing file with the same name.

Bugs

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

See Also

data

group

filtering

get_filter, ignore, ignore2d, ignore2d_id, ignore_bad, ignore_id, notice, notice2d, notice2d_id, notice_id

info

list_bkg_ids, list_functions, show_all, show_bkg_model, show_bkg_source, show_conf, show_covar, show_data, show_fit, show_method, show_model, show_proj, show_source, show_stat