Data files

This chapter lists the file naming convention and give a brief description of the files that are included within an observation for the HXD and XIS, as well as the files common to all instruments. The different trend data type are also listed.

Filename convention

There are three different conventions for the Suzaku filename depending if the files contains science, auxiliary or log data.The Suzaku FITS science files are named according to the following convention:

aeXXXXXXXXXiii_N_mmmmmmmm_ll.ext.gz

where :

• ae is short for Astro-E2;
• XXXXXXXXX is the observation identifier (sequence number). This is a 9 digit number used in the filename name or in the directory conatining the data;
• iii is a 3 digit number identifing the instrument. This string is as set follows: hxd=HXD xrs=XRS xi0=XIS-0 xi1=XIS-1 xi2=XIS-2 xi3=XIS-3. Files that contains information common to all XIS units have the iii string set to xis.

• N The original telemetry is divided in RPT (Raw Packet Telemetry) files and more than one RPT can contribute to one observation. N ranges from 0-9 where values from 1-9 identify the RPT file number; the value of 0 is used when the science file contains data from different RPT or if there is only one RPT file that contributes to that sequence. Therefore the cleaned event files will always have consistent N value either if they are the merged of several RPT or derived from a single RPT.

• mmmmmmmm is the file identifier. This string can contain up to 8 characters and allows to specify diversities between files from the same instrument. The string does not contain underscor or mathematical symbols.

• ll: is the file level. This is a two character string for FITS and GIF files.
• ext : is the file extension.

The filename for the auxiliary files uses the following convention:

   aeXXXXXXXXX.ext.gz

where XXXXXXXXX is the sequence number. These files are located in the /auxil directory. The filename for the log files uses the following conventions:

  aeXXXXXXXXX_mmmmmmmm.ext.gz
or 
  aeXXXXXXXXXiii_N.ext.gz
or 
  aeXXXXXXXXX.ext.gz

where XXXXXXXXX is the sequence number, mmmmmmmmm is the file identifier, iii is the instrument identifier and N is the RPT number (set to 0 if no RPT distinction is necessary). 'ext ' is the file extension.

Data content within an observation

This section lists the science data files included within the sequences that are archived. The file listing is given below, broken down by directory, together with the specific filenames. This is valid for processing version greater than 1.2. Within this description the [obs-id] is the 9 digit number XXXXXXXXX.

/auxil

The files in this directory are all FITS files.

• File containing the attitude information.
  ae[obs-id].att

• File containing the orbit information.
  ae[obs-id].orb

• File containing the housekeeing parameters.
  ae[obs-id].hk

• File containing entended (additional) housekeeing parameters.
  ae[obs-id].ehk

• Make filter file where the attitude and the instrument housekeeping (HK) paramaters are collected for use during screening.
  ae[obs-id].mkf

• File containing information on the time packet used to make time correction.
  ae[obs-id].tim

• Catalog file listing all the files within the observation.
  ae[obs-id].cat

/log

The files in this directory are all in HTML and ASCII formats.

• File containing a basic description of the observation and links to other information pages.
  ae[obs-id]_hdpage.html

• File containing a list of all files used and created for the observation. Temporary files are not in distribution.
  ae[obs-id]_flinfo.html

• File containing an index to the major processing steps that occur in the processing of the observation.
  ae[obs-id]_index.html

• File containing the errors that occur during the processing.
  ae[obs-id]_errlog.html

• File containing the entire log of the processing.
  ae[obs-id]_joblog.html

• File containing the parameter file for the initial processing (ASCII).
  ae[obs-id]_lv0.par

• File containing the parameter file for the main processing (ASCII).
  ae[obs-id]_lv1.par

• File containing the parameter file for the entire processing (ASCII).
  ae[obs-id]_job.par

• Files containing the logs produced when running the mk1stfits that translate the telemetry into FITS (ASCII).
  ae[obs-id].log
  ae[obs-id]hxd_0.log for the HXD
  ae[obs-id]xi0_0.log for the XIS0
  ae[obs-id]xi1_0.log for the XIS1
  ae[obs-id]xi2_0.log for the XIS2
  ae[obs-id]xi3_0.log for the XIS3
  

• Files containing the commands used to run mk1stfits (ASCII).
  ae[obs-id].com
  ae[obs-id]hxd_0.com for the HXD
  ae[obs-id]xi0_0.com for the XIS0
  ae[obs-id]xi1_0.com for the XIS1
  ae[obs-id]xi2_0.com for the XIS2
  ae[obs-id]xi3_0.com for the XIS3
  

/hxd

The HXD data are divided into four subdirectories, each containing the following files:

/event_uf

• Event files containing data from the WELL. At this stage the GSO and PIN data are within the same file, as well as data taken with different clock rate in the time interval covered by the file. There is one WELL event file for each RPT that comprise the observation. These files are named as
  

  ae[obs-id]hxd_N_wel_uf.evt
  

  where N is the RPT number.

