XMM-Newton Science Analysis System


oal (oal-3.126.1) [xmmsas_20160201_1833-15.0.0]

Meta Index / Home Page / User-visible functionality / Environment variables

SAS_ODF

The OAL functions need to access various constituents in the ODF that is currently being processed. The name of the directory containing the ODF can be passed to the OAL in either of the following two ways:

1. Each task making use of the OAL has an optional command line parameter -odf (short form: -o) whose value is taken as the ODF directory name.

2. The user can specify the name via the environment variable
   
       SAS_ODF
   
   e.g. SAS_ODF=/home/fred/odf1.

The name of the summary file is assumed to end in SUM.SAS or SUM.ASC with the former taking precedence over the latter.

A command line override supersedes any assignment made to SAS_ODF, i.e., the directory pointed at via SAS_ODF is ignored in this case. A fatal error condition is raised if neither SAS_ODF is set nor an ODF is specified on the command line via -odf.

It is also possible to assign directly the name of an ODF summary file to SAS_ODF or the task's -odf parameter. This should be used if a directory contains more than one ODF.

For more information please consult the documentation of package taskmain.