OSPEX Object Parameters:  OSPEX Standard Control Parameters

 

Links to other ospex parameter tables:
     All      Standard Control      Administration      Information

 

Name Control / Info* Description Default Units Range Type** User Level*** Class
fit_comp_free_mask Control Fit function parameter free/fixed mask [1,1] -- 0 - 1 pointer Standard fit_comp
fit_comp_maxima Control Fit function parameter maximum values [1.e20, 50.] -- -- pointer Standard fit_comp
fit_comp_minima Control Fit function parameter minimum values [1.e-20, .5] -- -- pointer Standard fit_comp
fit_comp_model Control Fit function model chianti (for thermal) -- chianti / mewe string Standard fit_comp
fit_comp_params Control Fit function parameters [1., 2.] -- -- pointer Standard fit_comp
fit_comp_spectrum Control Fit function spectrum type (for thermal) full (for thermal) -- full / continuum / lines string Standard fit_comp
fit_function Control Fit function used vth -- -- string Standard fit_function
mcurvefit_itmax Control Maximum number of iterations in mcurvefit fit 10 -- -- long Standard spex_fitalg_mcurvefit
mcurvefit_quiet Control 0/1 quiet/verbose during mcurvefit 1 -- 0 - 1 byte Standard spex_fitalg_mcurvefit
mcurvefit_tol Control Convergence Tolerance. Stop fit if relative decrease in chi-squared < tol 0.001 -- -- double Standard spex_fitalg_mcurvefit
poly_fit_double Control Not used yet. 0 -- -- byte Standard spex_fitalg_poly_fit
poly_fit_n_degree Control Number of degrees of freedom for polynomial fit. Not used yet. 2 -- -- long Standard spex_fitalg_poly_fit
spex_accum_time Control Time interval to accumulate for spex analysis. [0.,0.] means full file. [0.,0.] (full file) -- Time range of input file double(2) Standard spex_data_strategy
spex_albedo_correct Control If set, correct drm for albedo of photosphere 0 -- 0 - 1 int Standard spex_drm
spex_anisotropy Control Anisotropy ratio, for albedo correction 1. -- 0. - 1. float Standard spex_drm
spex_bk_eband Control Energy bands for background if spex_bk_sep is set -- keV -- pointer Standard spex_bkint
spex_bk_order Control Order of polynomial or method for computing background fit 1 -- 0 - 3 pointer Standard spex_bk
spex_bk_poisson_error Control If set, bk data errors are sqrt(counts). Otherwise errors are averaged. 0 -- 0 - 1 int Standard spex_bk
spex_bk_ratio Control Use ratio of high-energy bk profile for bk for lower energies 0 -- 0 - 1 int Standard spex_bk
spex_bk_sep Control If set, separate background for different energy bands 0 -- 0 - 1 int Standard spex_bkint
spex_bk_sm_width Control Smoothing width (# of points), used when background method uses profile 128 -- 1 - ? int Standard spex_bk
spex_bk_time_interval Control Background time intervals -- ANYTIM -- pointer Standard spex_bkint
spex_data_dir Admin Directory containing input files Current directory -- -- string Standard spex_data
spex_data_sel Control Instrument or detector selection if file has more than one type of data -- -- Depends on data source string Standard spex_data_strategy
spex_drmfile Control Input DRM file name -- -- -- string Standard spex_drm
spex_erange Control Energy range(s) to fit over (2,n) -- keV -- pointer Standard spex_fitrange
spex_error_use_expected Control If set, use expected counts to calc error 1 -- 0 - 1 int Standard spex_fitalg_gen
spex_fit_auto_emax_thresh Control Threshold for #counts/bin for automatically setting upper limit of energy range to fit. 10.0 counts/bin 10. - ? float Standard spex_fit
spex_fit_auto_emin Control If set, automatically set lower limit of energy range to fit (only applies to RHESSI) 0 -- 0 - 1 int Standard spex_fit
spex_fit_auto_erange Control If set, automatically set upper limit of energy range to fit 0 -- 0 - 1 int Standard spex_fit
spex_fit_firstint_method Control Method for setting starting params for fit for first interval (fn,sn = final,start from interval n) current -- default / current / fn / sn string Standard spex_fit
spex_fit_init_params_only Control If set, set params only according to firstint_method or start_method 0 -- 0 - 1 int Standard spex_fit
spex_fit_manual Control 0=automatic, 1=manual on first interval, 2=manual on all intervals 1 -- 0 - 2 int Standard spex_fit
spex_fit_reverse Control Interval Loop direction, 0 = forward, 1 = reverse 0 -- 0 - 1 int Standard spex_fit
spex_fit_start_method Control Method for getting starting params for fit after first interval previous_int -- default / previous_int / previous_start / previous_iter string Standard spex_fit
spex_fit_time_interval Control Fit time intervals, (2,n) -- ANYTIM -- pointer Standard spex_fitint
spex_image_full_srm Control If set, use full SRM for image cube 0 -- 0 - 1 int Standard spex_image
spex_intervals_tofit Control Array of interval numbers to fit (start from 0) -1 -- -- pointer Standard spex_fitrange
spex_panel_replace Admin Not used yet 0 -- 0 - 1 int Standard spex_data
spex_roi_infile Control Name of IDL save file to read ROI selection from. -- -- -- string Standard spex_image
spex_roi_integrate Control If set, integrate all regions to compute spectrum. 0 -- 0 - 1 int Standard spex_image
spex_roi_use Control Specifies which region(s) to use to compute spectrum 0 -- 0 - 3 pointer Standard spex_image
spex_source_angle Control Angle to source in degrees, for albedo correction 45. -- 0. - 90. float Standard spex_drm
spex_source_xy Control XY Position of source in arcsec, for albedo correction [-9999.,-9999.] -- 0. - ~950. float(2) Standard spex_drm
spex_specfile Control Input spectrum file name -- -- -- pointer Standard spex_data_strategy
spex_uncert Control Systematic Uncertainty .05 -- -- float Standard spex_fitalg_gen
spex_ut_offset Control Time offset for data in seconds 0.0 sec -- float Standard spex_data_strategy

* Control Parameters are set by the user to control the software; Info parameters are informational output parameters; Admin parameters are set by the user to control display options.

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