• Event files containing data from the WAM. The number of WAM event files depends on the number of RPT that comprise the observation. These files are named as
  

  ae[obs-id]hxd_N_wam_uf.evt where N is the RPT number.

• GTI files for the WELL. The WELL data can be collected with different clock rate. The WELL GTI file contains the times when the different clock modes are in use. The file contains as many extensions as many clock rates are within an observation up to three (COARSE 122 microsec , NORMAL 61 microsec, anf FINE 31microsec).These files are named as

  ae[obs-id]hxd_N_wel_uf.gti where N is the RPT number.

• GTI files contain the HXD saturated frames. These files are named as

  ae[obs-id]hxd_N_tel_uf.gti where N is the RPT number.

• Event files containing the Burst data from the WAM_ANTI detector

  ae[obs-id]hxd_N_bstZZ_uf.evt where N is the RPT number and ZZ is a number (from 00-99) that identifies the burst within a single RPT.

/event_cl

• Cleaned event files containing data from the PIN WELL. If data are taken with different clock mode, the archive contains one PIN file for different clock rate. At this stage all the events from different RPT with the same clock rate are merged into a single file.

  ae[obs-id]hxd_0_pinXX_cl.evt for clock rtae NORMAL (122 microsec)
  ae[obs-id]hxd_0_pinXX_cl.evt for clock rate CORSE (61 microsec)
  ae[obs-id]hxd_0_pinXX_cl.evt for clock rate FINE (31 microsec)
  

• Cleaned event files containing data from the GSO WELL. If data are taken with different clock mode, the archive contains one GSO file for different clock rate. At this stage all the events from different RPT with the same clock rate are merged into a single file.

  ae[obs-id]hxd_0_gsoXX_cl.evt for clock rtae NORMAL (122 microsec)
  ae[obs-id]hxd_0_gsoXX_cl.evt for clock rate CORSE (61 microsec)
  ae[obs-id]hxd_0_gsoXX_cl.evt for clock rate FINE (31 microsec)
  

• Cleaned pseudo event file. This is obtained merging all the RPTs.

  ae[obs-id]hxd_0_pse_cl.evt
  

/hk

• A file containing specific housekeeping (HK) data for the HXD. The HK data coming from different RPT are all merged in a single file.

  ae[obs-id]hxd_0.hk

• Gain files one for each of the GSO, PIN and WAM detector units. These files are generated during the processing.

  ae[obs-id]hxd_0_pin.ghf for the PIN
  ae[obs-id]hxd_0_gso.ghf for the GSO
  ae[obs-id]hxd_0_wam.ghf for the WAM.

/products

• Two source spectra, one for the PIN and one for the GSO. The spectra are not background substracted. These are collected using all the cleaned events.

  ae[obs-id]hxd_0_pin_sr.pi for the PIN
  ae[obs-id]hxd_0_gso_sr.pi for the GSO

• Two lightcurves, one for the PIN and one for the GSO. The spectra are not background substracted. These are collected using all the cleaned events therefore all the clockmodes are combined

  ae[obs-id]hxd_0_pin_sr.lc for the PIN
  ae[obs-id]hxd_0_gso_sr.lc for the GSO

• One lightcurve from the WAM. All data from all RPTs are combined.

  ae[obs-id]hxd_0_wam.lc for the WAM

• Lightcurve for each burst detected in the WAM_ANTI detector. The filename uses the following convention:
  

  ae[obs-id]hxd_N_bstZZ.lc

  where N is the RPT number and ZZ is a number (from 00-99) that identifies the burst within a single RPT.

• One GIF file containing a plot for the GSO and PIN lightcurves

  ae[obs-id]hxd_0_wel_lc.gif

• One GIF file containing a plot for the GSO and PIN spectra

  ae[obs-id]hxd_0_wel_pi.gif

/xis

The XIS data are divided into four subdirectories, each containing the following files:

/event_uf

