xarray.DataArray.kspace.set_normal¶

DataArray.kspace.set_normal(self, alpha, beta, *, delta=None, alpha_scale=None, beta_scale=None)[source]¶

Set offsets from normal emission angles.

This method sets the angle offsets so that the provided normal emission angles \((\alpha, \beta)\) in the raw data map to \((k_x, k_y) = (0, 0)\) in momentum space after angle-scale compensation is applied.

Parameters:

alpha (float) – Angle \(\alpha\) in degrees corresponding to sample normal emission.
beta (float) – Angle \(\beta\) in degrees corresponding to sample normal emission.
delta (float | None, default: None) – Optional azimuthal offset \(\delta\) in degrees. If omitted, the existing delta offset is preserved.
alpha_scale (float | None, default: None) – Optional angle-scale compensation factors. If provided, the factors are stored before solving the offsets. Omitted factors use the currently stored scale values.
beta_scale (float | None, default: None) – Optional angle-scale compensation factors. If provided, the factors are stored before solving the offsets. Omitted factors use the currently stored scale values.

Examples

>>> data.kspace.set_normal(alpha=1.2, beta=-0.4)
>>> dict(data.kspace.offsets)
{'delta': 0.0, 'xi': -1.2, 'beta': -0.4}

Changed in version 3.24.0: Added alpha_scale and beta_scale compensation factors. The provided normal-emission angles are interpreted in raw data coordinates.