neutronpy.data.Analysis.width

Analysis.width(bounds=None, background=None, fwhm=False, hkle=True)

Returns the mean-squared width of a peak within the given bounds

Parameters:

bounds : bool, optional

A boolean expression representing the bounds inside which the calculation will be performed

background : float or dict, optional

Default: None

fwhm : bool, optional

If True, returns width in fwhm, otherwise in mean-squared width. Default: False

hkle : bool, optional

If True, integrates only over h, k, l, e dimensions, otherwise integrates over all dimensions in Data.data

Returns:

result : tup

The result is a tuple with the width in each dimension of Q, (h, k, l, e)