EnggSaveSinglePeakFitResultsToHDF5-v1.rst

Description

Exports the results of an :ref:`EnggFitPeaks <algm-EnggFitPeaks-v1>` fit to an HDF5 file indexed by bank ID. If multiple sets of fit results are provided, then the file is divided into sub-groups for each run number, with the Run Number groups indexed further by bank ID. The results go in a sub-group of the Bank group called Single Peak Fitting. This group contains one dataset, which is a table of the fit parameters for every peak

Obtaining fit results for banks 1 and 2 of run 123456 and then saving them with this algorithm would yield the following file structure:

Obtaining fit results for banks 1 and 2 of run 123456 and bank 1 of 123457, and then saving them with this algorithm, would yield the following file structure:

Fit Parameters

The fit function used in EnggFitPeaks is :ref:`Back2BackExponential <func-BackToBackExponential>`, so the input table workspace must contain values for the following parameters: ["dSpacing", "A0", "A0_Err", "A1", "A1_Err", "X0", "X0_Err", "A", "A_Err", "B", "B_Err", "S", "S_Err", "I", "I_Err", "Chi"]. Conveniently, this is exactly what you get out of EnggFitPeaks.

Usage

Ordinarily, we'd get our peak parameters table from EnggFitPeaks, but we just mock one up here. See :ref:`EnggFitPeaks documenation <algm-EnggFitPeaks-v1>` for how to generate this table.

Example - Export fit params to a new HDF5 file:

Output: