C. Flow Chart of the Pipeline Processing

Legend
========================================
[ ] critical ftools
( ) user data
" " outputs to trend area
** CALDB access
========================================


=== 0. Common ===

NOTE: The Common processes MUST be executed before HXD and XIS processings.
-----------------------------------------------------------------------------
Attitude file: aeXXXXXXXXX.att

(Attitude file) --> [aeattcor] --> [aeaspect] --> (New attitude file)
                       ^
                       |
        (orbit file) --+
    (common HK file) --'

- The original attitude file is supersedesed by the new one.
  The ae1 script is expected to take care of this.
- This procedure can be carried out multiple time (i.e. loop) safely.
-----------------------------------------------------------------------------
Orbit file: aeXXXXXXXXX.orb

(Orbit file) --> [aeaspect] --> (Orbit file)
                     ^
                     |
           (New attitude file)

- Some header keywords will be filled.
-----------------------------------------------------------------------------



Tim file: aeXXXXXXXXX.tim

(Tim file) --> [aeaspect] --> (Tim file)
                   ^
                   |
         (New attitude file)

- Some header keywords will be filled.
-----------------------------------------------------------------------------
Ehk file: aeXXXXXXXXX.ehk

                  [aemkehk] ----> [aeaspect] --> (Ehk file)
                      ^              ^
                      |              |
       (Orbit file) --+    (New attitude file)
(New attitude file) --'
-----------------------------------------------------------------------------


=== 1. HXD ===

-----------------------------------------------------------------------------
(WEL FFF) -->
[hxdtime] --> [hxdmkgainhist] --> [hxdpi] --> [hxdgrade] --> (WEL UFF)
    **          |    **              **            **
                +--> "aeXXXXXXXXXhxd_0_gso.ghf"
                `--> "aeXXXXXXXXXhxd_0_pin.ghf"
-----------------------------------------------------------------------------
(WAM FFF) -->
 [hxdwamtime] --> [hxdmkwamgainhist] --> [hxdwampi] --> ...continue...
     **            |                         ^  **
                   |                         |
                   +--> "aeXXXXXXXXXhxd_0_wam.ghf"

  ...--> [hxdwamgrade] --> (WAM UFF) ---> [hxdwambstid]
                                            |
                                            `--> "aeXXXXXXXXXhxd_0_bstidt.fits"
-----------------------------------------------------------------------------
(BST FFF) --> [hxdbstid] --> (BST UFF)
                 **
-----------------------------------------------------------------------------
(HXD HK) --> [hxdscltime] --> (HXD HK)
                 **
-----------------------------------------------------------------------------
Note for HXD diagram:
 - Before starting the HXD processing, aemkehk and aeattcor have to be
   run to prepare proper EHK and attitude files.
   (The XIS tools should also require them.)
 - hxdmkgainhist and hxdwambstid extract the data sets that will be
   sent to the trend area after the pipeline.  Their products, i.e.,
       aeXXXXXXXXXhxd_0_pin.ghf, aeXXXXXXXXXhxd_0_gso.ghf and
       aeXXXXXXXXXhxd_0_bstidt.fits
   are not used in the pipeline.
 - On the other hand, aeXXXXXXXXXhxd_0_wam.ghf generated by hxdmkwamgainhist
   will be used by hxdwampi.
 - Pin- and gso-ghf required by hxdpi are retrieved from CALDB.
   Bstidt required by hxdbsttime is also retrieved from CALDB.
-----------------------------------------------------------------------------


=== 2.XIS ===

-----------------------------------------------------------------------------
XIS hk file: aeXXXXXXXXXxiN_0.hk

(XIS hk file) --> [aeaspect] --> (XIS hk file)
                      ^
                      |
            (New attitude file)
-----------------------------------------------------------------------------
XIS frame FFF: aeXXXXXXXXXxiN_n_f[nbp]MMMiNN.fff

(XIS frame FFF) --> [aeaspect] --> [xisucode] --> (XIS frame SFF)
                        ^
                        |
              (New attitude file)
-----------------------------------------------------------------------------
XIS darkframe FFF: aeXXXXXXXXXxiN_n_dfiNN.fff

(XIS darkframe FFF) --> [aeaspect] --> (XIS darkframe SFF)
                            ^
                            |
                  (New attitude file)
-----------------------------------------------------------------------------
XIS darkinit, darkupdate FFF: aeXXXXXXXXXxiN_n_d[iu][nbp]MMM.fff

(XIS darkinit/update FFF) --> [aeaspect] --> [xisucode] --> ...continue...
                                  ^
                                  |
                        (New attitude file)

 ...--> [xiscoord] --> (XIS darkinit/update SFF)
             ^
             |
   (New attitude file)
-----------------------------------------------------------------------------
XIS normal, burst event FFF: aeXXXXXXXXXxiN_n_{5x5,3x3,2x2}[nb]MMM.fff

(XIS event FFF) --> [aeaspect] --> [xisucode] --> [xistime] --> ...continue...
                        ^                            ^         
                        |                            |         
              (New attitude file)               (Tim file) 

 ...--> [xiscoord] --> [xisputpixelquality] --> [xispi] --> (XIS event SFF)
             ^                                     ^         
             |                                     |         
   (New attitude file)                        (XIS hk file) 
-----------------------------------------------------------------------------
XIS psum FFF: aeXXXXXXXXXxiN_n_timpMMM.fff

(XIS psum FFF) --> [aeaspect] --> [xisucode] --> [xistime] --> ...continue...
                        ^                            ^         
                        |                            |         
              (New attitude file)               (Tim file) 

 ... --> [xiscoord] ------> [xispi] --> (XIS psum SFF)
             ^                 ^         
             |                 |         
   (New attitude file)    (XIS hk file) 
-----------------------------------------------------------------------------
XIS telemetry unsaturated GTI file: aeXXXXXXXXXxiN_0_telem.gti

[xisgtigen] --> (temporary_xiN_n_ZZZ[nbp]MMM.gti)
     ^
     |
 (one of XIS event SFF {normal,burst,psum} x {5x5,3x3,2x2,tim} )

     :
     :

[xisgtigen] --> (temporary_xiN_n_ZZZ[nbp]MMM.gti)
     ^
     |
 (one of XIS event SFF {normal,burst,psum} x {5x5,3x3,2x2,tim} )


                                [mgtime] --> (aeXXXXXXXXXxiN_0_telem.gti)
                                   ^
                                   |
(temporary_xiN_n_ZZZ[nbp]MMM.gti) -+
     :                             :
(temporary_xiN_n_ZZZ[nbp]MMM.gti) -+
(temporary_xiN_n_ZZZ[nbp]MMM.gti) -'

- mgtime is operated with "merge=OR".
-----------------------------------------------------------------------------