linting test_analysis.py and test_data.py

This commit is contained in:
gnzng
2025-07-07 14:28:23 -07:00
parent 58246966f4
commit b00f39e1fe
2 changed files with 336 additions and 304 deletions
+260 -217
View File
@@ -1,8 +1,7 @@
import numpy as np
import torch as t
from scipy import linalg as la
from scipy.sparse import linalg as spla
import torch as t
from itertools import combinations
from cdtools.tools import analysis, initializers
@@ -15,10 +14,10 @@ def test_product_svd():
A = np.random.rand(*shape_A) + 1j * np.random.rand(*shape_A)
B = np.random.rand(*shape_B) + 1j * np.random.rand(*shape_B)
AB = np.matmul(A,B)
AB = np.matmul(A, B)
U_1, S_1, Vh_1 = t.linalg.svd(t.as_tensor(AB), full_matrices=False)
U_2, S_2, Vh_2 = analysis.product_svd(t.as_tensor(A),t.as_tensor(B))
U_2, S_2, Vh_2 = analysis.product_svd(t.as_tensor(A), t.as_tensor(B))
check_AB = U_2 @ t.diag_embed(S_2).to(dtype=Vh_2.dtype) @ Vh_2
# So, at a minimum, U S Vh = AB
@@ -28,23 +27,23 @@ def test_product_svd():
# singular vector, so all we can ask for in the comparison is that the
# magnitudes here are
assert np.allclose(S_1[:rank].numpy(), S_2.numpy())
prod_U = U_1[:,:rank].transpose(0,1).conj() @ U_2
prod_Vh = Vh_1[:rank,:] @ Vh_2.transpose(0,1).conj()
prod_U = U_1[:, :rank].transpose(0, 1).conj() @ U_2
prod_Vh = Vh_1[:rank, :] @ Vh_2.transpose(0, 1).conj()
assert np.allclose(t.abs(prod_U).numpy(), np.eye(rank))
assert np.allclose(t.abs(prod_Vh).numpy(), np.eye(rank))
# Confirms that the phases are consistent between the two, I think
# it's redundant with the first check but I'm not sure
assert np.allclose(prod_Vh.numpy(), prod_U.numpy())
# test with numpy
U_3, S_3, Vh_3 = analysis.product_svd(A,B)
U_3, S_3, Vh_3 = analysis.product_svd(A, B)
assert isinstance(U_3, np.ndarray)
assert isinstance(S_3, np.ndarray)
assert isinstance(Vh_3, np.ndarray)
assert np.allclose(S_1[:rank].numpy(), S_3)
prod_U = U_1[:,:rank].transpose(0,1).numpy().conj() @ U_3
prod_Vh = Vh_1[:rank,:].numpy() @ Vh_3.transpose().conj()
prod_U = U_1[:, :rank].transpose(0, 1).numpy().conj() @ U_3
prod_Vh = Vh_1[:rank, :].numpy() @ Vh_3.transpose().conj()
assert np.allclose(np.abs(prod_U), np.eye(rank))
assert np.allclose(np.abs(prod_Vh), np.eye(rank))
# Confirms that the phases are consistent between the two, I think
@@ -55,42 +54,49 @@ def test_product_svd():
def test_orthogonalize_probes():
op = analysis.orthogonalize_probes
probe_xs = np.arange(64) - 32
probe_ys = np.arange(76) - 38
probe_Ys, probe_Xs = np.meshgrid(probe_ys, probe_xs)
probe_Rs = np.sqrt(probe_Xs**2 + probe_Ys**2)
probes = np.array([10*np.exp(-probe_Rs**2 / (2 * 10**2 + 1j)),
3*np.exp(-probe_Rs**2 / (2 * 12**2 - 3j)),
1*np.exp(-probe_Rs**2 / (2 * 15**2))])
probes = np.array(
[
10 * np.exp(-(probe_Rs**2) / (2 * 10**2 + 1j)),
3 * np.exp(-(probe_Rs**2) / (2 * 12**2 - 3j)),
1 * np.exp(-(probe_Rs**2) / (2 * 15**2)),
]
)
weight_matrix_none = None
weight_matrix_single = np.random.randn(1,3) + 1j * np.random.randn(1,3)
weight_matrix_small = np.random.randn(2,3) + 1j * np.random.randn(2,3)
weight_matrix_medium = np.random.randn(3,3) + 1j * np.random.randn(3,3)
weight_matrix_large = np.random.randn(7,3) + 1j * np.random.randn(7,3)
weight_matrix_single = np.random.randn(1, 3) + 1j * np.random.randn(1, 3)
weight_matrix_small = np.random.randn(2, 3) + 1j * np.random.randn(2, 3)
weight_matrix_medium = np.random.randn(3, 3) + 1j * np.random.randn(3, 3)
weight_matrix_large = np.random.randn(7, 3) + 1j * np.random.randn(7, 3)
weight_matrices = [
weight_matrix_none,
weight_matrix_single,
weight_matrix_small,
weight_matrix_medium,
weight_matrix_large
weight_matrix_large,
]
for weight_matrix in weight_matrices:
ortho_probes_np, rwm_np = op(probes, weight_matrix=weight_matrix,
return_reexpressed_weights=True)
ortho_probes_np, rwm_np = op(
probes, weight_matrix=weight_matrix, return_reexpressed_weights=True
)
assert isinstance(ortho_probes_np, np.ndarray)
assert isinstance(rwm_np, np.ndarray)
probes_t = t.as_tensor(probes)
wm_t = (t.as_tensor(weight_matrix) if weight_matrix is not None
else weight_matrix)
ortho_probes_t, rwm_t = op(probes_t, weight_matrix=wm_t,
return_reexpressed_weights=True)
probes_t = t.as_tensor(probes)
wm_t = (
t.as_tensor(weight_matrix) if weight_matrix is not None else weight_matrix
)
ortho_probes_t, rwm_t = op(
probes_t, weight_matrix=wm_t, return_reexpressed_weights=True
)
assert t.is_tensor(ortho_probes_t)
assert t.is_tensor(rwm_t)
@@ -105,15 +111,17 @@ def test_orthogonalize_probes():
realized_probes = probes
calculated_probes = np.tensordot(rwm_np, ortho_probes_np, axes=1)
assert np.allclose(realized_probes, calculated_probes)
# Now we test if the orthogonalized probes are orthogonalized
reshaped_probes = ortho_probes_np.reshape(
(ortho_probes_np.shape[0],
ortho_probes_np.shape[1] * ortho_probes_np.shape[2]))
products = np.matmul(reshaped_probes,
reshaped_probes.conj().transpose())
(
ortho_probes_np.shape[0],
ortho_probes_np.shape[1] * ortho_probes_np.shape[2],
)
)
products = np.matmul(reshaped_probes, reshaped_probes.conj().transpose())
if weight_matrix is not None:
output_nmodes = min(weight_matrix.shape[0], probes.shape[0])
@@ -121,23 +129,22 @@ def test_orthogonalize_probes():
output_nmodes = probes.shape[0]
for i in range(output_nmodes):
for j in range(i+1, output_nmodes):
assert np.isclose(products[i,j], 0)
for j in range(i + 1, output_nmodes):
assert np.isclose(products[i, j], 0)
# And now we test if they multiply to the same density matrix as
# the original probes + weight matrix
reshaped_realized_probes = realized_probes.reshape(
(realized_probes.shape[0],
realized_probes.shape[1] * realized_probes.shape[2]))
(
realized_probes.shape[0],
realized_probes.shape[1] * realized_probes.shape[2],
)
)
dm_original = np.matmul(
reshaped_realized_probes.conj().transpose(),
reshaped_realized_probes
)
dm_output = np.matmul(
reshaped_probes.conj().transpose(),
reshaped_probes
reshaped_realized_probes.conj().transpose(), reshaped_realized_probes
)
dm_output = np.matmul(reshaped_probes.conj().transpose(), reshaped_probes)
assert np.allclose(dm_original, dm_output)
# And finally, we confirm that what we have are the eigenvectors/values
@@ -150,53 +157,58 @@ def test_orthogonalize_probes():
# is undefined
assert np.allclose(np.abs(cross_products), np.abs(products))
def test_standardize():
# Start by making a probe and object that should meet the standardization
# conditions
probe = initializers.gaussian((230,240),(20,20),curvature=(0.01,0.01)).numpy()
probe = probe * np.sqrt(len(probe.ravel()) / np.sum(np.abs(probe)**2))
probe = initializers.gaussian((230, 240), (20, 20), curvature=(0.01, 0.01)).numpy()
probe = probe * np.sqrt(len(probe.ravel()) / np.sum(np.abs(probe) ** 2))
probe = probe * np.exp(-1j * np.angle(np.sum(probe)))
assert np.isclose(1, np.sum(np.abs(probe)**2)/ len(probe.ravel()))
assert np.isclose(1, np.sum(np.abs(probe) ** 2) / len(probe.ravel()))
assert np.angle(np.sum(probe)) < 2e-7
obj = 30 * np.random.rand(230,240) * np.exp(1j * (np.random.rand(230,240) - 0.5))
obj_slice = np.s_[(obj.shape[0]//8)*3:(obj.shape[0]//8)*5,
(obj.shape[1]//8)*3:(obj.shape[1]//8)*5]
obj = 30 * np.random.rand(230, 240) * np.exp(1j * (np.random.rand(230, 240) - 0.5))
obj_slice = np.s_[
(obj.shape[0] // 8) * 3:(obj.shape[0] // 8) * 5,
(obj.shape[1] // 8) * 3:(obj.shape[1] // 8) * 5,
]
obj = obj * np.exp(-1j * np.angle(np.sum(obj[obj_slice])))
assert np.isclose(0,np.angle(np.sum(obj[obj_slice])))
assert np.isclose(0, np.angle(np.sum(obj[obj_slice])))
# Then make a nonstandard version of them and standardize it
# First, don't add a phase ramp and test
test_probe = probe * 37.6 * np.exp(1j*0.35)
test_obj = obj / 37.6 * np.exp(1j*1.43)
test_probe = probe * 37.6 * np.exp(1j * 0.35)
test_obj = obj / 37.6 * np.exp(1j * 1.43)
s_probe, s_obj = analysis.standardize(test_probe, test_obj)
assert np.allclose(probe, s_probe)
assert np.allclose(obj, s_obj)
# Test that it works on torch tensors
s_probe, s_obj = analysis.standardize(t.as_tensor(test_probe,dtype=t.complex64), t.as_tensor(test_obj,dtype=t.complex64))
s_probe, s_obj = analysis.standardize(
t.as_tensor(test_probe, dtype=t.complex64),
t.as_tensor(test_obj, dtype=t.complex64),
)
s_probe = s_probe.numpy()
s_obj = s_obj.numpy()
assert np.allclose(probe, s_probe)
assert np.allclose(obj, s_obj)
# Then do one with a phase ramp
phase_ramp_dir = (np.random.rand(2) - 0.5)
phase_ramp_dir = np.random.rand(2) - 0.5
probe_Xs, probe_Ys = np.mgrid[:probe.shape[0],:probe.shape[1]]
phase_ramp = np.exp(1j*probe_Ys * phase_ramp_dir[1]+
1j*probe_Xs * phase_ramp_dir[0])
probe_Xs, probe_Ys = np.mgrid[: probe.shape[0], : probe.shape[1]]
phase_ramp = np.exp(
1j * probe_Ys * phase_ramp_dir[1] + 1j * probe_Xs * phase_ramp_dir[0]
)
test_probe = test_probe * phase_ramp
obj_Xs, obj_Ys = np.mgrid[:obj.shape[0],:obj.shape[1]]
obj_phase_ramp = np.exp(-1j*obj_Ys * phase_ramp_dir[1]+
-1j*obj_Xs * phase_ramp_dir[0])
obj_Xs, obj_Ys = np.mgrid[: obj.shape[0], : obj.shape[1]]
obj_phase_ramp = np.exp(
-1j * obj_Ys * phase_ramp_dir[1] + -1j * obj_Xs * phase_ramp_dir[0]
)
test_obj = test_obj * obj_phase_ramp
s_probe, s_obj = analysis.standardize(test_probe, test_obj, correct_ramp=True)
@@ -205,12 +217,12 @@ def test_standardize():
assert np.max(s_obj - obj) / np.max(np.abs(obj)) < 1e-4
# Finally a test with the phase ramp and multiple probes
subdominant_probe = 0.1*np.random.rand(230,240) * np.exp(1j * (np.random.rand(230,240) - 0.5))
subdominant_probe = (0.1 * np.random.rand(230, 240) * np.exp(1j * (np.random.rand(230, 240) - 0.5)))
subdominant_probe = subdominant_probe * np.exp(-1j * np.angle(np.sum(subdominant_probe)))
test_subdominant_probe = subdominant_probe * 37.6
test_subdominant_probe = test_subdominant_probe * phase_ramp
incoh_probe = np.array([test_probe,test_subdominant_probe])
incoh_probe = np.array([test_probe, test_subdominant_probe])
s_probe, s_obj = analysis.standardize(incoh_probe, test_obj, correct_ramp=True)
@@ -219,7 +231,6 @@ def test_standardize():
assert np.max(s_probe[1] - subdominant_probe) / np.max(np.abs(subdominant_probe)) < 1e-4
def test_synthesize_reconstructions():
# I can only really test for a lack of failures, so I think my plan
# will be to create a dataset that just needs to be added and see that
@@ -227,140 +238,153 @@ def test_synthesize_reconstructions():
# Start by making a probe and object that should meet the standardization
# conditions
probe = initializers.gaussian((230,240),(20,20),curvature=(0.01,0.01)).numpy()
probe = probe * np.sqrt(len(probe.ravel()) / np.sum(np.abs(probe)**2))
probe = initializers.gaussian((230, 240), (20, 20), curvature=(0.01, 0.01)).numpy()
probe = probe * np.sqrt(len(probe.ravel()) / np.sum(np.abs(probe) ** 2))
probe = probe * np.exp(-1j * np.angle(np.sum(probe)))
assert np.isclose(1, np.sum(np.abs(probe)**2)/ len(probe.ravel()))
assert np.isclose(1, np.sum(np.abs(probe) ** 2) / len(probe.ravel()))
assert np.abs(np.angle(np.sum(probe))) < 2e-7
obj = 30 * np.random.rand(230,240) * np.exp(1j * (np.random.rand(230,240) - 0.5))
obj_slice = np.s_[(obj.shape[0]//8)*3:(obj.shape[0]//8)*5,
(obj.shape[1]//8)*3:(obj.shape[1]//8)*5]
obj = 30 * np.random.rand(230, 240) * np.exp(1j * (np.random.rand(230, 240) - 0.5))
obj_slice = np.s_[
(obj.shape[0] // 8) * 3:(obj.shape[0] // 8) * 5,
(obj.shape[1] // 8) * 3:(obj.shape[1] // 8) * 5,
]
obj = obj * np.exp(-1j * np.angle(np.sum(obj[obj_slice])))
assert np.isclose(0,np.angle(np.sum(obj[obj_slice])))
assert np.isclose(0, np.angle(np.sum(obj[obj_slice])))
# Now I make stacks of identical probes and objects
probes = [probe,probe,probe,probe]
probes = [probe, probe, probe, probe]
probe = np.copy(probe)
objects = [obj,obj,obj,obj]
objects = [obj, obj, obj, obj]
obj = np.copy(obj)
s_probe, s_obj, obj_stack = analysis.synthesize_reconstructions(probes,objects)
s_probe, s_obj, obj_stack = analysis.synthesize_reconstructions(probes, objects)
assert np.max(s_probe - probe) < 2e-5
assert np.max(s_obj - obj) < 2e-5
for t_obj in obj_stack:
assert np.max(t_obj - obj) < 5e-5
def test_calc_consistency_prtf():
# Create an object with a specific structure
obj = 30 * np.random.rand(1030,1040) * np.exp(1j * (np.random.rand(1030,1040) - 0.5))
obj = (30 * np.random.rand(1030, 1040) * np.exp(1j * (np.random.rand(1030, 1040) - 0.5)))
#
synth_obj = np.sqrt(0.7) * obj
obj_stack = [obj,obj,obj,obj]
obj_stack = [obj, obj, obj, obj]
basis = np.array([[0, 2, 0], [3, 0, 0]])
basis = np.array([[0,2,0],
[3,0,0]])
freqs, prtf = analysis.calc_consistency_prtf(synth_obj, obj_stack, basis)
assert np.allclose(prtf, 0.7)
freqs, prtf = analysis.calc_consistency_prtf(synth_obj, obj_stack, basis, nbins=30)
assert np.allclose(prtf, 0.7)
# Check that it also works with torch input
t_synth_obj = t.as_tensor(synth_obj)
t_obj_stack = [t.as_tensor(obj) for obj in obj_stack]
freqs, prtf = analysis.calc_consistency_prtf(t_synth_obj, t_obj_stack, basis, nbins=30)
freqs, prtf = analysis.calc_consistency_prtf(
t_synth_obj, t_obj_stack, basis, nbins=30
)
assert np.allclose(prtf.numpy(), 0.7)
# And also when the basis is in torch
t_synth_obj = t.as_tensor(synth_obj)
t_obj_stack = [t.as_tensor(obj) for obj in obj_stack]
freqs, prtf = analysis.calc_consistency_prtf(t_synth_obj, t_obj_stack, t.Tensor(basis), nbins=30)
freqs, prtf = analysis.calc_consistency_prtf(
t_synth_obj, t_obj_stack, t.Tensor(basis), nbins=30
)
assert np.allclose(prtf.numpy(), 0.7)
# Check that is uses the right number of bins
assert len(prtf) == 30
assert len(freqs) == 30
# Check that the maximum frequency is correct for the basis
assert np.isclose(freqs[-1]-freqs[-2] + freqs[-1], np.sqrt(1/4**2 + 1/6**2))
assert np.isclose(freqs[-1] - freqs[-2] + freqs[-1], np.sqrt(1 / 4**2 + 1 / 6**2))
def test_calc_deconvolved_cross_correlation():
obj1 = np.random.rand(200,300) + 1j * np.random.rand(200,300)
obj2 = np.random.rand(200,300) + 1j * np.random.rand(200,300)
obj1 = np.random.rand(200, 300) + 1j * np.random.rand(200, 300)
obj2 = np.random.rand(200, 300) + 1j * np.random.rand(200, 300)
cor_fft = np.fft.fft2(obj1) * np.conj(np.fft.fft2(obj2))
# Not sure if this is more or less stable than just the correlation
# maximum - requires some testing
np_cor = np.fft.ifft2(cor_fft / np.abs(cor_fft))
# test with numpy inputs
test_cor = analysis.calc_deconvolved_cross_correlation(obj1,obj2, im_slice=np.s_[:,:])
test_cor = analysis.calc_deconvolved_cross_correlation(
obj1, obj2, im_slice=np.s_[:, :]
)
assert np.allclose(test_cor, np_cor)
# test with pytorch inputs
obj1_t = t.as_tensor(obj1)
obj2_t = t.as_tensor(obj2)
test_cor_t = analysis.calc_deconvolved_cross_correlation(obj1_t,obj2_t, im_slice=np.s_[:,:])
test_cor_t = analysis.calc_deconvolved_cross_correlation(
obj1_t, obj2_t, im_slice=np.s_[:, :]
)
assert np.allclose(test_cor_t.numpy(), np_cor)
def test_calc_frc():
obj1 = np.random.rand(270,230) + 1j * np.random.rand(270,230)
obj2 = np.random.rand(270,230) + 1j * np.random.rand(270,230)
obj1 = np.random.rand(270, 230) + 1j * np.random.rand(270, 230)
obj2 = np.random.rand(270, 230) + 1j * np.random.rand(270, 230)
basis = np.array([[0,2,0],
[3,0,0]])
basis = np.array([[0, 2, 0], [3, 0, 0]])
nbins = 100
snr = 2
cor_fft = np.fft.fftshift(np.fft.fft2(obj1[10:-10,20:-20])) * \
np.fft.fftshift(np.conj(np.fft.fft2(obj2[10:-10,20:-20])))
F1 = np.abs(np.fft.fftshift(np.fft.fft2(obj1[10:-10,20:-20])))**2
F2 = np.abs(np.fft.fftshift(np.fft.fft2(obj2[10:-10,20:-20])))**2
di = np.linalg.norm(basis[:,0])
dj = np.linalg.norm(basis[:,1])
i_freqs = np.fft.fftshift(np.fft.fftfreq(cor_fft.shape[0],d=di))
j_freqs = np.fft.fftshift(np.fft.fftfreq(cor_fft.shape[1],d=dj))
Js,Is = np.meshgrid(j_freqs,i_freqs)
Rs = np.sqrt(Is**2+Js**2)
cor_fft = np.fft.fftshift(np.fft.fft2(obj1[10:-10, 20:-20])) * np.fft.fftshift(
np.conj(np.fft.fft2(obj2[10:-10, 20:-20]))
)
numerator, bins = np.histogram(Rs,bins=nbins,weights=cor_fft)
denominator_F1, bins = np.histogram(Rs,bins=nbins,weights=F1)
denominator_F2, bins = np.histogram(Rs,bins=nbins,weights=F2)
n_pix, bins = np.histogram(Rs,bins=nbins)
F1 = np.abs(np.fft.fftshift(np.fft.fft2(obj1[10:-10, 20:-20]))) ** 2
F2 = np.abs(np.fft.fftshift(np.fft.fft2(obj2[10:-10, 20:-20]))) ** 2
di = np.linalg.norm(basis[:, 0])
dj = np.linalg.norm(basis[:, 1])
i_freqs = np.fft.fftshift(np.fft.fftfreq(cor_fft.shape[0], d=di))
j_freqs = np.fft.fftshift(np.fft.fftfreq(cor_fft.shape[1], d=dj))
Js, Is = np.meshgrid(j_freqs, i_freqs)
Rs = np.sqrt(Is**2 + Js**2)
numerator, bins = np.histogram(Rs, bins=nbins, weights=cor_fft)
denominator_F1, bins = np.histogram(Rs, bins=nbins, weights=F1)
denominator_F2, bins = np.histogram(Rs, bins=nbins, weights=F2)
n_pix, bins = np.histogram(Rs, bins=nbins)
bins = bins[:-1]
frc = numerator / np.sqrt(denominator_F1*denominator_F2)
# This moves from combined-image SNR to single-image SNR
frc = numerator / np.sqrt(denominator_F1 * denominator_F2)
# This moves from combined-image SNR to single-image SNR
snr /= 2
threshold = (snr + (2 * snr + 1) / np.sqrt(n_pix)) / \
(1 + snr + (2 * np.sqrt(snr)) / np.sqrt(n_pix))
threshold = (snr + (2 * snr + 1) / np.sqrt(n_pix)) / (
1 + snr + (2 * np.sqrt(snr)) / np.sqrt(n_pix)
)
test_bins, test_frc, test_threshold = analysis.calc_frc(
obj1, obj2, basis, im_slice=np.s_[10:-10,20:-20],
nbins=100, snr=2, limit='corner')
obj1,
obj2,
basis,
im_slice=np.s_[10:-10, 20:-20],
nbins=100,
snr=2,
limit="corner",
)
assert np.allclose(bins, test_bins)
assert np.allclose(frc, test_frc)
assert np.allclose(threshold, test_threshold)
@@ -374,33 +398,40 @@ def test_calc_frc():
obj1_torch,
obj2_torch,
basis_torch,
im_slice=np.s_[10:-10,20:-20], nbins=100, snr=2, limit='corner')
im_slice=np.s_[10:-10, 20:-20],
nbins=100,
snr=2,
limit="corner",
)
assert np.allclose(bins, test_bins_t.numpy())
assert np.allclose(frc, test_frc_t.numpy())
assert np.allclose(threshold, test_threshold_t.numpy())
def test_calc_rms_error():
field_1 = t.rand(14,19, dtype=t.complex64)
field_2 = t.rand(14,19, dtype=t.complex64)
field_1 = t.rand(14, 19, dtype=t.complex64)
field_2 = t.rand(14, 19, dtype=t.complex64)
# Check that the calculation is insensitive to phase
assert t.allclose(analysis.calc_rms_error(field_1, field_2),
analysis.calc_rms_error(field_1, np.exp(0.7j) * field_2))
assert t.allclose(
analysis.calc_rms_error(field_1, field_2),
analysis.calc_rms_error(field_1, np.exp(0.7j) * field_2),
)
# And that it is sensitive to phase if we turn off the
# And that it is sensitive to phase if we turn off the
assert not t.allclose(
analysis.calc_rms_error(field_1, field_2, align_phases=False),
analysis.calc_rms_error(field_1, np.exp(0.7j) * field_2,
align_phases=False))
analysis.calc_rms_error(field_1, np.exp(0.7j) * field_2, align_phases=False),
)
# Check that the result is positive
assert analysis.calc_rms_error(field_1, field_2) > 0
# And that it is a smaller number with align_phases on
assert (analysis.calc_rms_error(field_1, field_2) <=
analysis.calc_rms_error(field_1, field_2, align_phases=False))
assert analysis.calc_rms_error(field_1, field_2) <= analysis.calc_rms_error(
field_1, field_2, align_phases=False
)
# Now we check against an explicit implementation:
gamma = field_1 * t.conj(field_2)
@@ -408,114 +439,126 @@ def test_calc_rms_error():
# This is an alternate way of doing the calculation. Actually, would this
# be a better implementation anyway? Probably no difference tbh.
rms_error_nophase = t.sqrt((t.mean(t.abs(field_1)**2) +
t.mean(t.abs(field_2)**2) -
2 * t.abs(t.mean(field_1 * t.conj(field_2)))))
assert t.allclose(rms_error_nophase,
analysis.calc_rms_error(field_1, field_2))
rms_error_nophase = t.sqrt(
(
t.mean(t.abs(field_1) ** 2)
+ t.mean(t.abs(field_2) ** 2)
- 2 * t.abs(t.mean(field_1 * t.conj(field_2)))
)
)
assert t.allclose(rms_error_nophase, analysis.calc_rms_error(field_1, field_2))
rms_error_phase = t.sqrt((t.mean(t.abs(field_1)**2) +
t.mean(t.abs(field_2)**2) -
2 * t.real(t.mean(field_1 * t.conj(field_2)))))
rms_error_phase = t.sqrt(
(
t.mean(t.abs(field_1) ** 2)
+ t.mean(t.abs(field_2) ** 2)
- 2 * t.real(t.mean(field_1 * t.conj(field_2)))
)
)
assert t.allclose(rms_error_phase,
analysis.calc_rms_error(field_1, field_2,
align_phases=False))
assert t.allclose(
rms_error_phase, analysis.calc_rms_error(field_1, field_2, align_phases=False)
)
# Now let's test that it works along a dimension:
field_1 = t.rand(3,14,19, dtype=t.complex64)
field_2 = t.rand(3,14,19, dtype=t.complex64)
field_1 = t.rand(3, 14, 19, dtype=t.complex64)
field_2 = t.rand(3, 14, 19, dtype=t.complex64)
result = analysis.calc_rms_error(field_1, field_2, normalize=True)
assert (result.shape == t.Size([3]))
assert result.shape == t.Size([3])
for i in range(3):
assert t.allclose(analysis.calc_rms_error(field_1[i],
field_2[i],
normalize=True),
result[i])
assert t.allclose(
analysis.calc_rms_error(field_1[i], field_2[i], normalize=True), result[i]
)
def test_calc_fidelity():
fields_1 = t.rand(2,30,17, dtype=t.complex128)
fields_2 = t.rand(3,30,17, dtype=t.complex128)
fields_1 = t.rand(2, 30, 17, dtype=t.complex128)
fields_2 = t.rand(3, 30, 17, dtype=t.complex128)
dm_1 = t.reshape(fields_1, (2,-1))
dm_1 = t.tensordot(dm_1.transpose(0,1), dm_1.conj(), dims=1).numpy()
dm_2 = t.reshape(fields_2, (3,-1))
dm_2 = t.tensordot(dm_2.transpose(0,1), dm_2.conj(), dims=1).numpy()
dm_1 = t.reshape(fields_1, (2, -1))
dm_1 = t.tensordot(dm_1.transpose(0, 1), dm_1.conj(), dims=1).numpy()
dm_2 = t.reshape(fields_2, (3, -1))
dm_2 = t.tensordot(dm_2.transpose(0, 1), dm_2.conj(), dims=1).numpy()
sqrt_dm_1 = la.sqrtm(dm_1).astype(dm_1.dtype)
inner_mat = la.sqrtm(np.dot(np.dot(sqrt_dm_1,dm_2), sqrt_dm_1))
inner_mat = inner_mat.astype(dm_1.dtype) #la.sqrtm doubles the precision
fidelity = t.as_tensor(np.abs(np.trace(inner_mat))**2)
inner_mat = la.sqrtm(np.dot(np.dot(sqrt_dm_1, dm_2), sqrt_dm_1))
inner_mat = inner_mat.astype(dm_1.dtype) # la.sqrtm doubles the precision
fidelity = t.as_tensor(np.abs(np.trace(inner_mat)) ** 2)
assert t.isclose(fidelity, analysis.calc_fidelity(fields_1, fields_2))
# Check that it reduces to the overlap for coherent fields
fields_1 = t.rand(1,30,17, dtype=t.complex128)
fields_2 = t.rand(1,30,17, dtype=t.complex128)
fields_1 = t.rand(1, 30, 17, dtype=t.complex128)
fields_2 = t.rand(1, 30, 17, dtype=t.complex128)
assert t.isclose(t.abs(t.sum(fields_1*fields_2.conj()))**2,
analysis.calc_fidelity(fields_1, fields_2))
assert t.isclose(
t.abs(t.sum(fields_1 * fields_2.conj())) ** 2,
analysis.calc_fidelity(fields_1, fields_2),
)
# Checking that it works with extra dimensions
fields_1 = t.rand(3,3,30,17, dtype=t.complex128)
fields_2 = t.rand(3,1,30,17, dtype=t.complex128)
field_3 = t.rand(1,30,17, dtype=t.complex128)
fields_1 = t.rand(3, 3, 30, 17, dtype=t.complex128)
fields_2 = t.rand(3, 1, 30, 17, dtype=t.complex128)
field_3 = t.rand(1, 30, 17, dtype=t.complex128)
fidelities = analysis.calc_fidelity(fields_1, fields_2)
fidelities_2 = analysis.calc_fidelity(fields_1, field_3)
for i in range(3):
assert t.isclose(analysis.calc_fidelity(fields_1[i], fields_2[i]),
fidelities[i])
assert t.isclose(analysis.calc_fidelity(fields_1[i], field_3),
fidelities_2[i])
assert t.isclose(
analysis.calc_fidelity(fields_1[i], fields_2[i]), fidelities[i]
)
assert t.isclose(analysis.calc_fidelity(fields_1[i], field_3), fidelities_2[i])
# Check that the diensionality argument works
fields_1 = t.rand(3,2,12, dtype=t.complex128)
fields_2 = t.rand(3,2,12, dtype=t.complex128)
fields_1 = t.rand(3, 2, 12, dtype=t.complex128)
fields_2 = t.rand(3, 2, 12, dtype=t.complex128)
assert (analysis.calc_fidelity(fields_1, fields_2, dims=1).shape
== t.Size([3]))
fields_1 = t.rand(3,2,12,4,5, dtype=t.complex128)
fields_2 = t.rand(3,2,12,4,5, dtype=t.complex128)
assert analysis.calc_fidelity(fields_1, fields_2, dims=1).shape == t.Size([3])
fields_1 = t.rand(3, 2, 12, 4, 5, dtype=t.complex128)
fields_2 = t.rand(3, 2, 12, 4, 5, dtype=t.complex128)
assert analysis.calc_fidelity(fields_1, fields_2, dims=3).shape == t.Size([3])
assert (analysis.calc_fidelity(fields_1, fields_2, dims=3).shape
== t.Size([3]))
def test_calc_generalized_rms_error():
# Test that it matches the rms error for coherent fields
fields_1 = t.rand(1,30,17, dtype=t.complex128)
fields_2 = t.rand(1,30,17, dtype=t.complex128)
assert t.isclose(analysis.calc_generalized_rms_error(fields_1, fields_2),
analysis.calc_rms_error(fields_1[0], fields_2[0],
align_phases=True))
fields_1 = t.rand(1, 30, 17, dtype=t.complex128)
fields_2 = t.rand(1, 30, 17, dtype=t.complex128)
assert t.isclose(
analysis.calc_generalized_rms_error(fields_1, fields_2),
analysis.calc_rms_error(fields_1[0], fields_2[0], align_phases=True),
)
# Test that it is independent of field order
fields_1 = t.rand(5,30,17, dtype=t.complex128)
fields_2 = t.rand(3,30,17, dtype=t.complex128)
fields_1 = t.rand(5, 30, 17, dtype=t.complex128)
fields_2 = t.rand(3, 30, 17, dtype=t.complex128)
fields_3 = fields_2.flip(0)
assert t.isclose(analysis.calc_generalized_rms_error(fields_1, fields_2),
analysis.calc_generalized_rms_error(fields_1, fields_3))
assert t.isclose(
analysis.calc_generalized_rms_error(fields_1, fields_2),
analysis.calc_generalized_rms_error(fields_1, fields_3),
)
# Test with leading dimensions
fields_1 = t.rand(3,4,2,10,17, dtype=t.complex128)
fields_2 = t.rand(3,4,3,10,17, dtype=t.complex128)
assert (analysis.calc_generalized_rms_error(fields_1, fields_2).shape
== t.Size([3,4]))
fields_1 = t.rand(3, 4, 2, 10, 17, dtype=t.complex128)
fields_2 = t.rand(3, 4, 3, 10, 17, dtype=t.complex128)
assert analysis.calc_generalized_rms_error(fields_1, fields_2).shape == t.Size(
[3, 4]
)
# And test with different number of dimensions dims
# Test that it is independent of field order
fields_1 = t.rand(3,6,17, dtype=t.complex128)
fields_2 = t.rand(3,1,17, dtype=t.complex128)
fields_1 = t.rand(3, 6, 17, dtype=t.complex128)
fields_2 = t.rand(3, 1, 17, dtype=t.complex128)
fields_3 = fields_2.flip(0)
assert (analysis.calc_generalized_rms_error(fields_1, fields_2, dims=1).shape == t.Size([3]))
assert analysis.calc_generalized_rms_error(
fields_1, fields_2, dims=1
).shape == t.Size([3])
+76 -87
View File
@@ -1,60 +1,55 @@
from cdtools.tools import data
import numpy as np
import torch as t
import h5py
import pytest
import os
import datetime
import numbers
import pathlib
import h5py
import numpy as np
import torch as t
from cdtools.tools import data
#
# We start with a bunch of tests of the data loading capabilities
#
def test_get_entry_info(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
entry_info = data.get_entry_info(cxi)
for key in expected['entry metadata']:
assert entry_info[key] == expected['entry metadata'][key]
def test_get_sample_info(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
sample_info = data.get_sample_info(cxi)
if sample_info is None and \
('sample info' not in expected or
expected['sample info'] is None):
('sample info' not in expected or expected['sample info'] is None):
# Valid if no sample info is defined at all
continue
for key in expected['sample info']:
if isinstance(expected['sample info'][key],np.ndarray):
if isinstance(expected['sample info'][key], np.ndarray):
assert np.allclose(sample_info[key],
expected['sample info'][key])
else:
assert sample_info[key] == expected['sample info'][key]
def test_get_wavelength(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
assert np.isclose(expected['wavelength'],data.get_wavelength(cxi))
assert np.isclose(expected['wavelength'], data.get_wavelength(cxi))
def test_get_detector_geometry(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
distance, basis, corner = data.get_detector_geometry(cxi)
assert np.isclose(distance,expected['detector']['distance'])
assert np.allclose(basis,expected['detector']['basis'])
assert np.isclose(distance, expected['detector']['distance'])
assert np.allclose(basis, expected['detector']['basis'])
if isinstance(expected['detector']['corner'], np.ndarray):
assert np.allclose(corner, expected['detector']['corner'])
else:
assert corner == expected['detector']['corner']
def test_get_mask(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
mask = data.get_mask(cxi)
@@ -62,7 +57,7 @@ def test_get_mask(test_ptycho_cxis):
continue
assert np.all(mask == expected['mask'])
def test_get_qe_mask(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
qe_mask = data.get_qe_mask(cxi)
@@ -78,8 +73,8 @@ def test_get_dark(test_ptycho_cxis):
assert expected['dark'] is None
else:
assert np.allclose(dark, expected['dark'])
def test_get_data(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
patterns, axes = data.get_data(cxi)
@@ -99,8 +94,6 @@ def test_get_ptycho_translations(test_ptycho_cxis):
assert np.allclose(data.get_ptycho_translations(cxi),
expected['translations'])
#
# Then, write a test for the data saving. It should create a .cxi file
# using the data seving tools, and then check that when read with the
@@ -110,13 +103,13 @@ def test_get_ptycho_translations(test_ptycho_cxis):
def test_create_cxi(tmp_path):
data.create_cxi(tmp_path / 'test_create.cxi')
with h5py.File(tmp_path / 'test_create.cxi','r') as f:
with h5py.File(tmp_path / 'test_create.cxi', 'r') as f:
assert f['cxi_version'][()] == 160
assert 'entry_1' in f
def test_add_entry_info(tmp_path):
entry_info = {'experiment_identifier':'test of cxi file writing tools',
entry_info = {'experiment_identifier': 'test of cxi file writing tools',
'title': 'my cool experiment',
'start_time': datetime.datetime.now(),
'end_time': datetime.datetime.now()}
@@ -124,12 +117,11 @@ def test_add_entry_info(tmp_path):
with data.create_cxi(tmp_path / 'test_add_entry_info.cxi') as f:
data.add_entry_info(f, entry_info)
with h5py.File(tmp_path / 'test_add_entry_info.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_entry_info.cxi', 'r') as f:
read_entry_info = data.get_entry_info(f)
print(read_entry_info)
for key in entry_info:
if isinstance(entry_info[key], np.ndarray):
assert np.allclose(entry_info[key], read_entry_info[key])
@@ -138,18 +130,18 @@ def test_add_entry_info(tmp_path):
def test_add_sample_info(tmp_path):
sample_info = {'name':'A nice fake sample',
sample_info = {'name': 'A nice fake sample',
'concentration': 10,
'mass': 5.3,
'temperature': 76,
'description': 'A very nice sample',
'unit_cell': np.array([1,1,1,90.,90.,90.])}
'unit_cell': np.array([1, 1, 1, 90., 90., 90.])}
with data.create_cxi(tmp_path / 'test_add_sample_info.cxi') as f:
data.add_sample_info(f, sample_info)
with h5py.File(tmp_path / 'test_add_sample_info.cxi','r') as f:
read_sample_info = data.get_sample_info(f)
with h5py.File(tmp_path / 'test_add_sample_info.cxi', 'r') as f:
read_sample_info = data.get_sample_info(f)
for key in sample_info:
if isinstance(sample_info[key], np.ndarray):
@@ -158,7 +150,7 @@ def test_add_sample_info(tmp_path):
assert np.isclose(sample_info[key], read_sample_info[key])
else:
assert sample_info[key] == read_sample_info[key]
def test_add_source(tmp_path):
wavelength = 1e-9
@@ -167,26 +159,26 @@ def test_add_source(tmp_path):
with data.create_cxi(tmp_path / 'test_add_source.cxi') as f:
data.add_source(f, wavelength)
with h5py.File(tmp_path / 'test_add_source.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_source.cxi', 'r') as f:
# Check this directly since we want to make sure it saved
# the wavelength and energy
read_wavelength = f['entry_1/instrument_1/source_1/wavelength'][()]
read_energy = f['entry_1/instrument_1/source_1/energy'][()]
assert np.isclose( wavelength, read_wavelength)
assert np.isclose( energy, read_energy)
assert np.isclose(wavelength, read_wavelength)
assert np.isclose(energy, read_energy)
def test_add_detector(tmp_path):
distance = 0.34
basis = np.array([[0,-30e-6,0],
[-20e-6,0,0]]).astype(np.float32).transpose()
corner = np.array((2550e-6,3825e-6,0.3)).astype(np.float32)
basis = np.array([[0, -30e-6, 0],
[-20e-6, 0, 0]]).astype(np.float32).transpose()
corner = np.array((2550e-6, 3825e-6, 0.3)).astype(np.float32)
with data.create_cxi(tmp_path / 'test_add_detector.cxi') as f:
data.add_detector(f, distance, basis, corner=corner)
with h5py.File(tmp_path / 'test_add_detector.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_detector.cxi', 'r') as f:
# Check this directly since we want to make sure it saved
# the pixel sizes
d1 = f['entry_1/instrument_1/detector_1']
@@ -198,112 +190,110 @@ def test_add_detector(tmp_path):
assert np.isclose(distance, read_distance)
assert np.allclose(basis, read_basis)
assert np.isclose(np.linalg.norm(basis[:,1]), read_x_pix)
assert np.isclose(np.linalg.norm(basis[:,0]), read_y_pix)
assert np.allclose(corner,read_corner)
assert np.isclose(np.linalg.norm(basis[:, 1]), read_x_pix)
assert np.isclose(np.linalg.norm(basis[:, 0]), read_y_pix)
assert np.allclose(corner, read_corner)
def test_add_mask(tmp_path):
mask = (np.random.rand(350,600) > 0.1).astype(np.uint8)
mask = (np.random.rand(350, 600) > 0.1).astype(np.uint8)
with data.create_cxi(tmp_path / 'test_add_mask.cxi') as f:
data.add_mask(f, mask)
with h5py.File(tmp_path / 'test_add_mask.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_mask.cxi', 'r') as f:
read_mask = data.get_mask(f)
assert np.all(mask == read_mask)
def test_add_qe_mask(tmp_path):
qe_mask = np.random.rand(350,199).astype(np.float32)
qe_mask = np.random.rand(350, 199).astype(np.float32)
with data.create_cxi(tmp_path / 'test_add_qe_mask.cxi') as f:
data.add_qe_mask(f, qe_mask)
with h5py.File(tmp_path / 'test_add_qe_mask.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_qe_mask.cxi', 'r') as f:
read_qe_mask = data.get_qe_mask(f)
assert np.allclose(qe_mask, read_qe_mask)
def test_add_dark(tmp_path):
dark = np.random.rand(350,620)
dark = np.random.rand(350, 620)
with data.create_cxi(tmp_path / 'test_add_dark.cxi') as f:
data.add_dark(f, dark)
with h5py.File(tmp_path / 'test_add_dark.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_dark.cxi', 'r') as f:
read_dark = data.get_dark(f)
print(dark.shape)
assert np.allclose(dark, read_dark)
def test_add_data(tmp_path):
# First test from numpy, with axes
fake_data = np.random.rand(100,256,256)
axes = ['translation','y','x']
fake_data = np.random.rand(100, 256, 256)
axes = ['translation', 'y', 'x']
with data.create_cxi(tmp_path / 'test_add_data.cxi') as f:
data.add_data(f, fake_data, axes)
with h5py.File(tmp_path / 'test_add_data.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_data.cxi', 'r') as f:
# Check this directly since we want to make sure it saved
# it in all the places it should have
read_data_1 = f['entry_1/data_1/data'][()]
read_data_2 = f['entry_1/instrument_1/detector_1/data'][()]
read_axes = str(f['entry_1/instrument_1/detector_1/data'].attrs['axes'].decode())
assert np.allclose(fake_data, read_data_1)
assert np.allclose(fake_data, read_data_2)
assert 'translation:y:x' == read_axes
# Then test from torch, without axes
fake_data = t.from_numpy(fake_data)
with data.create_cxi(tmp_path / 'test_add_data_torch.cxi') as f:
data.add_data(f, fake_data)
with h5py.File(tmp_path / 'test_add_data_torch.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_data_torch.cxi', 'r') as f:
read_data, axes = data.get_data(f)
assert np.allclose(fake_data.numpy(),read_data)
assert np.allclose(fake_data.numpy(), read_data)
def test_add_shot_to_shot_info(tmp_path):
analyzer = np.random.rand(100)
with data.create_cxi(tmp_path / 'test_add_shot_to_shot_info.cxi') as f:
data.add_shot_to_shot_info(f, analyzer, 'analyzer_angle')
with h5py.File(tmp_path / 'test_add_shot_to_shot_info.cxi') as f:
# Check this directly since we want to make sure it saved
# it in all the places it should have
read_analyzer_1 = f['entry_1/data_1/analyzer_angle'][()]
read_analyzer_2 = \
f['entry_1/instrument_1/detector_1/analyzer_angle'][()]
read_analyzer_2 = f['entry_1/instrument_1/detector_1/analyzer_angle'][()]
read_analyzer_3 = f['entry_1/sample_1/geometry_1/analyzer_angle'][()]
assert np.allclose(analyzer, read_analyzer_1)
assert np.allclose(analyzer, read_analyzer_2)
assert np.allclose(analyzer, read_analyzer_3)
def test_add_ptycho_translations(tmp_path):
translations = np.random.rand(3,100)
translations = np.random.rand(3, 100)
with data.create_cxi(tmp_path / 'test_add_ptycho_translations.cxi') as f:
data.add_ptycho_translations(f, translations)
with h5py.File(tmp_path / 'test_add_ptycho_translations.cxi','r') as f:
with h5py.File(tmp_path / 'test_add_ptycho_translations.cxi', 'r') as f:
# Check this directly since we want to make sure it saved
# it in all the places it should have
read_translations_1 = f['entry_1/data_1/translation'][()]
read_translations_2 = \
f['entry_1/instrument_1/detector_1/translation'][()]
read_translations_2 = f['entry_1/instrument_1/detector_1/translation'][()]
read_translations_3 = f['entry_1/sample_1/geometry_1/translation'][()]
assert np.allclose(-translations, read_translations_1)
@@ -312,8 +302,7 @@ def test_add_ptycho_translations(tmp_path):
def test_nested_dict_to_h5(tmp_path, example_nested_dicts):
### Tests both nested_dict_to_h5 and h5_to_nested_dict
# Tests both nested_dict_to_h5 and h5_to_nested_dict
def check_dict_equality(truth, to_test):
for key in truth.keys():
if isinstance(truth[key], dict):
@@ -328,23 +317,24 @@ def test_nested_dict_to_h5(tmp_path, example_nested_dicts):
assert truth[key] == to_test[key]
else:
assert 0
for test_dict in example_nested_dicts:
filename = tmp_path / 'example_dataset.h5'
data.nested_dict_to_h5(filename, test_dict)
roundtrip = data.h5_to_nested_dict(filename)
check_dict_equality(test_dict, roundtrip)
def test_h5_to_nested_dict(test_ptycho_cxis):
for cxi, expected in test_ptycho_cxis:
# Just test that it runs without errors for these ones.
# A round-trip test is in test_nested_dict_to_h5
d = data.h5_to_nested_dict(cxi)
data.h5_to_nested_dict(cxi)
def test_nested_dict_to_numpy(example_nested_dicts):
def check_dict_numpyness(truth, to_test):
def check_dict_numpyness(truth, to_test):
for key in truth.keys():
if isinstance(truth[key], dict):
check_dict_numpyness(truth[key], to_test[key])
@@ -361,12 +351,11 @@ def test_nested_dict_to_numpy(example_nested_dicts):
for test_dict in example_nested_dicts:
numpy_dict = data.nested_dict_to_numpy(test_dict)
check_dict_numpyness(test_dict, numpy_dict)
def test_nested_dict_to_torch(example_nested_dicts):
check_dict_numpyness(test_dict, numpy_dict)
def check_dict_torchiness(truth, to_test):
def test_nested_dict_to_torch(example_nested_dicts):
def check_dict_torchiness(truth, to_test):
for key in truth.keys():
if isinstance(truth[key], dict):
check_dict_torchiness(truth[key], to_test[key])