IMP-8 ANALIMP-F

User's Guide



1. GENERAL DESCRIPTION

   The IMP-8 ANALIMPF program is to analyze pha data from PHA files. This
   program produces A vs B or D vs E plots of IMP-8 pha data, compute the
   distribution of particles about a centroidal curve, and prints 
   histogram to reflect this distribution.


2. INPUT PARAMETER CARDS


   Card 1 (Event Identification Card)

   Name	    Column   Format  Description

   ISPEC     1        I1     Histogram Option:
		             =0, compute histogram (default)
			     =1, no histograms

   KGAIN     3	      I1     Gain Indicator
			     =0, High Gain (default)
			     =1, Low Gain

   ICMP	     5	      I2     Compression Factor
			     =1, first 128 channels on each axis
			         of matrix with no compression
			     =2, first 256 channels on each axis
			         compressed to a 128xl28 matrix
			     =4, first 512 channels on each axis
			         compressed to a 128xl28 matrix
			     =8, all 1024 channels on each axis
			         compressed to a 128xl28 matrix

   IEV	     7        I1     Event to be analyzed
                 	     =1, A.B.-C and A.-B.-C if KGAIN=0;
                                 (A+B)1.A.B.-C and (A+B)1.A.-B.-C
                                 if KGAIN=1
                 	     =2, (A+B)2.A.B.-C and (A+B)2.A.-B.-C
                                 (KGAIN=0 only)
                             =3, D.E.-F.-G (KGAIN=0 only)
                             =4, (D1+E1)1.E.-F.-G (KGAIN=0 only)
                             =5, (D1+E1)2.E.-F.-G Low (10) (KGAIN=1 only)
                             =6, (D1+E1)2.E.-F.-G Low (50) (KGAIN=1 only)

   LDMASK   9-11      I3     LED T2T3T4 selection mask
                             =I2I3I4 where

                             Ij=0, then the LED Tj event type bit must be 0
                                   for an event to be accumulated
                             Ij=1, then the LED Tj event type bit must be 1
                                   for an event to be accumulated
                             Ij=2, then the LED Tj event type bit is not 
                                   tested in the accumulation decision
                                   (LDMASK is a requisite only if IEV=1 or 2)

   STD(1)  13-22     F10.0   If IEV less than 3, then A standard endpoint
		             for gain factor computation. Otherwise, D
			     standard endpoint for gain factor computation.

   STD(2)  24-33     F10.0   If IEV less than 3, then B standard endpoint
	         	     for gain factor computation. Otherwise, E
			     standard endpoint for gain factor computation.



   If ISPEC = 1, cards 2 through 14 are omitted. Time cards (card 15)
   follow immediately after card 1.

   Card 2

   Name	    Column   Format  Description

   COM	     1-16     A16    A user comment - written on page 1 of
			     output listing

   NZ	    19-20     I2     Particle atomic number

   XA	    21-30     F10.0  Particle atomic mass (in proton units)

   IDIST     32	      I1     Distance selector
			     =0, Perpendicular distance
			     =1, Vertical distance

   IPRINT    34	      I1     Debug printout option
			     =0, no printout
			     =1, diagnostic printout requested

   NCHOF    36-40     I5     Number of channels offset
			     (Center of histograms offset from curve)

   MXNCL    41-45     I5     Maximum number of iterations allowed to
			     compute perpendicular distance of any
                             given point to event line

   Card 3 (Scan Parameters Card)

   Name	    Column   Format  Description

   NLX       1-5      I5     X channel for lower horizontal scanning line

   NUX	     6-10     I5     X channel for upper horizontal scanning line

   NLY	    16-20     I5     Y channel for left vertical scanning line

   NUY	    21-25     I5     Y channel for right vertical scanning line

   NIX1     31-35     I5     X coordinate of point (X1,0)

   NIY1	    36-40     I5     Y coordinate of point (0,Y1)
			     Points (X1,0) and (0,Y1) are connected
			     to form lower scanning line

   NIX2     46-50     I5     X coordinate of point (X2,0)

   NIY2	    51-55     I5     Y coordinate of point (0,Y2)
			     Points (Y2,0) and (0,Y2) are connected
			     to form upper scanning line


   Card 4 (Histogram Parameters Card)

   Name	    Column   Format  Description

   NB        1-2      I2     Number of histograms (also number of
			     histogram energy limit cards to follow)  
			     maximum = 10

   CHW       3-10     F8.0   Histogram bin width - in channels


   Cards 5 through N (where N = 4 + NB of card 4, maximum N = 14)

   Name	    Column   Format  Description

			     One card for each histogram (maximum of 10)

   ELOW	     1-10     F10.0  Lower energy limit for histogram

   EUP	    11-20     F10.0  Upper energy limit for histogram 


   Time Indicator Card

   Name	    Column   Format  Description

   IOPT       1       I1     0= Do not plot, accumulate for the time
			        period on this card (default)
			     1= Plot all accumulated data.

   IORB1     3-7      I5     Start orbit.

   IORB2     8-12     I5     Stop orbit.

   IYR1     13-16     I4     Start year.

   IDAY1    18-20     I3     Start Julian day.

   IHR1	    22-23     I2     Start hour.

   IMIN1    25-26     I2     Start minute.

   IYR2	    28-31     I4     Stop year.

   IDAY2    33-35     I3     Stop Julian d,

   IHR2	    37-38     I2     Stop hour.

   IMIN2    40-41     I2     Stop minute.

   END1	    60-64     F5.0   Endpoint used in computing the gain shift
			     along the ordinates
                             see Note 2

   END2	    66-70     F5.0   Endpoint used in computing the gain shift
	                     along the abscissa
                             see Note 3

   GTABLE    72	      I1     Gain factor table switch
                             see Note 4


   If IOPT=1 in the time indicator card, then omit the pick option card

   Pick option Card

   Name	    Column   Format  Description

   CHOICE    1-4      A4     Selection flag
                             =PICK (default)

   QPHA       6       L1     =true  the program is to use only PHA files
                                    (KGAIN must equal to zero)
                                    currently we restrict the program
                                    using PHA files only
                             =false the program can use PHA, MATR or LOWG
                                    files

   QFINE      8       L1     =true  finegain factors are to be used if they
                                    are available
                             =false access the gain factors indicated by
                                    variable GTABLE



