xarray.DataArray.kspace.estimate_resolution

DataArray.kspace.estimate_resolution(self, axis, lims=None, from_numpoints=False)[source]

Estimate target grid spacing for a momentum axis.

The returned value controls interpolation sampling. It is not an estimate of the instrumental momentum resolution.

Parameters:

  • axis (Literal['kx', 'ky', 'kz']) – Momentum axis for which to estimate the spacing.

  • lims (tuple[float, float] | None, default: None) – Lower and upper axis bounds in Å⁻¹, used when from_numpoints is True. If omitted, estimate_bounds() supplies the bounds.

  • from_numpoints (bool, default: False) – If True, estimate the spacing from the number of points in the relevant measured axis. If False, estimate it from the angular resolution or, for kz, the photoelectron inelastic mean free path. Default is False.

Returns:

float – Estimated target grid spacing in Å⁻¹.

Raises:

ValueError – If no photon energy axis is found in data for axis 'kz'.

Return type:

float