ea_view_angle [1] $SSW/hessi/idl/qlook_archive/hsi_flare_list__view_angle.pro
[Previous] [Next]
 NAME:
       ea_view_angle
 PURPOSE:
       Calculate the view angle of a spot on the sun,
       given the heliocentric corrdinates, i.e.,'N22W85'.
       Uses get_sun.pro to obtain the ephemeris info.
 CALLING SEQUENCE:
       theta=ea_view_angle(helio,date)
 INPUT:
       helio	- is a vector of heliographic coordinates.  It should be 2xN.
                       (0,*) = longitude (degrees) W positive
                       (1,*) = latitude (degrees) N positive
		  They can also be strings in the form 'N30W23'.
	date	- Unless the date is supplied, today's date is used.
                 This will affect the Solar axial tilt, B0.
 OUTPUT:
       theta = the view angle; i.e., the angle between the line
              perpendicular to the solar surface and the line
              to the spacecraft.
 HISTORY:
       10-Mar-94, JMM
       3-May-2005, jmm, added /arcsec keyword to allow for the
       coordinates in arcsec from sun center (heliocentric?) as
       opposed to lat and lon (or heliographic), replaced ()'s with
       []'s in arrays...


edge2bin $SSW/hessi/idl/util/edge2bin.pro
[Previous] [Next]
 PROJECT:
	HESSI
 NAME:


 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:


 CALLS: ***
	edge_products
 INPUTS:
		Edge
		Cal_edge - either an explicit edge value for each bin, or coefficients describing a linear relationship.
						If CAL_IS_SCALE is set, then bin = (edge - cal_edge[0]) / cal_edge[1]

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 CALLED BY:
	HSI_HIST_GROUP, HSI_SPECTROGRAMCHAN_OVERLAP_FIX
	HSI_SPECTROGRAM_DECIM_CORRECT, HSI_SPECTROGRAM_DECIM_TABLE
	SPECTROGRAM CLASS DEFINITION, hsi_spectrogramACCBIN [2]
	hsi_spectrogram__define [1], hsi_spectrogram__define [2]
	hsi_spectrogram__define [3], hsi_spectrogram__get_obs [1]
	hsi_spectrogram__livetime [1]
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:
	Version 1, richard.schwartz@gsfc.nasa.gov


Energy_res [2] $SSW/hessi/idl/spectra/hsi_drm_mod__define.pro
[Previous] [Next]
 Project:
	XRAY

 NAME:
	Energy_res
 PURPOSE:
	This procedure generates a matrix of gaussian pulse-shapes which can
	then multiply a matrix of energy-losses to form a full pulse-height
	matrix.

 CATEGORY:
	MATH, CALIBRATION, INSTRUMENT, DETECTORS, RESPONSE, SPECTROSCOPY

 CALLING SEQUENCE:
	PULSE_SPREAD, INPUT, PSM, INMATRIX, OUTMATRIX
 CALLED BY:
	HESSI FRAMEWORK TEMPLATE CLASS [2], HESSI FRAMEWORK TEMPLATE CLASS [3]
	HSI_DRM_MOD CLASS, HSI_DRM_MOD_CONTROL__DEFINE, SOXS_CZT_DRM, SOXS_DRM
 EXAMPLES:
	pulse_spread, input_psm, pulse_shape, eloss_mat.eloss_mat, drm

 CALLS: ***
	CHECKVAR [1], DEFAULT, ENERGY_RES::INIT, ENERGY_RES::PROCESS, ENERGY_RES_CONTROL
	ENERGY_RES_CONTROL__DEFINE, ENERGY_RES_INFO__DEFINE, ENERGY_RES__DEFINE, EXIST
	F_DIV, GET_EDGES, HESSI_ID2INDEX, HSI_DRM_MOD::GETDATA, HSI_DRM_MOD::INIT
	HSI_DRM_MOD::PROCESS, HSI_DRM_MOD_CONTROL, HSI_DRM_MOD_CONTROL__DEFINE
	HSI_DRM_MOD_INFO__DEFINE, HSI_DRM_MOD__DEFINE, HSI_FILTER
	HSI_FILTER::BLANKET_TRANSMISSION, HSI_FILTER::GETDATA, HSI_FILTER::INIT
	HSI_FILTER::PROCESS, HSI_FILTER_CONTROL, HSI_FILTER_CONTROL__DEFINE
	HSI_FILTER_INFO__DEFINE, HSI_FILTER__DEFINE, HSI_LOC_FILE, HSI_SRM, INTERP2INTEG
	INTERPOL, MRDFITS [1], MRDFITS [2], SAME_DATA [1], SAME_DATA [2], STR2ARR [1]
	STR2ARR [2], checkvar [2], edge_products, get_fits_extno, hsi_calc_resolutions
	hsi_default_resolutions, hsi_shutter_transmission, rd_tfile [1], rd_tfile [2]
 INPUTS:

 OPTIONAL INPUTS:


 OUTPUTS:
       PSM - pulse-shape matrix, square or SPARSE

 OPTIONAL OUTPUTS:


 KEYWORDS:
	SPARSE - if set, then psm is a sparse matrix
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	The GAUSSINT function is used to construct the point-spread function.  GAUSSINT is
	the integral over the normally used GAUSSIAN function and is the correct function
	where the Gaussian is a valid approximation only when the output channels are
	narrow wrt the resolution.  Also, if INMATRIX is given, an efficient matrix
	multiplication is performed on large matrices, multiplying only over the
	non-zero elements of INMATRIX, useful when INMATRIX is mainly the photoefficiency
	without a Compton tail.

 MODIFICATION HISTORY:
	16-jun-2006, ras


