XMM-Newton SAS Home Page
XMM-Newton Science Analysis System

preferences (preferences-0.8) [xmmsas_20211130_0941-20.0.0]


In the following the notion of SAS task preference parameters is introduced. A preference parameter, like an ordinary task parameter (see documentation of package param) is a string-key/value pair through which the user controls the run time behavior of the task. Unlike the latter however, preference parameters are user-customizable, i.e., their default values can be changed by each user according to his personal preferences.

A list of preference parameters that logically belong together can be put in a preference group with a dedicated name. The name identifies the group and serves as the key of a new group preference. Please note that this is a recursive definition: A preference group is a preference parameter, so groups can contain normal parameters and other groups which in turn can contain other groups and parameters, etc. The level of nesting is a priori unlimited.

XMM-Newton SOC -- 2021-11-30