XIS5X5TO3X3 (Oct 2007)          suzaku.xis          XIS5X5TO3X3 (Oct 2007)

NAME
    xis5x5to3x3 -- convert XIS 5x5 mode event file into 3x3 mode

USAGE
    xis5x5to3x3 infile outfile hkfile

DESCRIPTION

    'xis5x5to3x3' converts the XIS 5x5 mode event file (EDITMODE='5x5')
    into the 3x3 mode event file (EDITMODE='3x3'). The difference of the
    5x5 mode and the 3x3 mode event files are:

    5x5 mode: (EDITMODE = '5x5' in the header keyword)

      Column Name                Format     Dims       Units     TLMIN  TLMAX
     13 PHAS                      25I                  chan     -32768    32767

    3x3 mode: (EDITMODE = '3x3' in the header keyword)

      Column Name                Format     Dims       Units     TLMIN  TLMAX
     13 PHAS                       9I                  chan     -32768    32767
     18 P_OUTER_MOST               1I
     19 SUM_OUTER_MOST             1I

    In order to calculate the P_OUTER_MOST and SUM_OUTER_MOST columns,
    S[0123]_SPTHOT_[ABCD] columns in the HK file specified by the "hkfile"
    parameter or the "s[0123]_spthot_[abcd]" parameters (wheh hkfile='none')
    are utilized.

    XSELECT can handle both files together, however, PHAS column of the 5x5
    event files will be broken when one would extract and save events.

PARAMETERS

infile [file name]
    Name of input XIS 5x5 mode event file.

outfile [file name]
    Name of output XIS 3x3 mode event file.

hkfile [file name]
    Name of the input XIS HK file,
    or 'none' to use "s[0123]_spthot_[abcd]" parameters.

(s0_spthot_a = 20) [integer]
    split threshold outer of XIS0 segment A, used when hkfile='none'.

(s0_spthot_b = 20) [integer]
    split threshold outer of XIS0 segment B, used when hkfile='none'.

(s0_spthot_c = 20) [integer]
    split threshold outer of XIS0 segment C, used when hkfile='none'.

(s0_spthot_d = 20) [integer]
    split threshold outer of XIS0 segment D, used when hkfile='none'.

(s1_spthot_a = 10) [integer]
    split threshold outer of XIS1 segment A, used when hkfile='none'.

(s1_spthot_b = 10) [integer]
    split threshold outer of XIS1 segment B, used when hkfile='none'.

(s1_spthot_c = 10) [integer]
    split threshold outer of XIS1 segment C, used when hkfile='none'.

(s1_spthot_d = 10) [integer]
    split threshold outer of XIS1 segment D, used when hkfile='none'.

(s2_spthot_a = 20) [integer]
    split threshold outer of XIS2 segment A, used when hkfile='none'.

(s2_spthot_b = 20) [integer]
    split threshold outer of XIS2 segment B, used when hkfile='none'.

(s2_spthot_c = 20) [integer]
    split threshold outer of XIS2 segment C, used when hkfile='none'.

(s2_spthot_d = 20) [integer]
    split threshold outer of XIS2 segment D, used when hkfile='none'.

(s3_spthot_a = 20) [integer]
    split threshold outer of XIS3 segment A, used when hkfile='none'.

(s3_spthot_b = 20) [integer]
    split threshold outer of XIS3 segment B, used when hkfile='none'.

(s3_spthot_c = 20) [integer]
    split threshold outer of XIS3 segment C, used when hkfile='none'.

(s3_spthot_d = 20) [integer]
    split threshold outer of XIS3 segment D, used when hkfile='none'.

(anl_verbose = 1) [integer]
    ANL verbose level (-1:full, 0:minimum).

(anl_profile = yes) [boolean]
    Enable ANL module profiling.

(num_event = -1) [integer]
    Number of event (-1=all, 0=exit).

(event_freq = 1000) [integer]
    Event number printout frequency.

(chatter = 2) [integer]
    Message chatter level (0:min,2:norm,5:max).

EXAMPLES

1.  Convert 'xis0_5x5.evt' to 'xis0_3x3.evt' using HK file.

    % xis5x5to3x3 xis0_5x5.evt xis0_3x3.evt xis0.hk

2.  Convert 'xis1_5x5.evt' to 'xis1_3x3.evt',
    using default "s0_spthot_[abcd]" parameters.

    % xis5x5to3x3 xis1_5x5.evt xis1_3x3.evt none

SEE ALSO

AUTHOR

    Y.ISHISAKI (TMU), and the XIS team.

LAST MODIFIED

    Oct 2007