360 lines
13 KiB
Python
360 lines
13 KiB
Python
""" This module contains tests for the simulation devices in ophyd_devices """
|
|
|
|
# pylint: disable: all
|
|
import os
|
|
from unittest import mock
|
|
|
|
import h5py
|
|
import numpy as np
|
|
import pytest
|
|
from bec_server.device_server.tests.utils import DMMock
|
|
from ophyd import Device, Signal
|
|
|
|
from ophyd_devices.interfaces.protocols.bec_protocols import (
|
|
BECDeviceProtocol,
|
|
BECFlyerProtocol,
|
|
BECPositionerProtocol,
|
|
BECScanProtocol,
|
|
BECSignalProtocol,
|
|
)
|
|
from ophyd_devices.sim.sim import SimCamera, SimFlyer, SimMonitor, SimPositioner
|
|
from ophyd_devices.sim.sim_frameworks import H5ImageReplayProxy, SlitProxy
|
|
from ophyd_devices.sim.sim_signals import ReadOnlySignal
|
|
from ophyd_devices.sim.sim_utils import H5Writer
|
|
from ophyd_devices.utils.bec_device_base import BECDevice, BECDeviceBase
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def signal(name="signal"):
|
|
"""Fixture for Signal."""
|
|
sig = ReadOnlySignal(name=name, value=0)
|
|
yield sig
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def monitor(name="monitor"):
|
|
"""Fixture for SimMonitor."""
|
|
dm = DMMock()
|
|
mon = SimMonitor(name=name, device_manager=dm)
|
|
yield mon
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def camera(name="camera"):
|
|
"""Fixture for SimCamera."""
|
|
dm = DMMock()
|
|
with (
|
|
mock.patch(
|
|
"ophyd_devices.interfaces.base_classes.psi_detector_base.PSIDetectorBase._update_service_config",
|
|
mock.MagicMock(),
|
|
) as mock_update_service_config,
|
|
mock.patch(
|
|
"ophyd_devices.interfaces.base_classes.psi_detector_base.PSIDetectorBase._update_filewriter",
|
|
mock.MagicMock(),
|
|
) as mock_update_filewriter,
|
|
):
|
|
cam = SimCamera(name=name, device_manager=dm)
|
|
cam.filewriter = mock.MagicMock()
|
|
cam.filewriter.compile_full_filename.return_value = ""
|
|
yield cam
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def positioner(name="positioner"):
|
|
"""Fixture for SimPositioner."""
|
|
dm = DMMock()
|
|
pos = SimPositioner(name=name, device_manager=dm)
|
|
yield pos
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def h5proxy_fixture(camera, name="h5proxy"):
|
|
"""Fixture for SimCamera."""
|
|
dm = camera.device_manager
|
|
proxy = H5ImageReplayProxy(name=name, device_manager=dm)
|
|
yield proxy, camera
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def slitproxy_fixture(camera, name="slit_proxy"):
|
|
"""Fixture for SimCamera."""
|
|
dm = camera.device_manager
|
|
proxy = SlitProxy(name=name, device_manager=dm)
|
|
samx = SimPositioner(name="samx", device_manager=dm)
|
|
yield proxy, camera, samx
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def flyer(name="flyer"):
|
|
"""Fixture for SimFlyer."""
|
|
dm = DMMock()
|
|
fly = SimFlyer(name=name, device_manager=dm)
|
|
yield fly
|
|
|
|
|
|
def test_signal__init__(signal):
|
|
"""Test the BECProtocol class"""
|
|
assert isinstance(signal, BECDeviceProtocol)
|
|
assert isinstance(signal, BECSignalProtocol)
|
|
|
|
|
|
def test_monitor__init__(monitor):
|
|
"""Test the __init__ method of SimMonitor."""
|
|
assert isinstance(monitor, SimMonitor)
|
|
assert isinstance(monitor, BECDeviceProtocol)
|
|
assert isinstance(monitor, BECScanProtocol)
|
|
|
|
|
|
def test_camera__init__(camera):
|
|
"""Test the __init__ method of SimMonitor."""
|
|
assert isinstance(camera, SimCamera)
|
|
assert isinstance(camera, BECDeviceProtocol)
|
|
assert isinstance(camera, BECScanProtocol)
|
|
|
|
|
|
def test_positioner__init__(positioner):
|
|
"""Test the __init__ method of SimPositioner."""
|
|
assert isinstance(positioner, SimPositioner)
|
|
assert isinstance(positioner, BECDeviceProtocol)
|
|
assert isinstance(positioner, BECScanProtocol)
|
|
assert isinstance(positioner, BECPositionerProtocol)
|
|
|
|
|
|
def test_flyer__init__(flyer):
|
|
"""Test the __init__ method of SimFlyer."""
|
|
assert isinstance(flyer, SimFlyer)
|
|
assert isinstance(flyer, BECDeviceProtocol)
|
|
assert isinstance(flyer, BECScanProtocol)
|
|
assert isinstance(flyer, BECFlyerProtocol)
|
|
|
|
|
|
@pytest.mark.parametrize("center", [-10, 0, 10])
|
|
def test_monitor_readback(monitor, center):
|
|
"""Test the readback method of SimMonitor."""
|
|
motor_pos = 0
|
|
monitor.device_manager.add_device("samx", value=motor_pos)
|
|
for model_name in monitor.sim.sim_get_models():
|
|
monitor.sim.sim_select_model(model_name)
|
|
monitor.sim.sim_params["noise_multipler"] = 10
|
|
monitor.sim.sim_params["ref_motor"] = "samx"
|
|
if "c" in monitor.sim.sim_params:
|
|
monitor.sim.sim_params["c"] = center
|
|
elif "center" in monitor.sim.sim_params:
|
|
monitor.sim.sim_params["center"] = center
|
|
assert isinstance(monitor.read()[monitor.name]["value"], monitor.BIT_DEPTH)
|
|
expected_value = monitor.sim._model.eval(monitor.sim._model_params, x=motor_pos)
|
|
print(expected_value, monitor.read()[monitor.name]["value"])
|
|
tolerance = (
|
|
monitor.sim.sim_params["noise_multipler"] + 1
|
|
) # due to ceiling in calculation, but maximum +1int
|
|
assert np.isclose(
|
|
monitor.read()[monitor.name]["value"],
|
|
expected_value,
|
|
atol=monitor.sim.sim_params["noise_multipler"] + 1,
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize("amplitude, noise_multiplier", [(0, 1), (100, 10), (1000, 50)])
|
|
def test_camera_readback(camera, amplitude, noise_multiplier):
|
|
"""Test the readback method of SimMonitor."""
|
|
for model_name in camera.sim.sim_get_models():
|
|
camera.sim.sim_select_model(model_name)
|
|
camera.sim.sim_params = {"noise_multiplier": noise_multiplier}
|
|
camera.sim.sim_params = {"amplitude": amplitude}
|
|
camera.sim.sim_params = {"noise": "poisson"}
|
|
assert camera.image.get().shape == camera.SHAPE
|
|
assert isinstance(camera.image.get()[0, 0], camera.BIT_DEPTH)
|
|
camera.sim.sim_params = {"noise": "uniform"}
|
|
camera.sim.sim_params = {"hot_pixel_coords": []}
|
|
camera.sim.sim_params = {"hot_pixel_values": []}
|
|
camera.sim.sim_params = {"hot_pixel_types": []}
|
|
assert camera.image.get().shape == camera.SHAPE
|
|
assert isinstance(camera.image.get()[0, 0], camera.BIT_DEPTH)
|
|
assert (camera.image.get() <= (amplitude + noise_multiplier + 1)).all()
|
|
|
|
|
|
def test_positioner_move(positioner):
|
|
"""Test the move method of SimPositioner."""
|
|
positioner.move(0).wait()
|
|
assert np.isclose(positioner.read()[positioner.name]["value"], 0, atol=positioner.tolerance)
|
|
positioner.move(10).wait()
|
|
assert np.isclose(positioner.read()[positioner.name]["value"], 10, atol=positioner.tolerance)
|
|
|
|
|
|
@pytest.mark.parametrize("proxy_active", [True, False])
|
|
def test_sim_camera_proxies(camera, proxy_active):
|
|
"""Test mocking compute_method with framework class"""
|
|
camera.device_manager.add_device("test_proxy")
|
|
if proxy_active:
|
|
camera._registered_proxies["test_proxy"] = camera.image.name
|
|
else:
|
|
camera._registered_proxies = {}
|
|
proxy = camera.device_manager.devices["test_proxy"]
|
|
mock_method = mock.MagicMock()
|
|
mock_obj = proxy.obj
|
|
mock_obj.lookup = mock.MagicMock()
|
|
mock_obj.lookup.return_value = {camera.name: {"method": mock_method, "args": 1, "kwargs": 1}}
|
|
camera.image.read()
|
|
if proxy_active:
|
|
assert len(mock_obj.lookup.mock_calls) > 0
|
|
elif not proxy_active:
|
|
assert len(mock_obj.lookup.mock_calls) == 0
|
|
|
|
|
|
def test_BECDeviceBase():
|
|
# Test the BECDeviceBase class
|
|
bec_device_base = BECDeviceBase(name="test")
|
|
assert isinstance(bec_device_base, BECDevice)
|
|
assert bec_device_base.connected is True
|
|
signal = Signal(name="signal")
|
|
assert isinstance(signal, BECDevice)
|
|
device = Device(name="device")
|
|
assert isinstance(device, BECDevice)
|
|
|
|
|
|
def test_h5proxy(h5proxy_fixture, camera):
|
|
"""Test h5 camera proxy read from h5 file"""
|
|
h5proxy, camera = h5proxy_fixture
|
|
mock_proxy = mock.MagicMock()
|
|
camera.device_manager.devices.update({h5proxy.name: mock_proxy})
|
|
mock_proxy.enabled = True
|
|
mock_proxy.obj = h5proxy
|
|
fname = os.path.expanduser("tests/test_data/h5_test_file.h5")
|
|
h5entry = "entry/data/data"
|
|
with h5py.File(fname, "r") as f:
|
|
data = f[h5entry][...]
|
|
# pylint: disable=protected-access
|
|
h5proxy._update_device_config(
|
|
{camera.name: {"signal_name": "image", "file_source": fname, "h5_entry": h5entry}}
|
|
)
|
|
camera._registered_proxies.update({h5proxy.name: camera.image.name})
|
|
camera.sim.sim_params = {"noise": "none", "noise_multiplier": 0}
|
|
camera.scaninfo.sim_mode = True
|
|
camera.image_shape.set(data.shape[1:])
|
|
camera.stage()
|
|
img = camera.image.get()
|
|
assert (img == data[0, ...]).all()
|
|
camera.unstage()
|
|
|
|
|
|
def test_slitproxy(slitproxy_fixture):
|
|
"""Test slit proxy to compute readback from readback of positioner samx"""
|
|
proxy, camera, samx = slitproxy_fixture
|
|
for dev_name, dev in proxy.device_manager.devices.items():
|
|
camera.device_manager.devices.update({dev_name: mock.MagicMock()})
|
|
camera.device_manager.devices.get(dev_name).obj = dev
|
|
camera.device_manager.devices.get(dev_name).enabled = True
|
|
px_size = 0.5
|
|
slitwidth = 2
|
|
proxy._update_device_config(
|
|
{
|
|
camera.name: {
|
|
"signal_name": "image",
|
|
"center_offset": [0, 0],
|
|
"covariance": [[1000, 500], [200, 1000]],
|
|
"pixel_size": px_size,
|
|
"ref_motors": [samx.name],
|
|
"slit_width": [slitwidth],
|
|
"motor_dir": [0],
|
|
}
|
|
}
|
|
)
|
|
camera._registered_proxies.update({proxy.name: camera.image.name})
|
|
mock_proxy = mock.MagicMock()
|
|
mock_samx = mock.MagicMock()
|
|
mock_camera = mock.MagicMock()
|
|
camera.device_manager.devices.update(
|
|
{proxy.name: mock_proxy, samx.name: mock_samx, camera.name: mock_camera}
|
|
)
|
|
|
|
mock_proxy.enabled = True
|
|
mock_samx.enabled = True
|
|
mock_camera.enabled = True
|
|
mock_camera.obj = camera
|
|
mock_samx.obj = samx
|
|
mock_proxy.obj = proxy
|
|
camera.sim.sim_params = {"noise": "none", "noise_multiplier": 0, "hot_pixel_values": [0, 0, 0]}
|
|
samx.delay = 0
|
|
samx_pos = 0
|
|
samx.move(samx_pos)
|
|
proxy._gaussian_blur_sigma = 0
|
|
img = camera.image.get()
|
|
edges = (
|
|
int(img.shape[0] // 2 - samx_pos / px_size - slitwidth / (2 * px_size)),
|
|
int(img.shape[0] // 2 + samx_pos / px_size + slitwidth / (2 * px_size)),
|
|
)
|
|
assert (img[:, : edges[0]] == 0).all()
|
|
assert (img[:, edges[1] :] == 0).all()
|
|
samx_pos = 13.3
|
|
samx.move(samx_pos)
|
|
img = camera.image.get()
|
|
edges = (
|
|
int(img.shape[0] // 2 + samx_pos / px_size - slitwidth / (2 * px_size)),
|
|
int(img.shape[0] // 2 + samx_pos / px_size + slitwidth / (2 * px_size)),
|
|
)
|
|
assert (img[:, : edges[0]] == 0).all()
|
|
assert (img[:, edges[1] :] == 0).all()
|
|
|
|
|
|
def test_cam_stage_h5writer(camera):
|
|
"""Test the H5Writer class"""
|
|
with (
|
|
mock.patch.object(camera, "h5_writer") as mock_h5_writer,
|
|
mock.patch.object(
|
|
camera.custom_prepare, "publish_file_location"
|
|
) as mock_publish_file_location,
|
|
):
|
|
camera.scaninfo.num_points = 10
|
|
camera.scaninfo.frames_per_trigger = 1
|
|
camera.scaninfo.exp_time = 1
|
|
camera.stage()
|
|
assert mock_h5_writer.prepare.call_count == 0
|
|
camera.unstage()
|
|
camera.write_to_disk.put(True)
|
|
camera.stage()
|
|
calls = [mock.call(file_path="", h5_entry="/entry/data/data")]
|
|
assert mock_h5_writer.prepare.mock_calls == calls
|
|
# mock_h5_writer.prepare
|
|
|
|
|
|
def test_cam_complete(camera):
|
|
"""Test the complete method of SimCamera."""
|
|
with mock.patch.object(camera, "h5_writer") as mock_h5_writer:
|
|
camera.complete()
|
|
assert mock_h5_writer.write_data.call_count == 0
|
|
camera.write_to_disk.put(True)
|
|
camera.complete()
|
|
assert mock_h5_writer.write_data.call_count == 1
|
|
|
|
|
|
def test_cam_trigger(camera):
|
|
"""Test the trigger method of SimCamera."""
|
|
with mock.patch.object(camera, "h5_writer") as mock_h5_writer:
|
|
data = []
|
|
camera.trigger()
|
|
assert mock_h5_writer.receive_data.call_count == 0
|
|
camera.write_to_disk.put(True)
|
|
camera.trigger()
|
|
assert mock_h5_writer.receive_data.call_count == 1
|
|
camera.trigger()
|
|
assert mock_h5_writer.receive_data.call_count == 2
|
|
|
|
|
|
def test_h5writer():
|
|
"""Test the H5Writer class"""
|
|
|
|
h5_writer = H5Writer()
|
|
with mock.patch.object(h5_writer, "create_dir") as mock_create_dir:
|
|
h5_writer.data_container = [0, 1, 2]
|
|
h5_writer.prepare(file_path="test.h5", h5_entry="entry/data/data")
|
|
assert mock_create_dir.call_count == 1
|
|
assert h5_writer.data_container == []
|
|
assert h5_writer.file_path == "test.h5"
|
|
assert h5_writer.h5_entry == "entry/data/data"
|
|
|
|
data = [0, 1, 2, 3]
|
|
h5_writer.receive_data(data)
|
|
assert h5_writer.data_container == [data]
|
|
h5_writer.receive_data(0)
|
|
assert h5_writer.data_container == [data, 0]
|