hyperspy._components.gaussian2d module

class hyperspy._components.gaussian2d.Gaussian2D(A=1.0, sigma_x=1.0, sigma_y=1.0, centre_x=0.0, centre_y=0, module='numexpr', **kwargs)

Bases: hyperspy._components.expression.Expression

Normalized 2D elliptical Gaussian function component.

f(x,y) = \frac{A}{2\pi s_x s_y}\exp\left[-\frac{\left(x-x_0\right)









  • A (float) – Amplitude (height of the peak scaled by 2 \pi s_x s_y).

  • sigma_x (float) – Width (scale parameter) of the Gaussian distribution in x direction.

  • sigma_y (float) – Width (scale parameter) of the Gaussian distribution in y direction.

  • centre_x (float) – Location of the Gaussian maximum (peak position) in x direction.

  • centre_x – Location of the Gaussian maximum (peak position) in y direction.

  • add_rotation (bool) – If True, add the parameter rotation_angle corresponding to the angle between the x and the horizontal axis.

fwhm_x, fwhm_y

Convenience attributes to get and set the full width at half maximum along the two axes.



Create a component from a string expression.

It automatically generates the partial derivatives and the class docstring.

  • expression (str) – Component function in SymPy text expression format with substitutions separated by ;. See examples and the SymPy documentation for details. In order to vary the components along the signal dimensions, the variables x and y must be included for 1D or 2D components. Also, if module is “numexpr” the functions are limited to those that numexpr support. See its documentation for details.

  • name (str) – Name of the component.

  • position (str, optional) – The parameter name that defines the position of the component if applicable. It enables interative adjustment of the position of the component in the model. For 2D components, a tuple must be passed with the name of the two parameters e.g. (“x0”, “y0”).

  • module ({"numpy", "numexpr", "scipy"}, default "numpy") – Module used to evaluate the function. numexpr is often faster but it supports fewer functions and requires installing numexpr.

  • add_rotation (bool, default False) – This is only relevant for 2D components. If True it automatically adds rotation_angle parameter.

  • rotation_center ({None, tuple}) – If None, the rotation center is the center i.e. (0, 0) if position is not defined, otherwise the center is the coordinates specified by position. Alternatively a tuple with the (x, y) coordinates of the center can be provided.

  • rename_pars (dictionary) – The desired name of a parameter may sometimes coincide with e.g. the name of a scientific function, what prevents using it in the expression. rename_parameters is a dictionary to map the name of the parameter in the expression` to the desired name of the parameter in the Component. For example: {“_gamma”: “gamma”}.

  • compute_gradients (bool, optional) – If True, compute the gradient automatically using sympy. If sympy does not support the calculation of the partial derivatives, for example in case of expression containing a “where” condition, it can be disabled by using compute_gradients=False.

  • **kwargs – Keyword arguments can be used to initialise the value of the parameters.


As of version 1.4, Sympy’s lambdify function, that the Expression components uses internally, does not support the differentiation of some expressions, for example those containing a “where” condition. In such cases, the gradients can be set manually if required.


The following creates a Gaussian component and set the initial value of the parameters:

>>> hs.model.components1D.Expression(
... expression="height * exp(-(x - x0) ** 2 * 4 * log(2)/ fwhm ** 2)",
... name="Gaussian",
... height=1,
... fwhm=1,
... x0=0,
... position="x0",)

Substitutions for long or complicated expressions are separated by semicolumns:

>>> expr = 'A*B/(A+B) ; A = sin(x)+one; B = cos(y) - two; y = tan(x)'
>>> comp = hs.model.components1D.Expression(
... expression=expr,
... name='my function')
>>> comp.parameters
(<Parameter one of my function component>,
 <Parameter two of my function component>)
property ellipticity

Ratio between the major and minor axis.



property rotation_angle_wrapped

Rotation angle in radian wrapped to [0, 2*pi]. Only for Gaussian2D component created with add_rotation=True.



property rotation_major_axis

Rotation angle in radian between the major axis (axis with the largest sigma value) and the horizontal axis. Only for Gaussian2D component created with add_rotation=True.



property sigma_major

The sigma value of the major axis (axis with the largest sigma value).



property sigma_minor

The sigma value of the minor axis (axis with the smallest sigma value).