• Unfiltered event files containing data from the 4 XIS units. There is one unfiltered event file per XIS unit, edit mode or timing and microcode type. The filename is encoded as follow :

  ae[obs-id]xi0_N_ZZZKKKKC_uf.evt for the XIS0
  ae[obs-id]xi1_N_ZZZKKKKC_uf.evt for the XIS1
  ae[obs-id]xi2_N_ZZZKKKKC_uf.evt for the XIS2
  ae[obs-id]xi3_N_ZZZKKKKC_uf.evt for the XIS3
  

  where N is the RPT number, ZZZ is a string specifying the edit or timing modes (see below), KKKK identifies the microcode and C is reserved to discriminate between different threshold or discriminator. In the unfiltered files the latter is always set to z indicating that the file has not been splitted for the different discriminator or event threshold.
  The strings (ZZZ) for the edit or timing modes are the following:

  • 5x5 if the telemetry includes a 5x5 square pixel around each event
    
  • 3x3 if the telemetry includes a 3x3 square pixel around each event
    
  • 2x2 if the telemetry includes a 2x2 square pixel around each event
    
  • tim for timing mode
    
  The string for the microcode (KKKK) is set in the following way. The first characters depends on the edit or timing mode and the three remaining are numbers to identify a specific configuration. They are therefore set as follows :
  
  • nMMM where n is for the normal window mode for any of the 5x5 or 3x3 or 2x2 edit mode
    
  • bMMM where b is for burst window mode for any of the 5x5 or 3x3 or 2x2 edit mode
    
  • pMMM where p is for psum for the timing mode.
    
  MMM is the unique number associated to the microcode.
  

• GTI files for the XIS. The XIS data can be collected with different threshold and discriminators. The unfiltered files includes events taken in all configurations. These are separated when cleaned events are generated. There is one GTI file per XIS unit and each contains as many extensions as many different configuration are available. They can be used to separate the events. The naming convention used is the following :
  • ae[obs-id]xi0_N_conf_uf.gti for the XIS0
    
  • ae[obs-id]xi1_N_conf_uf.gti for the XIS1
    
  • ae[obs-id]xi2_N_conf_uf.gti for the XIS2
    
  • ae[obs-id]xi3_N_conf_uf.gti for the XIS3
    

  where N is the RPT number.

/event_cl

• Cleaned event files containing data from the 4 XIS units. These file are separated for XIS unit, edit mode or timing, microcode type, disciminator and threshold. The filename is encoded as follow : ae[obs-id]xi0_N_ZZZKKKKC_cl.evt for the XIS0
  ae[obs-id]xi1_N_ZZZKKKKC_cl.evt for the XIS1
  ae[obs-id]xi2_N_ZZZKKKKC_cl.evt for the XIS2
  ae[obs-id]xi3_N_ZZZKKKKC_cl.evt for the XIS3
  

  where N is the RPT number, ZZZ is the edit or timing modes, KKKK identifies the microcode and C the instrument discriminator and threshold configurations. The latter uses an alphabetic character to distinguish between the different configurations (see Appendix for the parameter that define a configuration).

  The strings (ZZZ) for the edit or timing modes are the following:

  • 5x5 if the telemetry includes a 5x5 square pixel around each event
    
  • 3x3 if the telemetry includes a 3x3 square pixel around each event
    
  • 2x2 if the telemetry includes a 2x2 square pixel around each event
    
  • tim for timing mode
    
  The string for the microcode (KKKK) is set in the following way. The first characters depends on the edit or timing mode and the three remaining are numbers to identify a specific configuration. They are therefore set as follows :
  • nMMM where n is for the normal window mode for any of the 5x5 or 3x3 or 2x2 edit mode
    
  • bMMM where b is for burst window mode for any of the 5x5 or 3x3 or 2x2 edit mode
    
  • pMMM where p is for psum for the timing mode.
    
  MMM is the unique number associated to the microcode.
  

/hk

• XIS housekeeping files. For each detector units, the HK data coming from different RPTs are all merged in a single file.

  ae[obs-id]xi0_0.hk for the XIS0
  ae[obs-id]xi1_0.hk for the XIS1
  ae[obs-id]xi2_0.hk for the XIS2
  ae[obs-id]xi3_0.hk for the XIS3
  

/products

• Images in sky coordinate. There is one image per XIS sensor. If there is more than one cleaned event file because of the different instrument configuration, the images are generated using the longer exposures.

  ae[obs-id]xi0_0_ZZZKKKKC_sk.img for the XIS0
  ae[obs-id]xi1_0_ZZZKKKKC_sk.img for the XIS1
  ae[obs-id]xi2_0_ZZZKKKKC_sk.img for the XIS2
  ae[obs-id]xi3_0_ZZZKKKKC_sk.img for the XIS3
  

• Source spectra. There is one source spectrum per XIS sensor. If there is more than one cleaned event file because of the different instrument configuration, the source spectrum are generated using the longer exposures. The spectra are in PI channel and the extraction region is three arcmins around the source position.

  ae[obs-id]xi0_0_ZZZKKKKC_sr.pi for the XIS0
  ae[obs-id]xi1_0_ZZZKKKKC_sr.pi for the XIS1
  ae[obs-id]xi2_0_ZZZKKKKC_sr.pi for the XIS2
  ae[obs-id]xi3_0_ZZZKKKKC_sr.pi for the XIS3
  

