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


cifbuild (cifbuild-4.9) [xmmsas_20210317_1624-19.1.0]

Examples

In reference to the examples below, see also the CAL documentation on how to specify a CIF.

Note: in the following examples we use the Bourne shell syntax to specify environment variables. C shell users should convert that to setenv VARIABLE value.

  1. This are the recommended steps for people who have access to a local collection of CCF constituents:

    1. export SAS_ODF=/path/to/odf_dir[*]

    2. export SAS_CCFPATH=/path/to/ccfstore1:/path/to/ccfstore2

    3. cifbuild

    This creates the file ccf.cif (the default value of calindexset) in the current directory. The CCF constituents are searched among the files in the two directories specified in the environment variable SAS_CCFPATH. The observation date is taken from the active ODF as indicated by the variable SAS_ODF. The analysis date defaults to now (the default value of analysisdate).

    If the usecanonicalname had been set to true, the name of the CIF would have been of the form rrrr_ppppppooll.cif, where rrrr is the revolution number, and ppppppooll is the observation identifier.

  2. This is the recommended mode of operation for those who want to generate a CIF from a MIF. It is not necessary to have access to any of the CCF constituents.

    cifbuild –withmasterindexset=yes –masterindexset=XMM_CALINDEX_0123.CCF

    The CIF is built from the list of CCF constituents specified in XMM_CALINDEX_0123.CCF.

  3. cifbuild –withccfpath=yes
    –ccfpath="/path/to/ccfstore1/:/path/to/ccfstore2"
    –fullpath=yes

    This creates the file ccf.cif (the default value of calindexset) in the current directory. The CCF constituents are searched among the files in the two directories specified with ccfpath. The observation date is taken from the active ODF as indicated by the variable SAS_ODF. The analysis date defaults to now (the default value of analysisdate). The CIF contains the full path to the CCF constituents.

    To use the CIF set the environemnt variable SAS_CCF to be ccf.cif. If you set SAS_CCF to be the absolute path to the CIF, then the latter can be used from any other directory.

  4. cifbuild –withccfpath=yes –ccfpath=/path/to/ccfstore

    The CIF ccf.cif contains the base name of the CCF constituents found in /path/to/ccfstore.

    To use the CIF place it in /path/to/ccfstore and set the environemnt variable SAS_CCF to be /path/to/ccfstore.

  5. cifbuild –withccfpath=yes –ccfpath=/path/to/ccfstore
    –calindexset=/path/to/ccfstore/myobservation.cif

    As in 4, but now the CIF is called myobservation.cif and is written directly to the directory /path/to/ccfstore.

    To use the CIF set the environment variable SAS_CCF to be /path/to/ccfstore/myobservation.cif.

  6. cifbuild –withccfpath=yes
    –ccfpath="/path/to/ccfstore1/:/path/to/ccfstore2"
    –withobservationdate=yes –observationdate="2000-01-13T00:00:00"
    –fullpath=yes

    As in 3, but now the observation date is specified to be Midnight January 13, 2000.

  7. cifbuild –withccfpath=yes –ccfpath="/path/to/ccfstore1/:/path/to/ccfstore2"
    –analysisdate="2000-03-19T00:00:00" –fullpath=yes

    As in 3, but the observation date is taken from the active ODF, but the CIF is built as if the analysis was being performed on March 19, 2000.

  8. cifbuild –calindexset=ccf.cif –category=SCISIMCCF –ccfpath=/path/to/ccfstore/ –withccfpath=yes

    cifbuild –calindexset=ccf.cif –withccfpath=yes –ccfpath=/path/to/ccfstore/ –append=yes

    This builds a CIF that contains constituents of category SCISIMCCF if they exist, otherwise constituents of category XMMCCF are used.

XMM-Newton SOC -- 2021-03-17