hyperspy._components.eels_arctan module

class hyperspy._components.eels_arctan.Arctan(minimum_at_zero=False, **kwargs)

Bases: Expression

Legacy Arctan component dedicated to EELS measurements that will renamed to EELSArctan in v2.0.

To use the new Arctan component set minimum_at_zero=False. See the documentation of Arctan for details on the usage.

The EELS version EELSArctan (minimum_at_zero=True) shifts the function by A in the y direction

class hyperspy._components.eels_arctan.EELSArctan(A=1.0, k=1.0, x0=1.0, module=['numpy', 'scipy'], **kwargs)

Bases: Expression

Arctan function component for EELS (with minimum at zero).

\[f(x) = A \cdot \left( \frac{\pi}{2} + \arctan \left[ k \left( x-x_0 \right) \right] \right)\]

Variable	Parameter
\(A\)	A
\(k\)	k
\(x_0\)	x0

Parameters:

• A (float) – Amplitude parameter. \(\lim_{x\to -\infty}f(x)=0\) and \(\lim_{x\to\infty}f(x)=2A\)

• k (float) – Slope (steepness of the step). The larger \(k\), the sharper the step.

• x0 (float) – Center parameter (\(f(x_0)=A\)).