HESSI Data Object Parameters:  Spectral Response Matrix Parameters

 

Links to other parameter tables:
     All      Spectrum (Standard, Info, All)      Lightcurve (Standard, Info, All)     
     Image:     General (Standard, Info, All),   Clean,   Pixon,   Forward Fit,   MEM_NJIT,   VIS_FWDFIT,   UV_SMOOTH  
Spectral Response Matrix          Observing Summary          Simulation

 

Name Main Object Control / Info* Description Default Units Range Type** User Level*** Class
apt_filename Spectrum, Lightcurve Control -- apt_*.txt N/A -- string Advanced hsi_srm
astro Spectrum, Lightcurve Control If set, treat as an astrophysical source (out-of-aperture) 0 N/A 0 - 1 byte Advanced hsi_srm
atten_state Spectrum, Lightcurve Control Attenuator setting 1 N/A -- byte Advanced hsi_srm
compute_offax_position Spectrum, Lightcurve Control If set, compute offax_position. 1 -- 0 - 1 int Expert hsi_srm
ct_edges Spectrum, Lightcurve Control Define counts binning 2 N/A -- pointer Advanced hsi_srm
dead_seg Spectrum, Lightcurve Control If set, consider the corresponding one of 18 detector segments to be passive -- N/A -- byte(18) Advanced hsi_srm
diagonal_obj Spectrum, Lightcurve Info Internal storage for the diagonal srm object -- -- -- pointer N/A hsi_srm
display_result Spectrum, Lightcurve Control If set, plot the final matrices 0 N/A 0 - 1 byte Advanced hsi_srm
earth_position Spectrum, Lightcurve Control Earth Position 180. N/A -- pointer Advanced hsi_srm
geom_area Spectrum, Lightcurve Info Geometrical area of each detector -- N/A -- pointer N/A hsi_srm
info_apt_filename Spectrum, Lightcurve Info APT filename used -- N/A -- string N/A hsi_srm
info_ct_edges Spectrum, Lightcurve Info Count energy binning used in SRM' -- keV -- pointer N/A hsi_srm
info_ph_edges Spectrum, Lightcurve Info Photon energy binning used in SRM -- keV -- pointer N/A hsi_srm
info_srm_ct_edges Spectrum, Lightcurve Info Count energy edges used internally in hessi_build_srm to build srm -- keV -- pointer N/A hsi_srm
insert_kedge Spectrum, Lightcurve Control If set, add K-edge for Ge, Mo, Tu to ph_edges 1 -- 0 - 1 int Expert hsi_srm
integrator Spectrum, Lightcurve Control Assumed power law index over whole spectrum 0.0 N/A -- pointer Advanced hsi_srm
offax_position Spectrum, Lightcurve Control Angle between source and imaging axis .25 degrees -- pointer Advanced hsi_srm
ph_edges Spectrum, Lightcurve Control Define photon binning -- N/A -- pointer Advanced hsi_srm
pha_on_row Spectrum, Lightcurve Control If set, units of srm are [count energy, photon energy, matrix number]. If not set, count and photon indices reversed. 1 N/A 0 - 1 byte Advanced hsi_srm
print_subrms Spectrum, Lightcurve Control If set, print the submatrices to the screen. Beware: may be large. 0 N/A 0 - 1 byte Advanced hsi_srm
sep_dets Spectrum, Lightcurve Control If set, return separate matrices for each detector used 1 N/A 0 - 1 byte Advanced hsi_srm
sep_virds Spectrum, Lightcurve Control If set, return separate matrices for each virtual detector 1 -- -- byte Expert hsi_srm
simplify Spectrum, Lightcurve Control Code to select submatrix terms to use bytarr(10) N/A 0 - 3 pointer Advanced hsi_srm
srm_aspect_time Spectrum, Lightcurve Control Time used to get aspect for offax_position in SRM calculation -- sec -- pointer Expert hsi_srm
srm_direct Spectrum, Lightcurve Control If set, use new (9/2009) high-energy matrix to generate rear-segment DRM 1 -- -- int Advanced hsi_srm
srm_gain_time Spectrum, Lightcurve Control Time used to get resolution for SRM calculation -- -- -- pointer Expert hsi_srm
srm_input_units Spectrum, Lightcurve Control -- photons cm**(-2) -- -- string Expert hsi_srm
srm_lambda Spectrum, Lightcurve Control Characterizes radiation damage pulse shape tailing 0. -- -- pointer Advanced hsi_srm
srm_make_saved Spectrum, Lightcurve Control For each submatrix to be written to a saved file, set to the filename bytarr(10) N/A -- pointer Advanced hsi_srm
srm_units Spectrum, Lightcurve Control -- counts cm**(-2) kev**(-1) -- -- string Expert hsi_srm
srm_use_saved Spectrum, Lightcurve Control For each submatrix to be read from a saved file, set to the filename bytarr(10) N/A -- pointer Advanced hsi_srm
srm_used_aspect_time Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_srm
srm_xyoffset Spectrum, Lightcurve Control Flare position from Sun center [0,0] arcsec 0 - 1000 float(2) Expert hsi_srm
srt_filename Spectrum, Lightcurve Control Subcollimator response table srt_*.dat -- -- string Expert hsi_srm
use_segment Spectrum, Lightcurve Control If set, include the corresponding one of 18 detector segments [bytarr(9)+1,bytarr(9)] N/A -- byte(18) Advanced hsi_srm
verbose Spectrum, Lightcurve Control If set, print periodic status updates 0 N/A 0 -1 byte Advanced hsi_srm

* Control Parameters are set by the user to control the software; Info parameters are informational output parameters.

** Note that for parameters whose type is 'pointer', you can set the parameter without making it a pointer first - the object will take care of that.  And when you retrieve a parameter that is a pointer, unless you use the /NO_DEREFERENCE keyword on the call to GET, the contents of the pointer will be returned, not the pointer.

*** User Levels are:
   Standard - parameters that most users will want to set
   Advanced - parameters that require a high level of familiarity with the software
   Expert - parameters that should never be set by users

Last updated 18-Apr-2013 by Kim Tolbert , 301-286-3965