HESSI Data Object Parameters:  Lightcurve 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
a2d_index_mask Image, Spectrum, Lightcurve Control Mask for the selection of a2d events BytArr(27) + 1B N/A 0 - 1 byte(27) Expert hsi_eventlist_strategy
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
adp_test Image, Spectrum, Lightcurve Control If set, some selection tests are done for the aspect data processor 0 N/A 0 - 1 byte(10) Expert hsi_packet_file
align512 Image, Spectrum, Lightcurve Control Align time edges to 512 busec boundaries used with livetime 1 -- -- int Expert hsi_spectrogram
app_id Image, Spectrum, Lightcurve Control Only packets with this or these app id(s) are returned (scalar or vector) All N/A 0 - 300 pointer Expert hsi_packet_file
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
atten0_test Image, Spectrum, Lightcurve Control If counter livetime is below this threshold in att0, disable data during ramp epoch after 2014 0.300000 -- -- float Expert hsi_data_gap
atten_state Spectrum, Lightcurve Control Attenuator setting 1 N/A -- byte Advanced hsi_srm
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
check_bad_packet Image, Spectrum, Lightcurve Control -- 0 -- -- byte Expert hsi_packet_file
clear_front_fullscale Image, Spectrum, Lightcurve Control If set, remove artifacts from events in spectrum accumulation 0 -- 0 - 1 int Expert hsi_spectrogram
clear_halfscale Image, Spectrum, Lightcurve Control If set, remove half-scale artifact from the rear high-gain a2d of all detectors 1 -- 0 - 1 int Expert hsi_spectrogram
coincidence_flag Image, Spectrum, Lightcurve Control If set, divide the spectrogram into coincident and anti-coincident events 0 N/A 0 - 1 int Advanced hsi_spectrogram
coincidence_mask Image, Spectrum, Lightcurve Info Not Used -- N/A -- pointer N/A hsi_eventlist_strategy
compute_offax_position Spectrum, Lightcurve Control If set, compute offax_position. 1 -- 0 - 1 int Expert hsi_srm
contig_energy_edges Image, Spectrum, Lightcurve Control If set, force energy bins to be contiguous 1 N/A 0 - 1 int Advanced hsi_spectrogram
csa_lld Image, Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_eventlist_strategy
ct_edges Spectrum, Lightcurve Control Define counts binning 2 N/A -- pointer Advanced hsi_srm
ct_interpolate Image, Spectrum, Lightcurve Control -- 0 -- -- byte Expert hsi_eventlist_strategy
cull_frac Image, Spectrum, Lightcurve Control Fraction for defining data gaps for culling 1.0 -- 0. - 1. float Standard hsi_spectrogram
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
decim_apar Image, Spectrum, Lightcurve Control Spectral parameters (vth+bpow) for decimation factor interpolation [1.,2.,1.,4.,400.,4.] -- -- pointer Expert hsi_spectrogram
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
decimation_correct Image, Spectrum, Lightcurve Control If set, make front decimation correction 1 -- 0 - 1 int Standard hsi_spectrogram
deflt_atten_state Image, Spectrum, Lightcurve Control Use this value for attenuator state if can't read it from packet. Used with sim data. 1 -- -- byte Expert hsi_eventlist_strategy
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
display_result Spectrum, Lightcurve Control If set, plot the final matrices 0 N/A 0 - 1 byte Advanced hsi_srm
dp_append_def Image, Spectrum, Lightcurve Control Replaces dp_extend_def or dp_extend_sec if this is greater -- -- -- float(18) Expert hsi_dp_extend
dp_append_nvalid Image, Spectrum, Lightcurve Control Append dropout with this many valid events -- -- -- int(18) Expert hsi_dp_extend
dp_cutoff_coeff Image, Spectrum, Lightcurve Control Used in function to determine min datagap duration 4.5 -- -- float Expert hsi_dp_cutoff
dp_cutoff_max Image, Spectrum, Lightcurve Control Dropout cutoff, max duration for dropout to be recognized 0.05 sec -- float Expert hsi_dp_cutoff
dp_cutoff_min Image, Spectrum, Lightcurve Control Dropout cutoff, min duration for dropout to be recognized 0.0008 sec -- float Expert hsi_dp_cutoff
dp_cutoff_xp Image, Spectrum, Lightcurve Control Used in function to determine min datagap duration -0.9 -- -- float Expert hsi_dp_cutoff
dp_enable Image, Spectrum, Lightcurve Control If set, handle dropouts 1 -- 0 - 1 int Expert hsi_data_gap
dp_extend_def Image, Spectrum, Lightcurve Control Extend datagap by this if data time is before dp_extend_utlim fltarr(9) sec -- float(18) Expert hsi_dp_extend
dp_extend_sec Image, Spectrum, Lightcurve Control Extend datagap by this if data time is after dp_extend_utlim [.01,.01,.01,01,.02,.01,.02,.02,.02] sec -- float(18) Expert hsi_dp_extend
dp_extend_utlim Image, Spectrum, Lightcurve Control Time for each detector to decide whether to extend datagap by dp_extend_def or dp_extend_sec -- ANYTIM -- double(18) Expert hsi_dp_extend
dp_lld Image, Spectrum, Lightcurve Control Events at this channel or below don't end datagap 51,49,52,54,52,44,50,46,40 -- -- int(18) Expert hsi_data_gap
dp_prepend_def Image, Spectrum, Lightcurve Control Prepend dropout with this many seconds -- -- -- float(18) Expert hsi_dp_extend
dp_prepend_nvalid Image, Spectrum, Lightcurve Control Prepend dropout with this many valid events -- -- -- int(18) Expert hsi_dp_extend
dp_uld Image, Spectrum, Lightcurve Control Events at this channel or above don't end datagap onarr(9)+6000 -- -- long(18) Expert hsi_data_gap
dropout Image, Spectrum, Lightcurve Info -- -- -- -- pointer N/A hsi_spectrogram
earth_position Spectrum, Lightcurve Control Earth Position 180. N/A -- pointer Advanced hsi_srm
energy_band Image, Spectrum, Lightcurve Control Not used. [12,25] keV 1 - 15000 float(2) Standard hsi_eventlist_strategy
ev_filename Image, Spectrum, Lightcurve Control Name of eventlist file to use as input -- -- -- string Standard hsi_eventlist_file
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
eventlist_strategy Image, Spectrum, Lightcurve Control Strategy used by GETDATA to get event lists HSI_EVENTLIST_PACKET N/A HSI_EVENTLIST_PACKET, HSI_EVENTLIST_SIMULATION string N/A hsi_eventlist
evl_rollover_test Image, Spectrum, Lightcurve Control If time[i] - time[i+1] gt evl_rollover_test then it is a time rollover of 1024 usec (otherwise it's a race condition) 12 -- -- int Expert hsi_eventlist_strategy
extend_time_range Image, Spectrum, Lightcurve Control Internal parameter - extends time to find dropouts 2.0 -- -- float Expert hsi_data_gap
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
file_type Image, Spectrum, Lightcurve Control File type fits N/A fits, gse, itos, raw string Expert hsi_packet
filename Image, Spectrum, Lightcurve Control Name(s) of the level-0/telemetry data file(s) None N/A -- pointer Standard hsi_packet_file
flare_xyoffset Image, Spectrum, Lightcurve Control Not used [0.,0.] arcsec 0 - 1000 float(2) Expert hsi_xyoffset
fr_deadtime_window Image, Spectrum, Lightcurve Control If set, remove rear events that occur without possibility of a front veto because of data gap. Used only for polarization analysis. 0 -- -- int Expert hsi_eventlist_strategy
gain_generation Image, Spectrum, Lightcurve Control -- 1000 N/A -- int Expert hsi_eventlist_strategy
gain_time_wanted Image, Spectrum, Lightcurve Control -- 0.0 N/A -- double Expert hsi_eventlist_strategy
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
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
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
livetime_enable Image, Spectrum, Lightcurve Control default is to process and use livetime 1 -- -- int Expert hsi_spectrogram
lt_ut_ref Image, Spectrum, Lightcurve Info -- -- -- -- struct(1) N/A hsi_eventlist_strategy
ltc_energy_band Lightcurve Control Energy band(s) for the lightcurve [3,15000] keV 1 - 15000 pointer Standard hsi_lightcurve
ltc_time_range Lightcurve Control Time range for the light curve relative to obs_time_interval [0,0] sec 0 - 1.e9 double(2) Standard hsi_lightcurve
ltc_time_resolution Lightcurve Control Lightcurve time bin size .1 sec .001 - ? float Standard hsi_lightcurve
min_time_4_off Image, Spectrum, Lightcurve Control Minimum time without events to consider detectors off 0.1 -- -- float Expert hsi_eventlist_strategy
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
no_csa_dropout Image, Spectrum, Lightcurve Control If this is set, then dropoutlist compiled w/o using csa 1 -- 0 - 1 int Expert hsi_data_gap
no_livetime Image, Spectrum, Lightcurve Control -- 0 -- -- byte Expert hsi_eventlist_strategy
number_of_half_rotations Image, Spectrum, Lightcurve Control Not used 0 -- -- int Expert hsi_eventlist_strategy
obs_time_interval Image, Spectrum, Lightcurve Control Absolute time interval to retrieve data for. [0.d,0.d] ANYTIM -- double(2) Standard hsi_packet_file
obs_time_interval Image, Spectrum, Lightcurve Control -- -- -- -- double(2) Expert hsi_eventlist_file_sim
obs_time_interval Image, Spectrum, Lightcurve Info -- -- -- -- double(2) Expert hsi_eventlist_file_sim
offax_position Spectrum, Lightcurve Control Angle between source and imaging axis .25 degrees -- pointer Advanced hsi_srm
offset_gain_str Image, Spectrum, Lightcurve Info -- -- -- -- struct(1) N/A hsi_spectrogram
other_a2d_index_mask Image, Spectrum, Lightcurve Control Set which other a2ds to return spectrum for -- N/A 0 - 1 byte(27) Advanced hsi_spectrogram
packet_per_bunch Image, Spectrum, Lightcurve Control Number of packets to read in a each read operation 5000 N/A -- long Expert hsi_packet_file
packet_ref_time Image, Spectrum, Lightcurve Info -- 0.0 N/A -- double N/A hsi_packet
packet_time_range Image, Spectrum, Lightcurve Control -- -- N/A -- double(2) Expert hsi_packet_file
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
poisson Image, Spectrum, Lightcurve Control Not used 0 N/A -- byte Expert hsi_spectrogram
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
ramp_ebulk Image, Spectrum, Lightcurve Control Upper limit on photon energy (keV) when searching for the bulk median 40.0000 -- -- float Expert hsi_data_gap
ramp_emax Image, Spectrum, Lightcurve Control Cap on energy (keV) of events for ramp analysis 300.000 -- -- float Expert hsi_data_gap
ramp_emin Image, Spectrum, Lightcurve Control Once below emin, the ramp is over (but emin used may be lower depending on the atten state, may be modified) 20.0000 -- -- float Expert hsi_data_gap
ramp_epeak Image, Spectrum, Lightcurve Control Threshold energy in keV for defining ramps 35.0000 -- -- float Expert hsi_data_gap
ramp_ntest Image, Spectrum, Lightcurve Control Number of consecutive values over bulk threshold required to be a ramp 6 -- -- int Expert hsi_data_gap
rear_decimation_correct Image, Spectrum, Lightcurve Control If set, make rear decimation correction 0 -- 0 -1 int Standard hsi_spectrogram
rear_no_anti Image, Spectrum, Lightcurve Control If set, don't remove counts from rear segments based on coincidence flag 1 -- -- int Expert hsi_spectrogram
rebin_method Image, Spectrum, Lightcurve Control Place-holder for spectral dependent rebinning -- N/A -- string Expert hsi_spectrogram
rebin_poisson_flag Image, Spectrum, Lightcurve Control Place-holder for poisson option for rebinning 0 N/A -- int Expert hsi_spectrogram
rebin_seed Image, Spectrum, Lightcurve Control Place-holder for poisson seed option for rebinning 0 N/A -- int Expert hsi_spectrogram
sec2time_unit Image, Spectrum, Lightcurve Info -- 0.0 N/A -- double N/A hsi_spectrogram
seed Image, Spectrum, Lightcurve Control Not used 0.0 N/A -- float Expert hsi_spectrogram
seg_index_mask Image, Spectrum, Lightcurve Control Flags for selecting detector and segment All 0 N/A 0 - 1 byte(18) Standard hsi_spectrogram
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
shutter_correction Image, Spectrum, Lightcurve Info Fractional transmission through shutters (energy,det,attenstate) -- -- -- pointer N/A hsi_spectrogram
simplify Spectrum, Lightcurve Control Code to select submatrix terms to use bytarr(10) N/A 0 - 3 pointer Advanced hsi_srm
simulated_data Image, Spectrum, Lightcurve Info -- 0 N/A -- byte N/A hsi_fits
simulated_data Image, Spectrum, Lightcurve Info -- 0 N/A -- byte N/A hsi_packet
sp_atten_state Image, Spectrum, Lightcurve Info RAS, 17-feb-2002 -- -- -- pointer N/A hsi_spectrogram
sp_data_structure Spectrum, Lightcurve Control If set, then GETDATA returns a structure with data (counts, rate, or flux) and errors. 0 N/A 0 - 1 byte Standard hsi_spectrum
sp_data_unit Spectrum, Lightcurve Control Type of data to return in spectrum - counts, counts/sec, or counts/sec/cm^2/keV Counts N/A Counts, Rate, Flux string Standard hsi_spectrum
sp_dp_cutoff Image, Spectrum, Lightcurve Control This functionality is disabled 17-nov-02 0.0 -- -- float Expert hsi_spectrogram
sp_energy_binning Image, Spectrum, Lightcurve Control Defines energy binning. If scalar, interpret as code for predefined energy bins, otherwise as energy edges 14 N/A 0 - ? pointer Standard hsi_spectrogram
sp_semi_calibrated Spectrum, Lightcurve Control If set, calibrates the count rate spectrum using only the diagonal elements of the response matrix 0 N/A 0 - 1 byte Standard hsi_spectrum
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
sum_coincidence Image, Spectrum, Lightcurve Control If set, sum the anti-coincidence and coincidence spectrum 0 -- -- int Expert hsi_spectrogram
sum_flag Image, Spectrum, Lightcurve Control If set, sum the spectrograms over collimators 0 N/A 0 - 1 int Standard hsi_spectrogram
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
time_range Image, Spectrum, Lightcurve Control Time range to accumulate relative to obs_time_interval, or absolute [0,4] sec or ANYTIM 0 - ? double(2) Standard hsi_eventlist_strategy
time_unit Image, Spectrum, Lightcurve Control Time unit used in the eventlist time tags 1 binary microsec (2^-20 sec) 1 - 32 int Expert hsi_eventlist_strategy
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
use_cull Image, Spectrum, Lightcurve Control If set, culling is enabled. Default is 1 for imaging, 0 for spectrum. 0 -- 0 - 1 int Standard hsi_spectrogram
use_flare_xyoffset Image, Spectrum, Lightcurve Control If set, use flare position from catalog for xyoffset. 1 -- 0 - 1 int Standard hsi_xyoffset
use_segment Spectrum, Lightcurve Control If set, include the corresponding detector segments in the SRM (0-8: front, 9-17: rear). If making SRM through spectrum obj, use seg_index_mask instead. [bytarr(9)+1,bytarr(9)] N/A -- byte(18) Advanced hsi_srm
use_total_count Image, Spectrum, Lightcurve Control For developers only. Total_count is normally not used 0 -- -- int Expert hsi_spectrogram
used_xyoffset Image, Spectrum, Lightcurve Info Value of xyoffset used. -- -- -- float(2) N/A hsi_spectrogram
verbose Spectrum, Lightcurve Control If set, print periodic status updates 0 N/A 0 -1 byte Advanced hsi_srm
xyoffset Image, Spectrum, Lightcurve Control Offset of map center from Sun center [600.,200.] arcsec 0 - 1000 float(2) Standard hsi_xyoffset

* 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 4-Sep-2024 by Kim Tolbert , 301-286-3965