Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
InputWorkspace | Input | MatrixWorkspace | Mandatory | A workspace to be integrated. |
OutputWorkspace | Output | MatrixWorkspace | Mandatory | An workspace containing the integrated histograms. |
EPPWorkspace | Input | TableWorkspace | Mandatory | Table containing information on the elastic peaks. |
HalfWidthInSigmas | Input | number | 5 | Half of the integration width in multiplies of ‘Sigma’. |
This algorithm integrates a workspace around the peak positions given in an elastic peak position (EPP) table. The integration is done using the Integration v1 algorithm. EPPWorkspace should be a table workspace in the format returned by FindEPP v2. The integration limits for workspace index in InputWorkspace are given by
,
where is for the lower and
for the upper limit,
the value from the ‘PeakCentre’ column,
the HalfWidthInSigmas property and
the value from the ‘Sigma’ column.
If a workspace index is missing from EPPWorkspace, the integration limits will be set to zero.
Example - IntegrateEPP
gaussian = 'name=Gaussian, PeakCentre=7000, Height=230, Sigma=680'
ws = CreateSampleWorkspace('Histogram', 'User Defined', gaussian)
epps = FindEPP(ws)
integrated = IntegrateEPP(ws, epps, 3)
xs = integrated.readX(0)
ys = integrated.readY(0)
print('Integral from {:.6} to {:.6} yields {:.5}'.format(xs[0], xs[1], ys[0]))
Output:
Integral from 5060.0 to 9140.0 yields 1954.6
Categories: Algorithm Index | Arithmetic | Transforms\Rebin
C++ source: IntegrateEPP.cpp (last modified: 2018-10-05)
C++ header: IntegrateEPP.h (last modified: 2018-10-05)