import numpy as np
from ase2sprkkr.physics.broadening import (
create_gaussian_broadener,
create_lorentz_broadener,
)
[docs]
def _sorted_reference(x, y, sigma=None, fwhm=None, **kwargs):
order = np.argsort(x)
x_sorted = np.asarray(x)[order]
y_sorted = np.asarray(y)[..., order]
sigma_sorted = None if sigma is None or np.ndim(sigma) == 0 else np.asarray(sigma)[order]
fwhm_sorted = None if fwhm is None or np.ndim(fwhm) == 0 else np.asarray(fwhm)[order]
broadener = create_gaussian_broadener(
x_sorted,
sigma=sigma if sigma_sorted is None else sigma_sorted,
fwhm=fwhm if fwhm_sorted is None else fwhm_sorted,
**kwargs,
)
return broadener(y_sorted)
[docs]
def _bin_widths(x):
x = np.asarray(x, dtype=float)
dx = np.empty_like(x)
dx[0] = x[1] - x[0]
dx[-1] = x[-1] - x[-2]
dx[1:-1] = 0.5 * (x[2:] - x[:-2])
return dx
[docs]
def test_gaussian_unsorted_grid_reorders_data_and_sigma():
x = np.array([2.0, 0.0, 1.0, 3.0])
y = np.array([20.0, 1.0, 7.0, 3.0])
sigma = np.array([0.6, 0.15, 0.3, 0.8])
actual = create_gaussian_broadener(x, sigma=sigma, method="dense")(y)
expected_sorted = _sorted_reference(x, y, sigma=sigma, method="dense")
np.testing.assert_allclose(actual[np.argsort(x)], expected_sorted)
[docs]
def test_gaussian_unsorted_grid_reorders_fwhm():
x = np.array([1.5, -0.5, 0.5, 2.5])
y = np.array([2.0, 8.0, 1.0, 4.0])
fwhm = np.array([0.9, 0.25, 0.5, 1.1])
actual = create_gaussian_broadener(x, fwhm=fwhm, method="dense")(y)
expected_sorted = _sorted_reference(x, y, fwhm=fwhm, method="dense")
np.testing.assert_allclose(actual[np.argsort(x)], expected_sorted)
[docs]
def test_gaussian_broadens_last_axis_and_supports_distinct_output_grid():
x = np.array([2.0, 0.0, 1.0])
x_out = np.array([1.5, -0.5, 0.5, 2.5])
y = np.array([[20.0, 1.0, 7.0], [2.0, 4.0, 8.0]])
actual = create_gaussian_broadener(
x,
sigma=0.4,
x_out=x_out,
method="dense",
)(y)
order = np.argsort(x)
reference = create_gaussian_broadener(
x[order],
sigma=0.4,
x_out=x_out,
method="dense",
)(y[..., order])
assert actual.shape == (2, len(x_out))
np.testing.assert_allclose(actual, reference)
[docs]
def test_gaussian_preserves_discrete_integral_for_multiple_spectra_and_variable_width():
x = np.array([-2.0, -0.7, 0.0, 0.8, 2.5])
x_out = np.array([-4.0, -2.5, -1.5, -0.5, 0.2, 1.1, 2.0, 3.4, 5.0])
sigma = np.array([0.2, 0.35, 0.5, 0.7, 0.9])
y = np.array(
[
[0.2, 1.0, 0.7, 0.3, 0.1],
[1.2, 0.4, 0.8, 1.1, 0.6],
]
)
broadened = create_gaussian_broadener(
x,
sigma=sigma,
x_out=x_out,
method="dense",
)(y)
integral_in = y @ _bin_widths(x)
integral_out = broadened @ _bin_widths(x_out)
np.testing.assert_allclose(integral_out, integral_in, rtol=1e-12, atol=1e-12)
[docs]
def test_gaussian_rejects_wrong_energy_axis_length():
broaden = create_gaussian_broadener([0.0, 1.0, 2.0], sigma=0.2)
with np.testing.assert_raises(ValueError):
broaden(np.ones((2, 4)))
[docs]
def test_lorentz_broadens_last_axis_for_multiple_spectra():
x = np.array([-1.0, -0.2, 0.7, 1.8])
y = np.array(
[
[0.2, 1.0, 0.5, 0.1],
[1.2, 0.4, 0.8, 1.1],
[0.0, 0.3, 1.4, 0.6],
]
)
broaden = create_lorentz_broadener(x, gamma=0.3)
actual = broaden(y)
expected = np.stack([broaden(spectrum) for spectrum in y])
assert actual.shape == y.shape
np.testing.assert_allclose(actual, expected)
[docs]
def test_lorentz_broadens_last_axis_for_square_leading_dimension():
x = np.array([-1.0, -0.2, 0.7, 1.8])
y = np.arange(16.0).reshape(4, 4)
broaden = create_lorentz_broadener(x, gamma=0.3)
actual = broaden(y)
expected = np.stack([broaden(spectrum) for spectrum in y])
np.testing.assert_allclose(actual, expected)
[docs]
def test_lorentz_rejects_wrong_energy_axis_length():
broaden = create_lorentz_broadener([0.0, 1.0, 2.0], gamma=0.2)
with np.testing.assert_raises(ValueError):
broaden(np.ones((2, 4)))