• Background spectrum. There is one source spectrum per XIS sensor. The background spectrum is extracted from the event file used to extract the source spectrum. The spectra are in PI channel and the extraction region is an anulus around the source position.

  ae[obs-id]xi0_0_ZZZKKKKC_bg.img for the XIS0
  ae[obs-id]xi1_0_ZZZKKKKC_bg.img for the XIS1
  ae[obs-id]xi2_0_ZZZKKKKC_bg.img for the XIS2
  ae[obs-id]xi3_0_ZZZKKKKC_bg.img for the XIS3
  

• Source lightcurve. There is one lightcurve per XIS sensor. If there is more than one cleaned event file because of the different instrument configuration, the lightcurve are generated using the longer exposures. The extraction region is of three arcmins around the source position and is not background subtracted.

  ae[obs-id]xi0_0_ZZZKKKKC_sr.pi for the XIS0
  ae[obs-id]xi1_0_ZZZKKKKC_sr.pi for the XIS1
  ae[obs-id]xi2_0_ZZZKKKKC_sr.pi for the XIS2
  ae[obs-id]xi3_0_ZZZKKKKC_sr.pi for the XIS3
  

Trend data

Instrument trend

Each instrument produces data to archive as trend data. These are used to monitor various aspects of the instrument during the mission. The trend data are organized by time divided in a month interval, and within by intrument and organized by type. The following tables list the different trend by instrument, together with their filenames and the directory names where they are located. These data arrive together with the output of the processing of the observation therefore populate the archive soon after an observation have been processed. These files are not encrypted.

HXD

The list of the trend for the HXD are :

Table 4.1: List of HXD trend data

Trend Type description	Filename	Directory
HXD WELL gain history	ae[obs-id]hxd_0_gso.ghf	hxdwelgain
	ae[obs-id]hxd_0_pin.ghf
HXD WAM gain history	ae[obs-id]hxd_0_wam.ghf	hxdwamgain
HXD HK file	ae[obs-id]hxd_0.hk	hxdhk
HXD earth events	ae[obs-id]hxd_0_earth.evt	hxdearth
HXD Burst ID	ae[obs-id]hxd_0_bstidt.fits	hxdbstid

XIS

The XIS trend file are separated for each single units. The table reports the directories and filenames for the XIS0. The same trend type are also present for all the other units. The filenames listed here are just for the XIS0, there equivalent files for the XIS1, XIS2 and XIS3.

Table 4.2: List of XIS trend data

Trend Type description	Filename	Directory
XIS HK file	ae[obs-id]xi0_0.hk	xis0hk
XIS dark frame	ae[obs-id]xi0_N_dfiNN.fff	xis0dark
XIS frame mode normal	ae[obs-id]xi0_N_fnMMMiNN.fff	xis0framen
XIS frame mode burst	ae[obs-id]xi0_N_fbMMMiNN.fff	xis0frameb
XIS frame mode psum	ae[obs-id]xi0_N_fpMMMiNN.fff	xis0framep
XIS dark init normal	ae[obs-id]xi0_N_dinMMM.fff	xis0dinin
XIS dark init burst	ae[obs-id]xi0_N_dibMMM.fff	xis0dinitb
XIS dark init psum	ae[obs-id]xi0_N_dipMMM.fff	xis0dinitp
XIS dark update normal	ae[obs-id]xi0_N_dunMMM.fff	xis0dupn
XIS dark update burst	ae[obs-id]xi0_N_dubMMM.fff	xis0dupb
XIS event cal sources	ae[obs-id]xi0_0_ZZZKKKK_fe.evt	xis0cal
XIS day events	ae[obs-id]xi0_0_ZZZKKKK_de.evt	xis0day
XIS night events	ae[obs-id]xi0_0_ZZZKKKK_ne.evt	xis0night

where MMM is the microcode and ranges between 0-255, NN is the frame number and ranges between 00-99, ZZZ and KKKK have the same meaning for the science files (see section on XIS event_uf). The calibration sources, night and day events are merged per RPT as well as the HK. The remaining files are instead kept per RPT.

XRS

The list of the trend for the XRS are :

Table 4.3: List of XRS trend data

Trend Type description	Filename	Directory
XRS HK file	ae[obs-id]xrs_0.hk	xrshk
XRS nonxray events	ae[obs-id]xrs_0.evt	xrshk
XRS log and command files	ae[obs-id]xrs_0.log	xrshk
	ae[obs-id]xrs_0.com

Others

In addition to the instrumental trend data, there are five other types of files non instrument specific in the trend data. These data are located in the directory misc. The table lists for each type filename and directory :

Table 4.4: List of geneal trend data

Trend Type description	Filename	Directory
General HK file	ae[obs-id].hk	aegenhk
Attitude	ae[obs-id].att	aeatt
Orbit	ae[obs-id].orb	aeorb
Timing correction	ae[obs-id].tim	aetim
Make filter file	ae[obs-id].mkf	aemkf