HESSI Data Object Parameters:  Image Standard 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
aspect_cntl_level Image Control Control amount of diagnostic information presented. Higher number = more. 0 N/A -2 - 10 int Standard hsi_aspect_solution
cbe_filename Image Control Calib eventlist filename (input and/or output file) -- -- -- string Standard hsi_calib_eventlist
clean_box Image Control CLEAN Alg: Define clean boxes (where we expect sources to be) 0 N/A -- pointer Standard hsi_clean
clean_cw_inverse Image Control CLEAN Alg: If set, use area outside clean box instead of inside 0 -- -- int Standard hsi_clean
clean_cw_list Image Control CLEAN Alg: Define clean boxes (where we expect sources to be) 0 N/A -- pointer Standard hsi_clean
clean_cw_nop Image Control CLEAN Alg: Define clean boxes (where we expect sources to be) 0 N/A -- pointer Standard hsi_clean
clean_mark_box Image Control CLEAN Alg: If set, graphically mark clean boxes on dirty map 0 N/A 0 - 1 int Standard hsi_clean
clean_more_iter Image Control CLEAN Alg: If set, resume cleaning from previous results 0 N/A 0 - 1 int Standard hsi_clean
clean_niter Image Control CLEAN Alg: Max number of iterations 100 N/A 1 - ? int Standard hsi_clean
clean_profile_no_resid Image Control CLEAN Alg: If set, remove residuals from profile cstat and plot (for regress_combine="full_resid" or "disable") 1 -- 0 - 1 int Standard hsi_clean
clean_progress_bar Image Control CLEAN Alg: If set, display progress bar with cancel button 1 N/A 0 - 1 int Standard hsi_clean
clean_regress_combine Image Control CLEAN Alg: Method for combining the component map and residual map. 0 -- disable, full_resid, scaled_resid, old_scaled_resid, no_resid string Standard hsi_clean
clean_show_chi Image Control CLEAN Alg: If set, plot chi-square while iterating 1 N/A 0 - 1 int Standard hsi_clean
clean_show_map_xdim Image Control CLEAN Alg: X size of plot window for intermediate results 1024 pixel -- int Standard hsi_clean
clean_show_maps Image Control CLEAN Alg: If set, show intermediate maps 1 N/A 0 - 1 int Standard hsi_clean
clean_show_n_chi Image Control CLEAN Alg: Show every n'th chi-square plot while iterating' 1 -- -- int Standard hsi_clean
clean_show_n_maps Image Control CLEAN Alg: Show every n'th map while iterating 1 -- -- int Standard hsi_clean
cull_frac Image, Spectrum, Lightcurve Control Fraction for defining data gaps for culling 1.0 -- 0. - 1. float Standard hsi_spectrogram
decimation_correct Image, Spectrum, Lightcurve Control If set, make front decimation correction 1 -- 0 - 1 int Standard hsi_spectrogram
det_index_mask Image Control Flags for selecting detectors [0,0,0,1,1,1,1,1,0] N/A 0 - 1 byte(9) Standard hsi_binned_eventlist
eb_index Image Control Selects the energy bin to use. 0 -- -- int Standard hsi_calib_eventlist
em_map_window Image Control EM Alg: map window holder -1 -- -- int Standard hsi_em
em_max_iterations Image Control EM Alg: Maximum # iterations, used if stopping rule fails (normally set high to use stopping rule) 500 -- -- long Standard hsi_em
em_max_maps_saved Image Control EM Alg: Maximum # maps to put in info parameter, evenly spaced. Set to -1 for all. 1 means only save first map after dirty map 1 -- -- int Standard hsi_em
em_progress_bar Image Control EM Alg: If set, show progress bar 0 -- 0 - 1 int Standard hsi_em
em_show_maps Image Control EM Alg: If set, show intermediate maps 0 -- 0 - 1 int Standard hsi_em
em_show_n_maps Image Control EM Alg: Show every nth map 20 -- -- int Standard hsi_em
em_tolerance Image Control EM Alg: Tolerance used in stopping rule, gives good heuristic results 0.100000 -- -- float Standard hsi_em
energy_band Image Control Min and max energy value of the analysis interval -- keV -- float(2) Standard hsi_calib_eventlist
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
ff_background_det Image Control FF Alg: If set, forward-fit includes detector background in time profiles 0 -- 0 - 1 int Standard hsi_forwardfit
ff_background_map Image Control FF Alg: If set, forward-fit includes background of unmodulated sources 0 -- 0 - 1 int Standard hsi_forwardfit
ff_ftol Image Control FF Alg: Tolerance for convergence 0.0001 N/A >0 float Standard hsi_forwardfit
ff_min_sigma Image Control FF Alg: Minimum sigma in modulation for a detector to be included 0.0 N/A -- float Standard hsi_forwardfit
ff_minsep Image Control FF Alg: Minimum separation required between centroids of adjacent gaussians 0.0 arcsec >0 float Standard hsi_forwardfit
ff_n_gaussians Image Control FF Alg: Number of gaussian components 1 N/A >1 int Standard hsi_forwardfit
ff_n_par Image Control FF Alg: Number of free parameters per gaussian component 4 N/A 4,6,7 int Standard hsi_forwardfit
ff_nitmax Image Control FF Alg: Max number of iterations 10 N/A >3 int Standard hsi_forwardfit
ff_progress_bar Image Control FF Alg: If set, show progress bar with cancel option 1 N/A 0 - 1 int Standard hsi_forwardfit
ff_savefile Image Control FF Alg: If set, save intermediate plots (PS file) and parameters (IDL save file) 0 N/A 0 - 1 int Standard hsi_forwardfit
ff_savename Image Control FF Alg: Name of file to write if ff_savefile is set hsi_forwardfit.sav -- -- string Standard hsi_forwardfit
ff_testplot Image Control FF Alg: If set, show intermediate plots 0 N/A 0 - 1 int Standard hsi_forwardfit
filename Image, Spectrum, Lightcurve Control Name(s) of the level-0/telemetry data file(s) None N/A -- pointer Standard hsi_packet_file
flatfield Image Control If set, enable flatfielding in BPROJ 1 N/A 0 - 1 int Standard hsi_bproj_strategy
front_segment Image Control If set, use detector front segments 1 N/A 0 - 1 byte Standard hsi_binned_eventlist
full_info Image Control If set, write all info params in FITS file 0 -- 0 - 1 byte Standard hsi_image_strategy
ge_silent Image Control GE Alg: Controls mem_ge debug output 1 -- 0 - 1 int Standard hsi_mem_ge
im_energy_binning Image Control Defines energy binning. If scalar, interpret as code for predefined energy bins, otherwise as energy edges -- -- -- pointer Standard hsi_binned_eventlist
im_input_fits Image Control Input image FITS file name -- -- -- pointer Standard hsi_image_file
im_time_bin Image Control Width of bins to divide im_time_intervals into -- sec -- double Standard hsi_image_raw
im_time_bin Image Control Width of bins to divide im_time_intervals into 0.0 sec -- double Standard hsi_image_strategy
im_time_interval Image Control Time Interval(s) for images -- ANYTIM -- pointer Standard hsi_image_raw
im_time_interval Image Control Time Interval(s) for images -- ANYTIM -- pointer Standard hsi_calib_eventlist
image_algorithm Image Control Algorithm to use in image reconstruction bproj N/A bproj, clean, em, pixon, ff, ge, vf, nj, uv, vis_cs, vis_wv string Standard hsi_image_single
image_dim Image Control Dimensions of image [64,64] pixel 16 - 1024 int(2) Standard hsi_modul_pattern_strategy
mc_ntrials Image Control Number of Monte Carlo trials to determine probability of C-statistic 0 -- 0 - ? int Standard hsi_image_single
mc_show_plot Image Control If set, show Monte Carlo distribution of C-statistic for separate and combined detectors 0 -- 0 - 1 int Standard hsi_image_single
mpat_coord Image Control Selects whether to use annsec or cartesian coordinates for modulation patterns annsec -- annsec, cart string Standard hsi_modul_pattern
natural_weighting Image Control If set, all collimators have equal weight in forming BPROJ map 1 N/A 0 - 1 int Standard hsi_bproj_strategy
nj_progress_bar Image Control Not used 1 -- 0 - 1 int Standard hsi_mem_njit
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
pixel_size Image Control X,Y size of the image pixel [4,4] arcsec 1 - 100 float(2) Standard hsi_modul_pattern_strategy
pixon_noplot Image Control PIXON Alg: If set, do not show intermediate plots 0 N/A 0 - 1 int Standard hsi_pixon
pixon_progress_bar Image Control PIXON Alg: If set, show progress bar with cancel option 1 N/A 0 - 1 int Standard hsi_pixon
pixon_reusemapwindows Image Control PIXON Alg: If set, reuse window for pixon intermediate plots, otherwise make new window 1 -- 0 - 1 int Standard hsi_pixon
pixon_smpattwritedir Image Control PIXON Alg: Directory to save new smoothed patterns in -- N/A -- string Standard hsi_pixon
profile_jpeg_plot Image Control If set, draw modulation profile plot in jpeg file (auto-generated name) 0 -- 0 - 1 int Standard hsi_image_single
profile_plot_dir Image Control Directory to write modulation profile plot file in Current directory -- -- string Standard hsi_image_single
profile_plot_rate Image Control If set, plot count/sec in profile plot 1 -- 0 - 1 int Standard hsi_image_single
profile_plot_resid Image Control If set, plot profile residuals instead of profiles themselves 0 -- 0 - 1 int Standard hsi_image_single
profile_ps_plot Image Control If set, draw modulation profile plot in PS file (auto-generated name) 0 -- 0 - 1 int Standard hsi_image_single
profile_show_plot Image Control If set, enable plots of predicted and observed modulation profiles while making image(s) 0 -- 0 - 1 int Standard hsi_image_single
profile_window Image Control Window number to draw profiles in -1 -- -- int Standard hsi_image_single
rear_decimation_correct Image, Spectrum, Lightcurve Control If set, make rear decimation correction 0 -- 0 -1 int Standard hsi_spectrogram
rear_segment Image Control If set, use detector rear segments 0 N/A 0 - 1 byte Standard hsi_binned_eventlist
seg_index_mask Image, Spectrum, Lightcurve Control Flags for selecting detector and segment All 0 N/A 0 - 1 byte(18) Standard hsi_spectrogram
skip_viscomp_chisq Image Control If set, don"t compute chisq of comparison of observed vis with vis from image 0 -- 0 - 1 int Standard hsi_image_single
smoothing_time Image Control Smoothing time for flux variation profile. Used only if use_flux_var is set. 4. sec -- float Standard hsi_calib_eventlist
snr_chk Image Control 0 means don't check SNR, 1/2 means try to check and if can't, don't / do make image.' 2 -- 0 - 2 int Standard hsi_image_single
snr_thresh Image Control Threshold value of SNR, if < thresh don't make image 2.00000 -- -- float Standard hsi_image_single
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
sum_flag Image, Spectrum, Lightcurve Control If set, sum the spectrograms over collimators 0 N/A 0 - 1 int Standard hsi_spectrogram
taper Image Control Tapering factor for weighting grids in forming BPROJ map 0.0 N/A 0. - 10. float Standard hsi_bproj_strategy
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
uniform_weighting Image Control If set, each collimator's weight in forming BPROJ map is 1/FWHM 0 N/A 0 - 1 int Standard hsi_bproj_strategy
use_all_info_params Image Control If set, read all info parameters from image FITS file. 0 -- 0 - 1 byte Standard hsi_image_file
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_flux_var Image Control If set, attempt to reconstruct flux variations unmarred by grid modulation 1 N/A 0 - 1 long Standard hsi_calib_eventlist
use_local_average Image Control If set, subtract smoothed rate from count rate to reduce background effects 0 -- 0 - 1 byte Standard hsi_calib_eventlist
use_phz_stacker Image Control If set, use phase stacker 0 -- 0 - 1 long Standard hsi_calib_eventlist
use_rate Image Control If set, use rate-enabled back projection 1 -- 0 - 1 int Standard hsi_bproj_strategy
uv_show_vismap Image Control UV Alg: If set, plot the visibility sampling on the u,v plane 1 -- 0 - 1 byte Standard hsi_uv_smooth
vf_circle Image Control VF Alg: If set, forces sources to be circular. OLD. Preferred method is to use vf_srcin. 0 -- 0 - 1 byte Standard hsi_vis_fwdfit
vf_loop Image Control VF Alg: If set, fit to a loop. OLD. Preferred method is to use vf_srcin. 0 -- 0 - 1 int Standard hsi_vis_fwdfit
vf_maxiter Image Control VF Alg: Maximum number of iterations per stage 2000 -- -- long Standard hsi_vis_fwdfit
vf_multi Image Control VF Alg: If set, fit to a double source. OLD. Preferred method is to use vf_srcin. 0 -- 0 - 1 int Standard hsi_vis_fwdfit
vf_noplotfit Image Control VF Alg: If set, suppress plotfit display 0 -- 0 - 1 int Standard hsi_vis_fwdfit
vf_srcin Image Control VF Alg: Input source structure array. Starting point for fit. One element per source. Tags are defined in {HSI_VIS_SRC_STRUCTURE}, (see hsi_vis_src_structure__define.pro) -- -- -- pointer Standard hsi_vis_fwdfit
vis_input_fits Image Control Input visibility FITS file name -- -- -- string Standard hsi_visibility
vis_out_filename Image Control If set to a string, a FITS file will be written containing the visibility bag -- -- -- string Standard hsi_visibility
vis_plotfit Image Control If set, plot fitted visibility vs phase 0 -- -- byte Standard hsi_visibility
vis_wv_silent Image Control VIS_WV Alg: If not set, the actual min of objective function at each iter is printed 0 -- -- int Standard hsi_vis_wv
viscomp_jpeg_plot Image Control If set, draw vis comp plot in jpeg file (auto-generated name) 0 -- 0 - 1 int Standard hsi_image_single
viscomp_plot_dir Image Control Directory to write viscomp plot file in. Default is current dir. Current directory -- -- string Standard hsi_image_single
viscomp_ps_plot Image Control If set, draw vis comp plot in PS file (auto-generated name) 0 -- 0 - 1 int Standard hsi_image_single
viscomp_show_plot Image Control If set, enable visibility comparison plot while making image(s) 0 -- 0 - 1 int Standard hsi_image_single
viscomp_window Image Control Window number to draw vis comp plot in -1 -- -- int Standard hsi_image_single
xyoffset Image, Spectrum, Lightcurve Control Offset of map center from Sun center [600.,200.] arcsec 0 - 1000 float(2) Standard hsi_xyoffset
xyoffset Image Control Offset of map from Sun center [600.,200.] arcsec 0 - 1000 float(2) Standard hsi_calib_eventlist

* 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