OSPEX Object Parameters:  OSPEX Info Parameters

 

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

 

Name Control / Info* Description Default Units Range Type** User Level*** Class
compman_name Info Array of function component names -- -- -- pointer N/A fit_comp_manager
compman_strategy Info Array of function component strategy names -- -- -- pointer N/A fit_comp_manager
fc_model_options Info Options for fit_comp_model -- -- -- pointer N/A fit_comp
fc_spectrum_options Info Options for fit_comp_spectrum -- -- -- pointer N/A fit_comp
fit_comp_sigmas Info Sigma in fit parameters, (nparam) -- -- -- pointer N/A fit_comp
fit_func_units Info Structure with units of fit function output -- -- -- struct(1) N/A fit_function
mcurvefit_chi2 Info Chi-squared value after mcurvefit -- -- -- double N/A spex_fitalg_mcurvefit
mcurvefit_corr Info Correlation matrix -- -- -- pointer N/A spex_fitalg_mcurvefit
mcurvefit_covar Info Covariance matrix -- -- -- pointer N/A spex_fitalg_mcurvefit
mcurvefit_fail_msg Info Mcurvefit success/failure message -- -- -- string N/A spex_fitalg_mcurvefit
mcurvefit_fail_type Info Mcurvfit success/failure code -- -- -- int N/A spex_fitalg_mcurvefit
mcurvefit_free_mask Info Parameter free/fixed mask used -- -- -- pointer N/A spex_fitalg_mcurvefit
mcurvefit_iter Info Number of iterations done in mcurvefit -- -- -- long N/A spex_fitalg_mcurvefit
poly_fit_chisq Info -- -- -- -- double N/A spex_fitalg_poly_fit
poly_fit_covar Info -- -- -- -- pointer N/A spex_fitalg_poly_fit
poly_fit_status Info -- -- -- -- int N/A spex_fitalg_poly_fit
poly_fit_yband Info -- -- -- -- pointer N/A spex_fitalg_poly_fit
poly_fit_yerror Info -- -- -- -- pointer N/A spex_fitalg_poly_fit
spex_area Info Area of detector/ instrument from spectrum file -- cm^2 -- float N/A spex_data_strategy
spex_bk_origunits Info Structure with original units for background data -- -- -- struct(1) N/A spex_bk
spex_bk_ratprofile_plot Info If set, show plot of background profile used for 'High E Profile' or 'This E Profile' ratio method 0 -- 0 - 1 int N/A spex_bk
spex_bk_units Info Structure with units of last accumulation for background data -- -- -- struct(1) N/A spex_bk
spex_bk_used_ratio Info 0/1 means we didn't / did use the ratio method for bk calc -- -- -- int N/A spex_bk
spex_bksub_origunits Info Structure with original units for background-subtracted data -- -- -- struct(1) N/A spex_bksub
spex_bksub_units Info Structure with units of last accumulation for background-subtracted data -- -- -- struct(1) N/A spex_bksub
spex_ct_edges Info Energy bins of data in spectrum file, (2,n) -- keV -- pointer N/A spex_data_strategy
spex_data_origunits Info Structure with original units for spectrum data -- -- -- struct(1) N/A spex_data_strategy
spex_data_pos Info Xyoffset of source in data file -- arcsec -- float(2) N/A spex_data_strategy
spex_data_units Info Structure with units of last accumulation for spectrum data -- -- -- struct(1) N/A spex_data_strategy
spex_deconvolved Info If 1, original data is already photons. 0 -- 0 - 1 int N/A spex_data_strategy
spex_detectors Info String of detectors included in spectrum file -- -- -- string N/A spex_data_strategy
spex_drm_area Info Detector area from DRM file -- cm^2 -- float N/A spex_drm
spex_drm_ct_edges Info Count space energy edges in DRM file (2,n) -- keV -- pointer N/A spex_drm
spex_drm_current_filter Info Current filter in use -- -- -- int N/A spex_drm
spex_drm_current_time Info Current DRM time interval in use -- -- -- double(2) N/A spex_drm
spex_drm_data_name Info Data type DRM file is for, e.g. HESSI -- -- -- string N/A spex_drm
spex_drm_detused Info String of detectors included in DRMfile -- -- -- string N/A spex_drm
spex_drm_filter Info Filter (attenuator) state(s) in DRM file -- -- -- pointer N/A spex_drm
spex_drm_method Info Method used to get drm values: "file", "array", or "build" -- -- -- string N/A spex_drm
spex_drm_mod_obj Info Used internally in drm_mod function -- -- -- objref N/A spex_drm
spex_drm_ph_edges Info Photon space energy edges in DRM file (2,n) -- keV -- pointer N/A spex_drm
spex_drm_sepdets Info If set, detectors are separate in DRM file -- -- -- int N/A spex_drm
spex_drm_times Info Time interval for each DRM matrix -- -- -- pointer N/A spex_drm
spex_file_time Info Start,end time of data in spectrum file -- ANYTIM -- double(2) N/A spex_data_strategy
spex_file_units Info Structure of units info for data in spectrum file -- -- -- struct(1) N/A spex_data_strategy
spex_fit_time_used Info Fit time intervals used (spex_fit_time_interval adjusted to data boundaries), (2,n) -- ANYTIM -- pointer N/A spex_fitint
spex_fitcomp_plotobj_resid Info Plotman object to use for residuals -- -- -- objref N/A spex_fit
spex_fitint_filter Info Data filter for each fit interval -- -- -- pointer N/A spex_fitint
spex_fitint_origunits Info Structure with original units for fit interval data -- -- -- struct(1) N/A spex_fitint
spex_fitint_units Info Structure with units of last accumulation for fit interval data -- -- -- struct(1) N/A spex_fitint
spex_have_bk Info If set, some background intervals have been defined. -- -- -- int N/A spex_bkint
spex_interval_filter Info Filter state for each original data time interval -- -- -- pointer N/A spex_data_strategy
spex_interval_index Info Index of current fit interval -- -- -- int N/A spex_fitint
spex_plotman_obj Info Plotman object reference -- -- -- objref N/A spex_data
spex_pseudo_livetime Info If 1, livetime isn't a real livetime. 0 -- 0 - 1 int N/A spex_data_strategy
spex_respinfo Info Name of response file written with spectrum file, or array of response values -- -- -- pointer N/A spex_data_strategy
spex_summ_abun_table Info Abundance table name -- -- -- string N/A spex_fit
spex_summ_area Info Detector area for data in fit results -- cm^2 -- float N/A spex_fit
spex_summ_bk_error Info Error in background rate data for each interval, (nenergy,ntime) -- counts/sec -- pointer N/A spex_fit
spex_summ_bk_rate Info Background rate corresponding to ct_rate, (nenergy,ntime) -- counts/sec -- pointer N/A spex_fit
spex_summ_chianti_version Info Chianti package version used to make tables -- -- -- string N/A spex_fit
spex_summ_chisq Info Chi-square for each interval, (ntime) -- -- -- pointer N/A spex_fit
spex_summ_conv Info Conversion factors for each interval (nenergy,ntime) -- counts/photon -- pointer N/A spex_fit
spex_summ_ct_error Info Error in count rate data for each interval, (nenergy,ntime) -- -- -- pointer N/A spex_fit
spex_summ_ct_rate Info Count rate data that was fit for each interval, (nenergy,ntime) -- counts/sec -- pointer N/A spex_fit
spex_summ_emask Info Mask of energies used for each interval (nenergy,ntime) -- -- -- pointer N/A spex_fit
spex_summ_energy Info Full array of energy edges, (2,nenergy) -- keV -- pointer N/A spex_fit
spex_summ_filter Info Array of filter states for each time interval (ntime) -- -- -- pointer N/A spex_fit
spex_summ_fit_done Info Interval fit completed mask. For each interval 0=not fit, 1=fit. (ntime) -- -- -- pointer N/A spex_fit
spex_summ_fit_function Info Fit function used -- -- -- pointer N/A spex_fit
spex_summ_free_mask Info Parameter free mask for each interval, (nparams,ntime) -- -- -- pointer N/A spex_fit
spex_summ_func_model Info Fit function model (chianti or mewe) used for each component in each interval, (ncomp,ntime) -- -- -- pointer N/A spex_fit
spex_summ_func_spectrum Info Fit function spectrum type (full, cont, or line) used for each component in each interval, (ncomp,ntime) -- -- -- pointer N/A spex_fit
spex_summ_maxima Info Parameter maxima for each interval, (nparams,ntime) -- -- -- pointer N/A spex_fit
spex_summ_maxiter Info Maximum number of iterations allowed for each interval, (ntime) -- -- -- pointer N/A spex_fit
spex_summ_minima Info Parameter minima for each interval, (nparams,ntime) -- -- -- pointer N/A spex_fit
spex_summ_niter Info Number of fit iterations done for each interval, (ntime) -- -- -- pointer N/A spex_fit
spex_summ_params Info Final fit parameters for each interval, (nparams,ntime) -- -- -- pointer N/A spex_fit
spex_summ_ph_model Info Photon flux model for each interval, (nenergy,ntime) -- phot/cm^2/sec/keV -- pointer N/A spex_fit
spex_summ_resid Info Residuals for each interval, (nenergy,ntime) -- -- -- pointer N/A spex_fit
spex_summ_sigmas Info Sigma in fit parameters for each interval, (nparams,ntime) -- -- -- pointer N/A spex_fit
spex_summ_starting_params Info Starting fit parameters for each interval, (nparams,ntime) -- -- -- pointer N/A spex_fit
spex_summ_stop_msg Info Reason for stopping fit for each interval, (ntime) -- -- -- pointer N/A spex_fit
spex_summ_time_interval Info Array of time intervals fit, (2,ntime) -- UT -- pointer N/A spex_fit
spex_summ_uncert Info Systematic uncertainty for each interval, (ntime) -- -- -- pointer N/A spex_fit
spex_title Info Title of data, e.g. "HESSI SPECTRUM" -- -- -- string N/A spex_data_strategy
spex_ut_edges Info Time bins of data in spectrum file, (2,n) -- ANYTIM -- pointer N/A 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