get_filter

Synopsis

Return the filter expression for a data set.

Syntax

get_filter(id=None, format=None, delim=None)

Description

This returns the filter expression, created by one or more calls to `ignore` and `notice` , for the data set.

Examples

Example 1

The default filter is the full dataset, given in the format lowval:hival (for a `Data1D` dataset like this these are inclusive limits):

>>> load_arrays(1, [10, 15, 20, 25], [5, 7, 4, 2])
>>> get_filter()
'10.0000:25.0000'

Example 2

Change the formatting of the output:

>>> get_filter(format="%d", delim="-")
"10-25"

Example 3

The `notice` call restricts the data to the range between 14 and 30. The resulting filter is the combination of this range and the data:

>>> notice(14, 30)
>>> get_filter()
'15.0000:25.0000'

Example 4

Ignoring the point at x=20 means that only the points at x=15 and x=25 remain, so a comma-separated list is used:

>>> ignore(19, 22)
>>> get_filter()
'15.0000,25.0000'

Example 5

The filter equivalent to the per-bin array of filter values:

>>> set_filter([1, 1, 0, 1])
>>> get_filter()
'10.0000:15.0000,25.0000'

Example 6

For an integrated data set (Data1DInt and DataPHA with energy or wavelength units)

>>> load_arrays(1, [10, 15, 20, 25], [15, 20, 23, 30], [5, 7, 4, 2], Data1DInt)
>>> get_filter()
'10.0000:30.0000'

Example 7

For integrated datasets the limits are now inclusive only for the lower limit, but in this the end-point ends within a bin so is is included:

>>> notice(17, 28)
>>> get_filter()
'15.0000:30.0000'

Example 8

There is no data in the range 23 to 24 so the ignore doesn't change anything:

>>> ignore(23, 24)
>>> get_filter()
'15.0000:30.0000'

Example 9

However it does match the range 22 to 23 and so changes the filter:

>>> ignore(22, 23)
>>> get_filter()
'15.0000:20.0000,25:000:30.0000'

Example 10

Return the filter for data set 3:

>>> get_filter(3)

PARAMETERS

The parameters for this function are:

Parameter	Type information	Definition
id	int, str, or None, optional	The identifier for the data set to use. If not given then the default identifier is used, as returned by `get_default_id` .
format	str or None, optional	If set, use this rather than the default format value for the dataset.
delim	str or None, optional	If set, use this rather than the default delim value for the dataset.

Return value

The return value from this function is:

filter -- The empty string or a string expression representing the filter used. For PHA data dets the units are controlled by the analysis setting for the data set.

Changes in CIAO

Changed in CIAO 4.17

The format and delim arguments can now be set.

Changed in CIAO 4.14

The filter expressions have been tweaked for Data1DInt and PHA data sets (when using energy or wavelength units) and now describe the full range of the bins, rather than the mid-points.

Bugs

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