$$\renewcommand\AA{\unicode{x212B}}$$

# IntegrateEPP v1¶

## Summary¶

Integrate a workspace around elastic peak positions.

## Properties¶

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’.

## Description¶

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 $$i$$ in InputWorkspace are given by

$$d_i = c_i \pm w \sigma_i$$,

where $$-$$ is for the lower and $$+$$ for the upper limit, $$c_i$$ the value from the ‘PeakCentre’ column, $$w$$ the HalfWidthInSigmas property and $$\sigma_i$$ the value from the ‘Sigma’ column.

If a workspace index is missing from EPPWorkspace, the integration limits will be set to zero.

## Usage¶

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)

print('Integral from {:.6} to {:.6} yields {:.5}'.format(xs, xs, ys))


Output:

Integral from ... to ... yields ...


Categories: AlgorithmIndex | Arithmetic | Transforms\Rebin