HESSI Data Object Parameters:  Spectrum Info Parameters

 

Links to other parameter tables:
     All      Spectrum (Standard, Info, All)      Lightcurve (Standard, Info, All)     
     Image:     General (Standard, Info, All),   Clean,   EM,   Forward Fit (ff),   MEM_GE (ge),   MEM_NJIT (nj),   Pixon,   UV_SMOOTH (uv),   VIS_CS,   VIS_FWDFIT (vf),   VIS_WV  
Spectral Response Matrix          Observing Summary          Simulation

 

Name Main Object Control / Info* Description Default Units Range Type** User Level*** Class
absolute_time_range Image, Spectrum, Lightcurve Info Time range of data that was used -- sec since 1979/1/1 00 -- double(2) N/A hsi_eventlist_strategy
artifact_edges Spectrum Info Energy edges used to create artifact mask -- -- -- pointer N/A hsi_artifact_mask
artifact_time Spectrum Info Time used to create artifact mask -- -- -- pointer N/A hsi_artifact_mask
binning Image, Spectrum, Lightcurve Info Binning scheme for spectrograms -- N/A -- pointer N/A hsi_spectrogram
channel_range Image, Spectrum, Lightcurve Info -- -- N/A -- pointer N/A hsi_eventlist_strategy
coincidence_mask Image, Spectrum, Lightcurve Info Not Used -- N/A -- pointer N/A hsi_eventlist_strategy
csa_lld Image, Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_eventlist_strategy
decim_table Image, Spectrum, Lightcurve Info Structure describing times, energies, and weights of decimation -- -- -- pointer N/A hsi_spectrogram
decim_warning Image, Spectrum, Lightcurve Info Message if decimation is faulty -- -- -- string N/A hsi_spectrogram
diagonal_obj Spectrum, Lightcurve Info Internal storage for the diagonal srm object -- -- -- pointer N/A hsi_srm
dim_spectrogram Image, Spectrum, Lightcurve Info Dimensions of spectrogram data array -- N/A -- pointer N/A hsi_spectrogram
dropout Image, Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_spectrogram
ev_sim_data Image, Spectrum, Lightcurve Info -- -- -- -- byte N/A hsi_eventlist_strategy
ev_ut_ref Image, Spectrum, Lightcurve Info -- -- -- -- struct(1) N/A hsi_eventlist_strategy
eventlist_strategy Image, Spectrum, Lightcurve Info Strategy used by GETDATA to get event lists HSI_EVENTLIST_PACKET N/A HSI_EVENTLIST_PACKET, HSI_EVENTLIST_SIMULATION string N/A hsi_eventlist
file_location Image, Spectrum, Lightcurve Info -- -- N/A -- pointer N/A hsi_packet_file
file_time_range Image, Spectrum, Lightcurve Info Start/end time of file specified in filename parameter -- ANYTIM -- double(2) N/A hsi_packet
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_binning_code Spectrum, Lightcurve Info Counts energy binning code used for SRM -- -- -- string N/A hsi_srm
info_ct_edges Spectrum, Lightcurve Info Count energy binning used in SRM' -- keV -- pointer N/A hsi_srm
info_dp_cutoff Image, Spectrum, Lightcurve Info Threshold for defining a data gap. -- sec -- pointer N/A hsi_eventlist_strategy
info_dp_extend Image, Spectrum, Lightcurve Info Number of seconds for pre, post gap extension -- sec -- float(2,18) N/A hsi_eventlist_strategy
info_dp_lld Image, Spectrum, Lightcurve Info User selectable gap closing lld. Not used as of Oct-02 -- -- -- int(9) N/A hsi_eventlist_strategy
info_ph_binning_code Spectrum, Lightcurve Info Photon energy binning code used for SRM -- -- -- string 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
interval_atten_state Image, Spectrum, Lightcurve Info atten state for each time interval, 0,1,2,3, -1 for transition -- -- -- pointer N/A hsi_spectrogram
last2 Image, Spectrum, Lightcurve Info Used internally -- -- -- pointer N/A hsi_eventlist_strategy
livetime_arr Image, Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_spectrogram
livetime_ctr Image, Spectrum, Lightcurve Info Livetime fraction from the livetime counters. Only one component of final livetime. -- -- -- pointer N/A hsi_spectrogram
lt_ut_ref Image, Spectrum, Lightcurve Info -- -- -- -- struct(1) N/A hsi_eventlist_strategy
mask_flag Spectrum Info Detector selection flag used -- N/A A2D, DET, SEG string N/A hsi_spectrum
n_event Image, Spectrum, Lightcurve Info -- 0 N/A -- long N/A hsi_eventlist_strategy
n_packet Image, Spectrum, Lightcurve Info Number of packets in the file (or in selection) -- N/A -- pointer N/A hsi_packet
num_rm Spectrum Info number of detectors/segments used for averaging to "per detector" -- -- -- int N/A hsi_spectrum
obs_time_interval Image, Spectrum, Lightcurve Info -- -- -- -- double(2) Expert hsi_eventlist_file_sim
offset_gain_str Image, Spectrum, Lightcurve Info -- -- -- -- struct(1) N/A hsi_spectrogram
packet_ref_time Image, Spectrum, Lightcurve Info -- 0.0 N/A -- double N/A hsi_packet
pileup_index Spectrum Info Indices of spectra with pileup correction -- -- -- pointer N/A hsi_pileup
sec2time_unit Image, Spectrum, Lightcurve Info -- 0.0 N/A -- double N/A hsi_spectrogram
shutter_correction Image, Spectrum, Lightcurve Info Fractional transmission through shutters (energy,det,attenstate) -- -- -- pointer N/A hsi_spectrogram
simulated_data Image, Spectrum, Lightcurve Info -- 0 N/A -- byte N/A hsi_packet
simulated_data Image, Spectrum, Lightcurve Info -- 0 N/A -- byte N/A hsi_fits
sp_atten_state Image, Spectrum, Lightcurve Info RAS, 17-feb-2002 -- -- -- pointer N/A hsi_spectrogram
sp_data_de Spectrum Info -- -- N/A -- pointer N/A hsi_spectrum
sp_data_dt Spectrum Info -- -- N/A -- pointer N/A hsi_spectrum
sp_det_index_mask Spectrum Info Not used -- N/A -- pointer N/A hsi_spectrum
sp_seg_index_mask Spectrum Info Not used -- N/A -- pointer N/A hsi_spectrum
srm_used_aspect_time Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_srm
this_a2d_index Image, Spectrum, Lightcurve Info A2d_index_mask used -- N/A -- pointer N/A hsi_spectrogram
this_det_index Image, Spectrum, Lightcurve Info Det_index_mask used -- N/A -- pointer N/A hsi_spectrogram
this_seg_index Image, Spectrum, Lightcurve Info Seg_index_mask used -- N/A -- pointer N/A hsi_spectrogram
total_count Image, Spectrum, Lightcurve Info -- -- N/A -- pointer N/A hsi_spectrogram
units_spectrogram Image, Spectrum, Lightcurve Info Units of spectrum -- N/A -- string N/A hsi_spectrogram
used_xyoffset Image, Spectrum, Lightcurve Info Value of xyoffset used. -- -- -- float(2) N/A hsi_spectrogram

* 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 21-Dec-2020 by Kim Tolbert , 301-286-3965