HESSI Data Object Parameters:  Observing Summary 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
a0 Obs Info Scaling factor; Roll Angle = a1*data+a0 0.0 N/A -- float N/A hsi_qlook_roll_angle
a0 Obs Info Scaling factor; Pointing = a1*data+a0 -1280. N/A -- float N/A hsi_qlook_pointing
a1 Obs Info Scaling factor; Roll Angle = a1*data+a0 2*pi*255 N/A -- float N/A hsi_qlook_roll_angle
a1 Obs Info Scaling factor; Pointing = a1*data+a0 10. N/A -- float N/A hsi_qlook_pointing
app_id Obs Info app_ids -- -- -- int(47) N/A hsi_qlook_packet_rate
class_name Obs Control Class name to retrieve data for. -- N/A -- string Standard hsi_qlook
concat_flag Obs Info If set, summaries are concatenated. 0 N/A -- int N/A hsi_obssumm
concat_flag Obs Info If set, data is concatenated. 0 N/A -- int N/A hsi_qlook_image
data_dir Obs Control Use with filename param. Directory obs summ file is in. -- N/A -- string Standard hsi_obs_summary
det_index_mask Obs Control Not used [0,0,0,1,1,1,1,1,0] N/A 0 - 1 byte(18) Standard hsi_monitor_rate
dim2_ids Obs Info "P_roll" -- -- -- string N/A hsi_qlook_roll_period
dim2_ids Obs Info Segment Ids -- -- -- string(18) N/A hsi_full_rate
dim2_ids Obs Info ["ASCNODE", "PHASE"] -- -- -- string(2) N/A hsi_ephemeris
dim2_unit Obs Info "Roll Phase" -- -- -- string N/A hsi_qlook_roll_period
dim2_unit Obs Info SC node and phase -- -- -- string N/A hsi_ephemeris
dim2_unit Obs Info Detector id -- -- -- string N/A hsi_full_rate
dtime Obs Info -- 0.0 N/A -- float N/A hsi_monitor_rate
end_time Obs Info -- 0.0 N/A -- double N/A hsi_qlook_image
energy_band Obs Control -- -- N/A -- float(2) Expert hsi_qlook
energy_edges Obs Info The energy bin edges -- N/A -- float(2) N/A hsi_modvariance
energy_edges Obs Info Energy bin edges -- -- -- float(10) N/A hsi_full_rate
energy_edges Obs Info the energy bin edges -- N/A -- float(10) N/A hsi_obssummrate
filename Obs Control File (including path) to retrieve data from. Ignored if obs_time_interval is set. -- N/A -- pointer Standard hsi_qlook
filename Obs Control File to retrieve data from. -- N/A -- pointer Standard hsi_obs_summary
fits_header Obs Control Contains the fits headers for the appropriate extension -- -- -- pointer Expert hsi_qlook
flag_ids Obs Info string identifiers for each data flag, -- N/A -- string(32) N/A hsi_obssummflag
id_string Obs Control An identifying string -- N/A -- string Advanced hsi_qlook
mon_ut_ref Obs Info -- 0.0 N/A -- double N/A hsi_monitor_rate
mr_time_range Obs Control Not used. Use obs_time_interval to specify time range. [0,0] sec 0 - 100 double(2) Expert hsi_monitor_rate
n_energy_bands Obs Info the number of energy bands 0 N/A -- int N/A hsi_obssummrate
n_energy_bands Obs Info Number of energy bands -- -- -- int N/A hsi_full_rate
n_images Obs Info the number of images 0 N/A -- long N/A hsi_qlook_image
ncyles Obs Info -- 0 N/A -- long N/A hsi_monitor_rate
nflags Obs Info the number of data flags 0 N/A -- int N/A hsi_obssummflag
no_102 Obs Control If set, read app id 152, otherwise 102 0 -- 0 - 1 byte Expert hsi_monitor_rate
nodata Obs Control -- 0 N/A -- byte Expert hsi_qlook
obs_time_interval Obs Control Absolute time interval to retrieve data for. -- ANYTIM -- double(2) Standard hsi_qlook
obs_time_interval Obs Control Absolute time interval to retrieve data for. -- ANYTIM -- double(2) Standard hsi_obs_summary
read_from_archive Obs Control -- 0 -- -- byte Expert hsi_qlook
seg_index_mask Obs Info detector ids -- N/A -- byte(18) N/A hsi_obssummrate
simulated_data Obs Info If set, data is simulated. 0 N/A -- int N/A hsi_obssumm
start_time Obs Info start time 0.0 N/A -- double N/A hsi_qlook_image
summary_end_time Obs Info Start time of summary data. -- N/A -- string N/A hsi_obssumm
summary_start_time Obs Info Start time of summary data. -- N/A -- string N/A hsi_obssumm
time_range Obs Control Absolute time range of data to retrieve. Used only if filename is set. -- ANYTIM -- double(2) Standard hsi_qlook
variance_nbin Obs Info the number of time bins per spin period 0 N/A -- int N/A hsi_modvariance
vers_data Obs Control Version number for data 0 N/A -- int Advanced hsi_qlook
vers_info Obs Control Version number for info 0 N/A -- int Advanced hsi_qlook
version Obs Control version number 0 N/A -- int Advanced hsi_qlook

* 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 8-Jan-2021 by Kim Tolbert , 301-286-3965