HESSI Data Object Parameters:  Simulation 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
sim_a2d_index_mask Image, Spectrum, Lightcurve Control Detector/segment selection All 1s N/A -- byte(27) Advanced hsi_simulation
sim_atten_state Image, Spectrum, Lightcurve Control Attenuator state. 0=no attenuators, 1=Thin in, thick out, 2=thick in, thin out, 3=both in. 1 N/A 0,1,2,3 byte Advanced hsi_simulation
sim_background Image, Spectrum, Lightcurve Control Factor to multiply background spectrum given by HESSI_BACKGROUND 0.0 N/A -- float Advanced hsi_simulation
sim_bkgd_interp_dt Image, Spectrum, Lightcurve Control Same meaning as sim_interp_dt, for background 0.0 N/A -- float Advanced hsi_simulation
sim_bkgd_interp_tprofile Image, Spectrum, Lightcurve Control Same meaning as sim_interp_tprofile, for background 0 N/A -- byte Advanced hsi_simulation
sim_bkgd_photon_energy Image, Spectrum, Lightcurve Control Same meaning as sim_photon_energy, for background -- -- -- pointer Advanced hsi_simulation
sim_bkgd_photon_flux Image, Spectrum, Lightcurve Control Same meaning as sim_photon_flux, for background -- -- -- pointer Advanced hsi_simulation
sim_bkgd_photon_times Image, Spectrum, Lightcurve Control Same meaning as sim_photon_times, for background -- -- -- pointer Advanced hsi_simulation
sim_bkgd_photons_per_coll Image, Spectrum, Lightcurve Control Same meaning as sim_photons_per_coll, for background 0. N/A -- float Advanced hsi_simulation
sim_bkgd_spec_model Image, Spectrum, Lightcurve Control Same meaning as sim_spec_model, for background -- N/A -- string Advanced hsi_simulation
sim_bkgd_spec_pars Image, Spectrum, Lightcurve Control Same meaning as sim_spec_pars, for background -- N/A -- pointer Advanced hsi_simulation
sim_bkgd_time_range Image, Spectrum, Lightcurve Control Same meaning as sim_time_range, for background -- N/A -- double(2) Advanced hsi_simulation
sim_bkgd_time_unit Image, Spectrum, Lightcurve Control Same meaning as sim_time_unit, for background 0 binary microsec (2^-20 sec) -- int Advanced hsi_simulation
sim_bkgd_tprofile Image, Spectrum, Lightcurve Control Same meaning as sim_photon_tprofile, for background -- -- -- pointer Advanced hsi_simulation
sim_bkgd_ut_ref Image, Spectrum, Lightcurve Control Same meaning as sim_ut_ref, for background 0.0 N/A -- double Advanced hsi_simulation
sim_diagonal_srm Image, Spectrum, Lightcurve Control If set, use diagonal detector response matrix for the simulation 0 -- o - 1 byte Advanced hsi_simulation
sim_energy_band Image, Spectrum, Lightcurve Control Energy band for simulation [6.,100.] keV -- pointer Advanced hsi_simulation
sim_gain_generation Image, Spectrum, Lightcurve Control Code for gain-generation. 0=old, 1=new, 2=on-orbit? 1 N/A -- int Advanced hsi_simulation
sim_gain_time_wanted Image, Spectrum, Lightcurve Control -- 0.0 N/A -- double Advanced hsi_simulation
sim_interp_dt Image, Spectrum, Lightcurve Control Time interval for interpolating option (sim_interp_tprofile) 1/128 sec -- float Advanced hsi_simulation
sim_interp_tprofile Image, Spectrum, Lightcurve Control If set, interpolate time profile to smaller bins 0 N/A 0 - 1 byte Advanced hsi_simulation
sim_just_background Image, Spectrum, Lightcurve Control If set, only background counts are produced 0 N/A 0 - 1 byte Advanced hsi_simulation
sim_max_size Image, Spectrum, Lightcurve Control Default 1d max dimension 128 N/A -- float Advanced hsi_simulation
sim_model Image, Spectrum, Lightcurve Control Model for source for simulation -- N/A -- pointer Advanced hsi_simulation
sim_nbuff Image, Spectrum, Lightcurve Control Max number of photons processed at one time. Set higher if you have more memory. 5.e5 N/A -- float Advanced hsi_simulation
sim_out_time_unit Image, Spectrum, Lightcurve Info -- 0 N/A -- long N/A hsi_simulation
sim_photon_energy Image, Spectrum, Lightcurve Control photon energies for the input photon flux -- keV -- pointer Advanced hsi_simulation
sim_photon_flux Image, Spectrum, Lightcurve Control Photon flux array, (nenergies, ntimes, nsources) -- photons/cm^2/sec/keV -- pointer Advanced hsi_simulation
sim_photon_times Image, Spectrum, Lightcurve Control Time array (rel to sim_ut_ref) for the input photon flux -- sec -- pointer Advanced hsi_simulation
sim_photon_tprofile Image, Spectrum, Lightcurve Control Time profile to use when shape of spectrum doesn't vary with time -- -- -- pointer Advanced hsi_simulation
sim_photons_per_coll Image, Spectrum, Lightcurve Control Set overall flux level of simulated data 10000. photons/sec/coll -- float Advanced hsi_simulation
sim_pixel_size Image, Spectrum, Lightcurve Control Pixel size when using a model image 1 arcsec -- float Advanced hsi_simulation
sim_quiet Image, Spectrum, Lightcurve Control If set, supress diagnostic print statements in hsi_model_to_score 0 N/A -- byte Advanced hsi_simulation
sim_saszero Image, Spectrum, Lightcurve Control If set, aspect solution is constant with pointing=[0,0] and roll_period=4 0 N/A -- byte Advanced hsi_simulation
sim_seed Image, Spectrum, Lightcurve Control Seed for random number routines. Set it to reproduce results. 0 N/A -- int Advanced hsi_simulation
sim_spec_model Image, Spectrum, Lightcurve Control Spectral model f_bpow N/A -- string Advanced hsi_simulation
sim_spec_pars Image, Spectrum, Lightcurve Control Spectral parameters for the given model -- N/A -- pointer Advanced hsi_simulation
sim_srt_filename Image, Spectrum, Lightcurve Control Grid response data file to use. Default is latest version. -- N/A -- string Advanced hsi_simulation
sim_ssr_state Image, Spectrum, Lightcurve Control Measure of how full SSR memory is. 0=empty, 8=full 0 N/A -- byte Advanced hsi_simulation
sim_time_range Image, Spectrum, Lightcurve Control Time range of simulation, relative to sim_ut_ref [0,4] sec -- double(2) Advanced hsi_simulation
sim_time_unit Image, Spectrum, Lightcurve Control Time unit of the time tag in the eventlist. 1 binary microsec (2^-20 sec) -- int Advanced hsi_simulation
sim_use_bkgd_spectrum Image, Spectrum, Lightcurve Control Same meaning as sim_use_spectrum, for background 0 N/A -- byte Advanced hsi_simulation
sim_use_spectrum Image, Spectrum, Lightcurve Control If set, use an input spectrum or model spectrum to create simulations. 0 N/A 0 - 1 byte Advanced hsi_simulation
sim_ut_ref Image, Spectrum, Lightcurve Control Reference time for simulation -- ANYTIM -- double Advanced hsi_simulation
sim_ut_ref Image, Spectrum, Lightcurve Info Reference time for simulation -- ANYTIM -- double Advanced hsi_simulation
sim_xyoffset Image, Spectrum, Lightcurve Control Center of the simulation box [600,200] N/A -- float(2) Advanced hsi_simulation

* 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 1-Nov-2010 by Kim Tolbert , 301-286-3965