set_quality

Context: data

Synopsis

Apply user-defined quality flags to a data set

Syntax

set_quality( [id,] val [,bkg_id=None] )

The set_quality command applies a user-defined array of quality flags to a data set, overriding any quality flags contained within the PHA file. An array element set to x >= 1 marks a good channel and an element set to x < 1 marks a bad channel. Bad channels indicated by the quality flags are filtered out using the command ignore_bad. The quality array associated with a data set can be viewed with the get_quality command, and an array of quality flags can be read from a FITS table file or column-based ASCII file and assigned to a data set with the load_quality command. The set_quality and get_quality commands require that the data set in question be a PHA data set.

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")
val - an array defining the quality flag. Must be the same length as the input data set. An element set to x >= 1 marks a good channel and an element set to x < 1 marks a bad channel.
bkg_id - the id of the background, if the quality is to be applied to the background data; default=None

Example 1

sherpa> set_quality([1, 1, 1, 1, 1, 1, 1, -1, -1, 1, 1, 1, 1, 1, 1, -1,
-1, ...] )

The set_quality command is used to apply a user-defined array of quality flags to default data set id=1; the quality array contains as many elements as the data array.

Example 2

sherpa> grpsrc=get_quality(1)
sherpa> set_quality("src", grpsrc)
sherpa> set_quality("src", grpsrc, 1)

Retrieve the quality array of data set 1 and store it to the variable "grpsrc"; apply this quality to the source and background data arrays in the data set named "src".