EVENT PACKET Data structure definition $SSW/hessi/idl/util/hsi_packet_event__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENT PACKET Data structure definition

 PURPOSE: 
       Defines the structure of the event packets, in Integer / Long
       integer format 

 CATEGORY:
       Utilities (hessi/idl/util)
 
 CALLING SEQUENCE: 
       var = {hsi_packet_event}

 INHERITANCE
       HSI_Packet_Header

 CALLS: ***
	HSI_PACKET_EVENT__DEFINE
 HISTORY:
       Version 1, May 3, 1999, for Release 2
           A Csillaghy, csillag@ssl.berkeley.edu
       Extracted from Richard Schwartz' schwartz_struct_def
           (orig. name hsi_source_packet)


EVENTLIST CONTROL STRATEGY CONTROL STRUCTURE INITIALIZATION $SSW/hessi/idl/util/hsi_eventlist_strategy_control.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST CONTROL STRATEGY CONTROL STRUCTURE INITIALIZATION

 PURPOSE:
       Sets the default values of the eventlist staretgy control parameters

 CATEGORY:
       Utilities (hessi/util)

 CALLING SEQUENCE:
       result = hsi_eventlist_staretegy_control()

 OUTPUTS:
       result: a variable of type {hsi_eventlist_control}, withthe
               default values

 CALLS: ***
	HSI_EVENTLIST_STRATEGY_CONTROL
 SEE ALSO:
	http://hessi.ssl.berkeley.edu/software/reference.html#hsi_eventlist_stratetgy
 HISTORY:
     4-jan-2002, energy_band to fltarr(2) from [12d,25d], ras
     ras, 15-sep-2001, added GAIN_GENERATION & Gain_TIME_WANTED
       Realease 6: changed from eventist_control to
                   eventlist_control_strategy, removed the unuseful
                   keyword stuff ACs
       Release 5.1 ras 22-feb-2001, added NEW_GAIN
       Release 5, August 2000, ACs
          time_unit defauklts to 16 instead of 1
       Release 4 development  -> April 2000 ACs
       Version 1, May 17, 1999,
           A Csillaghy, csillag@ssl.berkeley.edu
     10-apr-2002 RAS
      Gain generation defaults to 2
      New_gain is removed
     27-jul-02, gain_generation defaults to 1000

     19-sep-02, ras, moved dp_enable, dp_cutoff, and extend_time_range here
      from hsi_spectrogram_control
     1-oct-02, ras, add dp_lld, channel thresholds for events that close datagaps
   24-oct-02, ras, added deflt_atten_state for simulation files
     21-feb-03, ras, dp_lld[6] raised from 50 to 65.  Detector 7 has a higher threshold.
   18-apr-03, ras, DP_CUTOFF raised from .01 to .03 seconds after examining
   dropout behavior w/o csa events.
   11-apr-05, ras, added dp_extend, this is used to extend the datagaps this many SECONDS
     after the otherwise determined conclusion.  And it sets the coinc flag for
     any events within any datagap intervals.


EVENTLIST CONTROL STRUCTURE INITIALIZATION $SSW/hessi/offline/hsi_eventlist_control.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST CONTROL STRUCTURE INITIALIZATION

 PURPOSE: 
       Sets the default values of the eventlist control parameters

 CATEGORY:
       Utilities (hessi/util)
 
 CALLING SEQUENCE: 
       result = hsi_eventlist_control()       

 OUTPUTS:
       result: a variable of type {hsi_eventlist_control}, withthe
               default values

 KEYWORDS: 
       A2D_INDEX_MASK
       ENERGY_BAND
       TIME_RANGE
       TIME_UNIT

 CALLS: ***
	HSI_EVENTLIST_CONTROL
 SEE ALSO:
	http://hessi.ssl.berkeley.edu/software/reference.html#hsi_eventlist
 HISTORY:
       Release 5.1 ras 22-feb-2001, added NEW_GAIN
       Release 5, August 2000, ACs
          time_unit defauklts to 16 instead of 1
       Release 4 development  -> April 2000 ACs
       Version 1, May 17, 1999, 
           A Csillaghy, csillag@ssl.berkeley.edu


