HESSI Data Object Parameters:  Image Info 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
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
alg_unit_scale Image Info -- 0.0 N/A -- float N/A hsi_image_single
algorithm_available Image Info -- -- N/A -- pointer N/A hsi_image_single
algorithm_units Image Info -- -- N/A -- pointer N/A hsi_image_single
algorithm_used Image Info -- -- N/A -- string N/A hsi_image_single
as_quality Image Info -- -- -- -- struct(1) N/A hsi_aspect_solution
avg_spinperiod Image Info -- -- -- -- float N/A hsi_aspect_solution
be_time_info Image Info -- -- -- -- pointer N/A hsi_binned_eventlist
binned_n_event Image Info Total counts in each detector for selected energy range -- N/A -- long(9) N/A hsi_binned_eventlist
binned_n_event Image Info Total counts in each detector for selected energy range -- -- -- long(9) N/A hsi_calib_eventlist
binning Image, Spectrum, Lightcurve Info Binning scheme for spectrograms -- N/A -- pointer N/A hsi_spectrogram
bproj_alg_available Image Info -- -- N/A -- pointer N/A hsi_bproj
cbe_corr_factors Image Info Not used -- -- -- float(9) N/A hsi_calib_eventlist
cbe_det_eff Image Info -- -- N/A -- pointer N/A hsi_calib_eventlist
cbe_det_index_mask_used Image Info Not used -- -- -- byte(9) N/A hsi_calib_eventlist
channel_range Image, Spectrum, Lightcurve Info -- -- N/A -- pointer N/A hsi_eventlist_strategy
coincidence_mask Image, Spectrum, Lightcurve Info -- -- 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
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
im_out_fits_filename Image Info If set to a string, a FITS file will be written containing the image (or image cube) -- -- -- string N/A hsi_image_strategy
image_atten_state Image Info Attenuator state during image -- -- -- int N/A hsi_calib_eventlist
image_units Image Info -- -- N/A -- string N/A hsi_image_single
img_strategy_available Image Info -- -- N/A -- pointer N/A hsi_modul_pattern
info_dp_cutoff Image, Spectrum, Lightcurve Info Threshold for defining a data gap. -- sec -- pointer 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
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
n_bin Image Info Number of bins for each detector and harmonics -- N/A -- long(9,3) N/A hsi_binned_eventlist
n_event Image, Spectrum, Lightcurve Info -- 0 N/A -- long N/A hsi_eventlist_strategy
n_images_done Image Info -- -- -- -- long N/A hsi_image_strategy
n_modpat Image Info -- 0 N/A -- long N/A hsi_annsec_pattern
n_packet Image, Spectrum, Lightcurve Info Number of packets in the file (or in selection) -- N/A -- pointer N/A hsi_packet
obs_time_interval Image, Spectrum, Lightcurve Info -- -- -- -- double(2) Expert hsi_eventlist_file_sim
off_det_index Image Info If set, then no valid times for this detector -- -- -- byte(9) N/A hsi_calib_eventlist
offaxis_disp Image Info -- -- -- -- float N/A hsi_calib_eventlist
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
phz_n_roll_bins_info Image Info Number of roll bins used for each grid -- -- -- long(9) N/A hsi_calib_eventlist
pixel_area Image Info -- 0.0 N/A -- float N/A hsi_image_single
rmap_dim Image Info -- -- N/A -- int(2) N/A hsi_annsec_pattern
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
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
ut_binned_eventlist Image Info -- -- -- -- pointer N/A hsi_binned_eventlist
valid_binned_index Image Info -- -- -- -- pointer N/A hsi_binned_eventlist
vis_corr_factors Image Info Normalization correction factors for each detector -- -- -- float(9) N/A hsi_visibility
vis_det_index_mask_used Image Info Byte array showing which detectors had acceptable visibilities and were used -- -- -- byte(9) N/A hsi_visibility
vis_map Image Info Not used -- -- -- objref N/A hsi_visibility

* 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 7-May-2009 by Kim Tolbert , 301-286-3965