3. PROCESSING ENVIRONMENT

   The IMP Analimp-f program (ANALIMPF) is developed on an Sun
   workstation Sun 4.1.4 operating system. The source codes are written
   in Sun FORTRAN language. A local I/O system FTIO package was developed.
   A local shell program was developed to execute the IMP ANALIMPF program.


Note 1 : (a) If an MED plot is requested, then this is the D detector endpoint. (b) If an LED plot is requested, then this is the A detector endpoint. Note 2 : (a) If an MED plot is requested, then this is the E detector endpoint. (b) If an LED plot is requested, then this is the B detector endpoint. Note 3 : GTABLE = 0: A, B events must use only this option gains are calculated from card input. (a) If STD values are zero, the program defaults to the internal A-B or D-E endpoints and uses them along with the END values to calculate gain factors. (b) If END1 and END2 are zero, the program will bypass gain correction (effectively gains = 1) (c) If the STD and END values do not give reasonable gain factors (STD(I)/ END(I) <= 3) the gain factors are set to 1.0. GTABLE = 1: D-E events only. Neither STD nor END values need be coded on the time card. The gain tables are accessed for each interval in the time span/orbit(s) requested. GTABLE = 2: D-E events only. Neither STD nor END values need be coded on the time card. The gain tables are accessed for gain factors, and the data will be normalized to IMP-6 data. Description of Parameter Cards All data specified on cards 1 through 14 is held constant for the entire run. Invalid combinations for gain and event on card 1 will cause the job to be terminated. Cards 2 through 14 pertain to histograms. If no histograms are required (ISPEC = 1), they must be omitted. Figure 1 contains a diagram of the scanning box derived from the data on card 3. All values specified on card 3 should be greated than or equal to zero. On card 4, an NB of less than one or greater than ten will cause job termination. CHW must be greater than zero and, unless specifically requested otherwise, should be the same value as the compression factor (ICMP on card 1). Card 15 (Time card) may be repeated as many times as are necessary to analyze all requested data. If partial orbits are requested, the time cards should be in ascending chronological order. When IOPT = 1, all other data on that card is ignored. For all further discussion of this card, it is assumed that IOPT = 0. By specifying IORB1=0, IORB2 > 0 a time span can be broken up into time increments of IORB2 (hours). For each increment, data is accumulated and a plot (with histogram, if requested) is printed. Increment processing stops when the start time of an increment is larger than the stop time on the input data card. If IORB2 is zero, the entire time period is processed. Figure 1 IMP document image