EVENTLIST FILE SIMULATION INFO STRUCTURE DEFINITION [1] $SSW/hessi/idl/util/hsi_eventlist_file_sim_control__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST FILE SIMULATION INFO STRUCTURE DEFINITION

 PURPOSE: 
       This structure defines the info parameter obs_time interval
       that replaces the usual control parameter with same name in
       case the eventlist file contains simulated data, thus there is
       no hsi_packet where obs_time_interval is originally defined. 

 CATEGORY:
       Utilities
 
 NOTE;
       This structure is managed by the hsi_eventlist_file class. Check
       hsi_eventlist_file__define for a description of the parameter

 CALLS: ***
	HSI_EVENTLIST_FILE_SIM_CONTROL__DEFINE
 HISTORY:
       May 2003, created 
           A Csillaghy, csillag@ssl.berkeley.edu


EVENTLIST FILE SIMULATION INFO STRUCTURE DEFINITION [2] $SSW/hessi/idl/util/hsi_eventlist_file_sim_info__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST FILE SIMULATION INFO STRUCTURE DEFINITION

 PURPOSE: 
       This structure defines the info parameter obs_time interval
       that replaces the usual control parameter with same name in
       case the eventlist file contains simulated data, thus there is
       no hsi_packet where obs_time_interval is originally defined. 

 CATEGORY:
       Utilities
 
 NOTE;
       This structure is managed by the hsi_eventlist_file class. Check
       hsi_eventlist_file__define for a description of the parameter

 CALLS: ***
	HSI_EVENTLIST_FILE_SIM_INFO__DEFINE
 HISTORY:
       May 2003, created 
           A Csillaghy, csillag@ssl.berkeley.edu


EVENTLIST INFO STRUCTURE DEFINITION $SSW/hessi/idl/util/hsi_eventlist_info__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST INFO STRUCTURE DEFINITION

 PURPOSE: 
       Defines the information parameters of the eventlist top-level
       (Context) class

 CATEGORY:
       Utilities
 
 NOTE;
       This structure is managed by the eventlist class. Check
       hsi_eventlist__define for a description of the parameters

 CALLS: ***
	HSI_EVENTLIST_INFO__DEFINE
 HISTORY:
       Release 6: June 2001 ACs. 


EVENTLIST STRATEGY INFO STRUCTURE DEFINITION [1] $SSW/hessi/idl/util/hsi_eventlist_file_info__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST STRATEGY INFO STRUCTURE DEFINITION

 PURPOSE: 
       Defines the HESSI eventlist information parameters common to
       the eventlist simulation and eventlist packet classes.

 CATEGORY:
       Utilities
 
 NOTE;
       This structure is managed by the eventlist strategy class. Check
       hsi_eventlist_startegy__define for a description of the parameters

 CALLS: ***
	HSI_EVENTLIST_FILE_INFO__DEFINE
 HISTORY:
       Release 6: some parameters come, some go.... 
                  changed name from hsi_eventlist_info to
                  hsi_eventlist_strategy_info__define
                  June 2001 ACs. 
       Release 5.1, Updated doc April 2001 ACs, Rel
       Release 2 development, April 27, 1999, 
           A Csillaghy, csillag@ssl.berkeley.edu


EVENTLIST STRATEGY INFO STRUCTURE DEFINITION [2] $SSW/hessi/idl/util/hsi_eventlist_packet_info__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST STRATEGY INFO STRUCTURE DEFINITION

 PURPOSE: 
       Defines the HESSI eventlist information parameters common to
       the eventlist simulation and eventlist packet classes.

 CATEGORY:
       Utilities
 
 NOTE;
       This structure is managed by the eventlist strategy class. Check
       hsi_eventlist_startegy__define for a description of the parameters

 CALLS: ***
	HSI_EVENTLIST_PACKET_INFO__DEFINE
 HISTORY:
       Release 6: some parameters come, some go.... 
                  changed name from hsi_eventlist_info to
                  hsi_eventlist_strategy_info__define
                  June 2001 ACs. 
       Release 5.1, Updated doc April 2001 ACs, Rel
       Release 2 development, April 27, 1999, 
           A Csillaghy, csillag@ssl.berkeley.edu


EVENTLIST STRATEGY INFO STRUCTURE DEFINITION [3] $SSW/hessi/idl/util/hsi_eventlist_strategy_info__define.pro
[Previous] [Next]
 PROJECT:
       HESSI

 NAME:
       EVENTLIST STRATEGY INFO STRUCTURE DEFINITION

 PURPOSE:
       Defines the HESSI eventlist information parameters common to
       the eventlist simulation and eventlist packet classes.

 CATEGORY:
       Utilities

 NOTE;
       This structure is managed by the eventlist strategy class. Check
       hsi_eventlist_startegy__define for a description of the parameters

 CALLS: ***
	HSI_EVENTLIST_STRATEGY_INFO__DEFINE
 HISTORY:
      18-jul-2005, ras, added LAST2 that keeps track of livetime counter pieces
      between packet bunches
       Release 6: some parameters come, some go....
                  changed name from hsi_eventlist_info to
                  hsi_eventlist_strategy_info__define
                  June 2001 ACs.
       Release 5.1, Updated doc April 2001 ACs, Rel
       Release 2 development, April 27, 1999,
           A Csillaghy, csillag@ssl.berkeley.edu
     info_dp_cutoff - ras added 1-oct-02