hyperspy._components.error_function module

class hyperspy._components.error_function.Erf(A=1.0, sigma=1.0, origin=0.0, module=['numpy', 'scipy'], **kwargs)

Bases: hyperspy._components.expression.Expression

Error function component.

$f(x) = \frac{A}{2}~\mathrm{erf}\left[\frac{(x - x_0)}{\sqrt{2} \sigma}\right]$

Variable	Parameter
$A$	A
$\sigma$	sigma
$x_0$	origin

Parameters

A (float) – The min/max values of the distribution are -A/2 and A/2.
sigma (float) – Width of the distribution.
origin (float) – Position of the zero crossing.
**kwargs – Extra keyword arguments are passed to the Expression component.