WSPEX USERS MANUAL
       	   	    
		     FOR BATSE SOLAR FLARE ANALYSIS

                Written by Lanny Thompson, Arkansas State University
                August 1995

			        SUMMARY  

GETTING TO WSPEX

   I. GETTING TO WSPEX

	1. Telnet to SDAC
	
	2. Enter IDL
		a. Type IDL at $ prompt

	3. Start WSPEX
		a. Type WSPEX at IDL prompt

SELECTING DATA
 
   I. SELECTING AN OPTIONAL DRM
    	
	1. Select the Development DRM
		
		({OPTIONS} SPECTRAL FITS -> RESPONSE MATRIX OPTIONS ->         
		 DEVELOPMENT DRM)
	
		a. Select the SPECTRAL FITS button from the OPTIONS row of the 
		   SPEX CONTROL PANEL.
		b. Choose the RESPONSE MATRIX OPTIONS from the menu given.
		c. Select the DEVELOPMENT DRM function.

  II. SELECTING THE BATSE INSTRUMENTS

	1. Set WSPEX to use the BATSE INSTRUMENTS
		
		({OPTIONS} SPECIAL -> DATA TYPE -> BATSE -> SHER AND SHERB)

		a. Select the SPECIAL button from the OPTIONS row of the SPEX  
		   CONTROL PANEL.		
		b. Choose the DATA TYPE option from the menu given.
		c. Select the BATSE setting from the data type menu.
		d. Select the SHER AND SHERB setting from the settings         
		   available.

 III. CHOOSING A FLARE ARCHIVE NUMBER
	
	1. Choose the flare number to be used by WSPEX.
	
		({OPTIONS} SPECIAL -> EVENT ID -> ARCHIVE # -> <flare number>)

		a. Select the SPECIAL button from the OPTIONS row of the SPEX  
		   CONTROL PANEL.
		b. Choose the EVENT ID option from the options: special menu.
		c. Select the ARCHIVE # function.
		d. Enter the five digit flare number by using the columns of   
		   numbers given.

  IV. PREVIEWING THE DATA FILE

	1. Preview the data file.
		
		({ACTIONS} SPECIAL -> PREVIEW DATA FILE)
	
		a. Select the SPECIAL button from the ACTIONS row of the SPEX  
		   CONTROL PANEL.
		b. Choose the PREVIEW DATA FILE action from the actions:       
		   special menu.
		c. Observe the information displayed in the INFO BOX.

   V. CHOOSING A DETECTOR

	1. Choose the proper detector for the flare.
	
		({OPTIONS} SPECIAL -> DETECTOR # -> <0,1,2,3,4,5,6, or 7>)
		
		a. Select the SPECIAL button from the OPTIONS row of the SPEX  
		   CONTROL PANEL.
		b. Choose the DETECTOR # function from the options: special    
		   menu.
		c. Selector a detector id number from the list displayed.

  VI. DISPLAYING OPTIONS
	
	1. Display the current options and settings in WSPEX	
	
		({ACTIONS} SPECIAL -> SHOW CURRENT OPTIONS)

		a. Select the SPECIAL button from the ACTIONS row of the SPEX  
		   CONTROL PANEL.
		b. Choose the SHOW CURRENT OPTIONS from the actions: special   
		   menu.
		c. Observe the information displayed in the INFO BOX.


TIME HISTORY

   I. DISPLAYING A LIGHT CURVE

        1. Display a Single trace or multi trace light curve for the flare
	   already selected.

		Single Trace=> ({ACTIONS} TIME HISTORY -> PLOT LIGHT CURVE     
				(READ) -> ONE TRACE)
		Multi-Trace=> ({ACTIONS} TIME HISTORY -> PLOT LIGHT CURVE      
				(READ) -> MULTI-TRACE)
		
		a. Select the TIME HISTORY button from the ACTIONS row of the  
		   SPEX CONTROL PANEL.
		b. Choose the PLOT LIGHT CURVE (READ) option from the given    
		   menu.
		c. Select either the ONE TRACE or MULTI-TRACE option from the  
 		   menu displayed.
		d. OPTIONAL: Observe the detector cosines, displayed in the    
		   INFO BOX, as WSPEX plots the light curve. 

  II. ADJUSTING THE TIME PROFILE (OPTIONAL)
        	
	1. Zoom in Time.

		({ACTIONS} TIME HISTORY -> ZOOM IN TIME -> GRAPHICAL INPUT ->  
		 <select intervals>)

		a. Select the TIME HISTORY button from the ACTIONS row of the
		   SPEX CONTROL PANEL.
		b. Choose the ZOOM IN TIME action from the actions: time
		   history menu.
		c. Choose the GRAPHICAL INPUT button from the "Interval
		   Selection Mode" window.
		d. Select the interval from the Time History window using the
		   cursor. 
		e. Remove the cursor from the time history window.

    	2. Change the y-axis Scale.
	
		Linear Plot=>({OPTIONS} TIME HISTORY -> Y-AXIS -> LINEAR)
		Log Plot=>({OPTIONS} TIME HISTORY -> Y-AXIS -> LOG)

		a. Select the TIME HISTORY button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
		b. Choose the Y-AXIS option from the options: time history
		   menu.
		c. Select either the LINEAR or LOG action.
		d. Replot the light curve for the new setting to take effect.

	3. Change the y-axis Units.

		({{OPTIONS} TIME HISTORY -> Y UNITS -> <desired units>)
             	
		a. Select the TIME HISTORY button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
                b. Select the Y-UNITS action from the options: time history
		   menu.
		c. Choose the desired units from the y-units menu.
		d. Replot the light curve for the new setting to take effect.
	
	4. Changing the y-axis Range. 
	
		({{OPTIONS} TIME HISTORY -> YRANGE -> <desired values> -> DONE)

		a. Select the TIME HISTORY button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
		b. Select the YRANGE function from the options: time history
		   menu. 
		c. Enter the desired units into the "YRange For Time History
		   Plot" window.
		d. Select the DONE button from the "YRange For Time History
		   Plot" window.
		e. Replot the light curve for the new setting to take effect.

 III. SELECTING ENERGY CHANNELS

	1. Select the new energy bands' values.
		
		({OPTIONS} TIME HISTORY -> ENERGY BANDS (MULTI-TRACE) ->
		 <energy channel values> -> DONE)
		
		a. Select the TIME HISTORY button from the OPTIONS row of the 
		   SPEX CONTROL PANEL.
		b. Choose the ENERGY BANDS (MULTI-TRACE) function from the     
		   options: time history menu.
		c. Enter the new energy ranges into the pairs of panels in the
		  "Modify Option" window.
		d. Select the DONE button from the "Modify Option" window.
		e. Replot the light curve for the new settings to take effect.

	2. Change the scale of the energy bands.

		({OPTIONS} TIME HISTORY -> SCALE FOR BANDS -> <chosen scale> -> 
		 DONE)
		
               	a. Select the TIME HISTORY button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
		b. Choose the SCALE FOR BANDS function from the options: time  
		   history menu.
		c. Enter the new scales for the energies into the panels of the
                  "Modify Option" window.
		d. Select the DONE button from the "Modify Option" window.
                e. Replot the light curve for the new settings to take effect.

  IV. DEALING WITH BACKGROUND

	1. Select the background to subtract off.

		({ACTIONS} TIME HISTORY -> BACKGROUND -> SELECT INTERVALS ->  
		 NO -> <desired intervals>)
	
		a. Select the TIME HISTORY button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. Choose the BACKGROUND option from the actions: time history
		   menu.
		c. Select the SELECT INTERVALS action from the background menu.
		d. Determine whether the intervals WSPEX has pre chosen are
		   acceptable (Select either YES or NO from the window).
		e. Manually enter the intervals onto the plot if the pre chosen
		   background intervals are incorrect. 
		f. Remove the cursor from the plot and select the DONE button
		   from the "Cursor Controls" window.

	2. Clear off incorrectly chosen background intervals.

		({ACTIONS} TIME HISTORY -> BACKGROUND -> CLEAR BACKGROUND)

		a. Select the TIME HISTORY button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. Choose the BACKGROUND option from the actions: time history
                   menu.
		c. Select the CLEAR BACKGROUND action from the background menu.

   V. 	TIME (FIT) INTERVALS

	1. Select the fit intervals to analyze from the light curve.

		({ACTIONS} TIME HISTORY -> FIT INTERVALS -> SELECT -> GRAPHICAL
		 INPUT -> BOUNDARIES FOR DISCRETE INTERVALS -> <desired        
		 intervals> -> DONE)

		a. Select the TIME HISTORY button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
		b. Display the fit intervals menu by selecting the FIT         
		   INTERVALS option from the actions: time history menu.
		c. Choose the SELECT function from the fit intervals menu
		   displayed. 
		d. Select the GRAPHICAL INPUT button from the "Interval
		   Selection Mode" window.
		e. Choose the BOUNDARIES FOR DISCRETE INTERVALS button from the
		   "interval Selection" window.
		f. Use the cursor to select the fit intervals directly from the
		   plot of the light curve.
		g. Remove the cursor from the time history window and select
		   the DONE button from the "Cursor Controls" window. 

	2. Display the selected fit intervals on the light curve.
		
		({ACTIONS} TIME HISTORY -> FIT INTERVALS -> DISPLAY)

		a. Select the TIME HISTORY button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. Display the fit intervals menu by selecting the FIT
                   INTERVALS option from the actions: time history menu.
		c. Choose the DISPLAY function from the fit intervals menu
                   displayed; this will display the selected intervals.

	3. If necessary, clear the fit intervals.

		({ACTIONS} TIME HISTORY -> FIT INTERVALS -> CLEAR)

		a. Select the TIME HISTORY button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. Display the fit intervals menu by selecting the FIT
                   INTERVALS option from the actions: time history menu.
                c. Choose the CLEAR function from the fit intervals menu
                   displayed; this will display the selected intervals.

	4. Repeat the following procedures until a desired fit interval is     
	   achieved.
SPECTRAL PLOTS

   I. DISPLAYING A SPECTRAL PLOT

	1. Displaying a spectral plot
		
          Background=>({ACTIONS} SPECTRAL FITS -> SPECTRAL PLOTS -> BACKGROUND)
          Photons=>   ({ACTIONS} SPECTRAL FITS -> SPECTRAL PLOTS -> PHOTONS)
	  Counts=>    ({ACTIONS} SPECTRAL FITS -> SPECTRAL PLOTS -> COUNTS)

		a. Select the SPECTRAL FITS button from the ACTIONS row of the
		   SPEX CONTROL PANEL.
		b. Display the spectral plots menu by selecting the SPECTRAL
                   PLOTS option from the actions: time history menu.
		c. Choose either the BACKGROUND,PHOTONS, or COUNTS function
		   from the spectral plots menu for a plot of the background,  
		   photons, or counts respectively. 
	
	2. If necessary, adjust the scale of the x and y axis.

 	  X-axis/Y-axis to log/linear=>({OPTIONS} SPECTRAL FITS -> XAXIS/YAXIS 
					TYPE -> LOG/LINEAR)

		a. Select the SPECTRAL FITS button from the OPTIONS row of the
		   SPEX CONTROL PANEL.
		b. Choose either the XAXIS TYPE or the YAXIS TYPE option from  
		   the options: spectral fits menu.
		c. Select either LOG or LINEAR functions to get the axis in the
		   proper scale.
		d. Repeat the following procedures until both arises are in the
		   scale desired.
                e. The current plot must be replotted for the new changes to
		   take effect.
	3. Also, adjust the range of either axis if necessary.

	  X range/Y range selection =>({OPTIONS} SPECTRAL FITS -> PLOT XRANGE/ 
					PLOT YRANGE-> <desired range> -> DONE)

		a. Select the SPECTRAL FITS button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
		b. Choose either the PLOT XRANGE or the PLOT YRANGE from the
                   options: spectral fits menu.
		c. Enter the values for the range into the "Modify Option"
		   window.
		d. Select the DONE button from the "Modify Option" window.
 		e. The current plot must be replotted for the new changes to
                   take effect.
  II. BINNING

	1. Select the bin intervals and have WSPEX perform the bin (first two
	   methods).
	
      Binning =>({ACTIONS} SPECTRAL FITS -> SPEC. PLOT BINNING -> SELECT ->
	   	 GRAPHICAL INPUT -> AS BOUNDARIES FOR CONTIGUOUS INTERVALS/ AS
		 BOUNDARIES FOR DISCRETE INTERVALS -> <select intervals> ->
		 DONE)

		a. Select the SPECTRAL FITS button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. Display the Spec. plot binning menu by selecting the SPEC.
		   PLOT BINNING option from the actions: spectral fits menu.
		c. Select the GRAPHICAL INPUT button from the "Interval
		   Selection Mode" window.
		d. Choose either the AS BOUNDARIES FOR CONTIGUOUS INTERVALS or
		   the AS BOUNDARIES FOR DISCRETE INTERVALS button from the
		   "Interval Selection" window. 
                e. From the spectral plot window, select the intervals
		   where data is to be binned.
		f. Remove the cursor from the plot and select the DONE button
		   from the "Cursor Controls" window.
		g. For the bin to be performed the data must be replotted.

	2. If preferred, select the data to be binned in groups of a certain
	   number, chosen by the user, within a given interval (third method).
  
  Alternate Binning=> ({ACTIONS} SPECTRAL FITS -> SPEC. PLOT BINNING ->        
			SELECT -> GRAPHICAL INPUT -> AS LIMITS ON SAMPLE GROUPS
			OF N (TO BE CHOSEN) -> <group number> -> READY ->      
			<desired interval> -> DONE)
		
		a. Select the SPECTRAL FITS button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. Display the Spec. plot binning menu by selecting the SPEC.
                   PLOT BINNING option from the actions: spectral fits menu.
                c. Select the GRAPHICAL INPUT button from the "Interval
                   Selection Mode" window.
                d. Choose the third button, AS LIMITS ON SAMPLE GROUPS OF N (TO
		   BE CHOSEN, from the "Interval Selection" window.
		e. Enter a number into the "Select a Number" window and press
		   the READY button when complete.
		f. From the spectral plot window, select the interval     
		   where data is to be binned.
                g. Remove the cursor from the plot and select the DONE button
                   from the "Cursor Controls" window.
                h. For the bin to be performed the data must be replotted.

 III. DISPLAYING THE CURRENT OPTIONS

	1. Display the current options WSPEX has on the INFO BOX. 

		({ACTIONS} SPECTRAL FITS -> SHOW CURRENT OPTIONS)

		a. Select the SPECTRAL FITS button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
		b. Choose the SHOW CURRENT OPTIONS actions from the actions:
		   spectral fits menu.
		c. Observe the options displayed in the INFO BOX.

FITTING

   I. CHOOSING A FIT MODEL

	1. Choose the fit model to be used in the fitting process by WSPEX.

		({OPTIONS} SPECTRAL FITS -> MODEL FUNCTION -> <function name>)
   or  ({OPTIONS} SPECTRAL FITS -> MODEL FUNCTION -> OTHER -> <function name>)
	
		a. Select the SPECTRAL FITS button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
		b. Choose the  MODEL FUNCTION option from the options: spectral
		   fits menu.
		c. Either select the function name from the list or select the
		   OTHER action.
		d. If OTHER is selected, enter the name in the "Modify Option"
		   window and press the DONE button.

  II. SELECTING VALID ENERGIES

	1. Select the valid range of energy to be fitted by WSPEX directly
	   from the spectral plot.

		({ACTIONS} SPECTRAL FITS -> FIT -> SELECT ENERGY RANGE ->
		 <desired range on the plot> -> DONE)

		a. Select the SPECTRAL FITS button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
                b. From the actions: spectral fits menu, select the FIT option.
		c. Select the SELECT ENERGY RANGE action.
		d. Enter the range on the spectral plot with the cursor.
		e. Remove the cursor from the plot and select the DONE button.
	
	2. Alternate Method: Enter the valid range of energy directly into
	   WSPEX.

		({OPTIONS} SPECTRAL FITS -> VALID FITTING ENERGIES -> <energy
		 range> -> DONE)

		a. Select the SPECTRAL FITS button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
                b. From the options: spectral fits menu, select the VALID
		   FITTING ENERGIES function.
		c. Enter the desired range into the "Modify Option" window.
		d. Select the DONE button from the "Modify Option" window to
		   finish the procedure.

 III. THE FIT PARAMETERS

	1. View the parameters and make changes where necessary.

		({OPTIONS} SPECTRAL FITS -> FIT PARAMETERS -> <view and change
		 the parameter values> -> DONE)

		a. Select the SPECTRAL FITS button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
                b. From the options: spectral fits menu, select the FIT
        	   PARAMETERS function.
                c. View and manually enter changes to the fit parameters in the
		  "Modify Option window".
		d. Select the DONE button from the "Modify Option" window to
                   finish the procedure.
                e. Changes will take place upon the next fitting.

	2. Free or Fix selected parameters.

		({OPTIONS} SPECTRAL FITS -> FREE/FIX -> <push and pop
		  parameters> -> DONE)

		a. Select the SPECTRAL FITS button from the OPTIONS row of the
                   SPEX CONTROL PANEL.
                b. From the options: spectral fits menu, select the FREE/FIX
                   function.             
		c. Free given parameters by pushing the button to the left of
		   the parameter inside the "Option Toggle" window. 
		d. Fix given parameters by popping the button to the left of
                   the parameter inside the "Option Toggle" window.
		e. Select the Done button from the "Option Toggle" window to
		   finish the procedure.

  IV. FITTING AND PLOTTING

	1. Perform a fit of the model function to the data set.

		({ACTIONS} SPECTRAL FITS -> FIT -> FIT AND PLOT)

		a. Select the SPECTRAL FITS button from the ACTIONS row of the
                   SPEX CONTROL PANEL.
		b. From the actions: spectral fits menu, select the FIT AND
		   PLOT function.
                c. Observe the fit parameters on the spectral plot and the
		   Chisquare value from the terminal window. 

	2. Repeat the fit and plot procedure until an adequate fit is produced.

SUMMARY FILES
	
	1. Create and save a summary file of the existing work session.
	
		({ACTIONS} SUMMARY -> WRITE SUMMARY FILE)

		a. Select the SUMMARY button from the ACTIONS row of the SPEX  
 		   CONTROL PANEL.
                b. From the actions: summary menu, select the WRITE SUMMARY
		   FILE function.

   	2. Retrieve a previously saved summary file.

		({ACTIONS} SUMMARY -> RESTORE SUMMARY FILE)
		
		a. Select the SUMMARY button from the ACTIONS row of the SPEX
                   CONTROL PANEL.
                b. From the actions: summary menu, select the RESTORE SUMMARY
                   FILE function.

POSTSCRIPT FILES (SENDING A PLOT)

	1. Save the plot as a postscript file.

     Method 1=> ({ACTIONS} SPECTRAL FITS -> SEND LAST PLOT -> TO FILE)
     Method 2=> ({ACTIONS} TIME HISTORY -> SEND LAST PLOT -> TO FILE)

		a. Either select the SPECTRAL FITS or the TIME HISTORY button
		   from the ACTIONS row of the SPEX CONTROL PANEL.		
                b. Select the SEND LAST PLOT option.
		c. Choose the TO FILE action.

	2. Print the postscript file.

     Method 1=> ({ACTIONS} SPECTRAL FITS -> SEND LAST PLOT -> TO PRINTER)
     Method 2=> ({ACTIONS} TIME HISTORY -> SEND LAST PLOT -> TO PRINTER)

            	a. Either select the SPECTRAL FITS or the TIME HISTORY button
                   from the ACTIONS row of the SPEX CONTROL PANEL.
                b. Select the SEND LAST PLOT option.
		c. Choose the TO PRINTER action.

	3. Alternate Method: Send the plot to both file and printer. 

   Method 1=> ({ACTIONS} SPECTRAL FITS -> SEND LAST PLOT -> TO FILE AND PRINTER)
   Method 2=> ({ACTIONS} TIME HISTORY -> SEND LAST PLOT -> TO FILE AND PRINTER)

                a. Either select the SPECTRAL FITS or the TIME HISTORY button
                   from the ACTIONS row of the SPEX CONTROL PANEL.
                b. Select the SEND LAST PLOT option.
                c. Choose the TO FILE AND PRINTER action.
	
	4. Label the x and y axis for a better display and hard copy.

            	({ACTIONS} SUMMARY -> PARAMETERS TO PLOT -> XAXIS/YAXIS ->     
		 <choice from menu>)

		a. Select the SUMMARY button from the ACTIONS row of the SPEX
		   CONTROL PANEL.
               	b. Choose the PARAMETERS TO PLOT option.
		c. Either choose the x axis or y axis to change.
		d. Select the appropriate parameter to plot from the list given.

LEAVING WSPEX
	
	1. Leave wspex
		
		a. Press the EXIT button on the SPEX CONTROL PANEL.

	2. Leave idl
	
		a. From the IDL prompt type EXIT.