ophyd_async.epics.adaravis#

areaDetector support for Aravis GigE and USB3 vision cameras.

https://github.com/areaDetector/ADAravis

Module Contents#

Classes#

AravisDetector

Create an ADAravis AreaDetector instance.

AravisDriverIO

Generic Driver supporting all GiGE cameras.

AravisTriggerLogic

Trigger logic for Aravis GigE and USB3 cameras.

AravisTriggerSource

Which trigger source to use when TriggerMode=On.

API#

class ophyd_async.epics.adaravis.AravisDetector(prefix: str, path_provider: PathProvider | None = None, driver_suffix='cam1:', override_deadtime: float | None = None, writer_type: ADWriterType | None = ADWriterType.HDF, writer_suffix: str | None = None, plugins: dict[str, NDPluginBaseIO] | None = None, config_sigs: Sequence[SignalR] = (), name: str = '')[source]#

Bases: ophyd_async.epics.adcore.AreaDetector[ophyd_async.epics.adaravis.AravisDriverIO]

Create an ADAravis AreaDetector instance.

Parameters:

  • prefix – EPICS PV prefix for the detector

  • path_provider – Provider for file paths during acquisition

  • driver_suffix – Suffix for the driver PV, defaults to “cam1:”

  • override_deadtime – If provided, this value is used for deadtime instead of looking up based on camera model.

  • writer_type – Type of file writer (HDF or TIFF)

  • writer_suffix – Suffix for the writer PV

  • plugins – Additional areaDetector plugins to include

  • config_sigs – Additional signals to include in configuration

  • name – Name for the detector device

class ophyd_async.epics.adaravis.AravisDriverIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore.ADBaseIO

Generic Driver supporting all GiGE cameras.

This mirrors the interface provided by ADAravis/db/aravisCamera.template.

trigger_mode: Annotated[SignalRW[OnOff], ophyd_async.epics.core.PvSuffix.rbv('TriggerMode')]#

None

trigger_source: Annotated[SignalRW[AravisTriggerSource], ophyd_async.epics.core.PvSuffix.rbv('TriggerSource')]#

None

class ophyd_async.epics.adaravis.AravisTriggerLogic(driver: AravisDriverIO, override_deadtime: float | None = None)[source]#

Bases: ophyd_async.core.DetectorTriggerLogic

Trigger logic for Aravis GigE and USB3 cameras.

config_sigs() → set[SignalR][source]#

Return the signals that should appear in read_configuration.

get_deadtime(config_values: SignalDict) → float[source]#

Return the deadtime in seconds for the detector.

Parameters:

config_values – the value of each signal in config_sigs

async prepare_internal(num: int, livetime: float, deadtime: float)[source]#

Prepare the detector to take internally triggered exposures.

Parameters:

  • num – the number of exposures to take

  • livetime – how long the exposure should be, 0 means what is currently set

  • deadtime – how long between exposures, 0 means the shortest possible

async prepare_edge(num: int, livetime: float)[source]#

Prepare the detector to take external edge triggered exposures.

Parameters:

  • num – the number of exposures to take

  • livetime – how long the exposure should be, 0 means what is currently set

class ophyd_async.epics.adaravis.AravisTriggerSource[source]#

Bases: ophyd_async.core.SubsetEnum

Which trigger source to use when TriggerMode=On.

LINE1#

‘Line1’