SISPI (Jun94)                  ftools.asca                 SISPI (Jun94)



NAME
    sispi -- Fill PI column of ASCA SIS BRIGHT or BRIGHT2 mode data
    
    
USAGE
    
    sispi datafile calfile
    
    
DESCRIPTION
    This  task  is  written  specifically  to process data from the ASCA
    X-ray satellite and requires SIS  BRIGHT  or  BRIGHT2  mode  science
    file(s)  as input.  The Pulse Invariant (PI) column, which exists in
    these files but not necessarily populated, will be  filled  by  this
    task using a SIS gain/CTI history file; PH to PI conversion formula,
    the history file format and the actual values have  been/are  to  be
    supplied by the ASCA SIS team.
    
    
    
PARAMETERS
    
    datafile [file name]
        The  ASCA  science  FITS  file  and  extension  to be processed.
        Multiple files can be processed if given  the  name  of  a  file
        containing  a  list  of  file  names,  preceded by an '@' symbol
        (e.g., @list).
    
    calfile [file name]
        The SIS gain/CTI history file name.  The current version of this
        calibration  file  (sisph2pi.fits)  is  included  in the refdata
        area of FTOOLS v3.0 release and later; calibration file  may  be
        updated from time to time.
    
    rawxcol [string] (hidden parameters)
        The name of the RAWX column.
    
    rawycol [string] (hidden parameters)
        The name of the RAWY column.
    
    phacol [string] (hidden parameters)
        The name of the PHA column.
    
    gradecol [string] (hidden parameters)
        The name of the GRADE column.
    
    idcol [string] (hidden parameters)
        The name of the CCD ID column.
    





                                  -1-
SISPI (Jun94)                  ftools.asca                 SISPI (Jun94)



    picol [string] (hidden parameters)
        The name of the PI column.
    
    gainnom [real] (hidden parameters)
        The  nominal gain value to be used for the PI; negative value is
        default, in which case the value found in the gain history  file
        will  be  used.  Positive values will be taken as eV/channel and
        will supersede the history file value.
    
    launch [boolean] (hidden parameters)
        Whether to use the  time  dependent  gain/CTI  values  from  the
        calibration  file  (no)  or  simply  use  the  nominal values at
        launch (yes)
    
    verbose [logical] (hidden parameters)
        The verbose flag: run time information updates.
    
    history [logical] (hidden parameters)
        The  history  flag  -  append  a  HISTORY  card  to   the   file 
        documenting the procedure.
    
    
EXAMPLES
    
    sispi s0_clean.evt /ftools/DEC/release/refdata/sisph2pi.fits
        
        To  fill  the  PI  column  of  previously  processed  SIS BRIGHT
        science file, where "s0_clean.evt" is the science file.
    
    sispi gainnom=3.2565 verbose=yes
        
        to use a nominal value of 3.2565 eV per channel  (which  is  the
        value  at  launch  of  SIS-1  Chip  3) for the output PI values.
        This enables the use  of  S1C3  PHA  matrices  for  other  SIS-1
        chips,  in  2-  and  4-CCD  mode  data  (gainnom  of  3.5793  is 
        appropriate for S0C1 matrices).  This  procedure  is  relatively
        systematics-free,  because  the  difference  in the responses of
        different chips within the same SIS instrument  is  minor,  once
        the  gain  is  normalized.   The  verbose  option outputs useful
        information to STDOUT.
    
    
BUGS
    
    No bugs as such known at present.
        
        Interface to calibration file  is  primitive  in  this  version.
        Format  of  calibration  file  may  well  evolve,  in which case
        updated version of this program may become necessary.
        
        



                                  -2-
SISPI (Jun94)                  ftools.asca                 SISPI (Jun94)



SEE ALSO
    
    FAINT
        
        
AUTHOR
    
    Koji Mukai, ASCA GOF, NASA/GSFC.