ophyd.areadetector.base.ADBase

class ophyd.areadetector.base.ADBase(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

The AreaDetector base class

This serves as the base for all detectors and plugins

__init__(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

Methods

__init__([prefix, kind, read_attrs, ...])

add_instantiation_callback(callback[, ...])

Register a callback which will receive each OphydObject instance.

check_value(value, **kwargs)

Check if the value is valid for this object

clear_sub(cb[, event_type])

Remove a subscription, given the original callback function

configure(d)

Configure the device for something during a run

describe()

Provide schema and meta-data for read().

describe_configuration()

Provide schema & meta-data for read_configuration()

destroy()

Disconnect and destroy all signals on the Device

find_signal(text[, use_re, case_sensitive, ...])

Search through the signal docs on this detector for the string text

get(**kwargs)

Get the value of all components in the device

get_asyn_digraph()

Get the directed graph of the ASYN ports

get_asyn_port_dictionary()

Return port name : component map

get_device_tuple()

The device tuple type associated with an Device class

get_instantiated_signals(*[, attr_prefix])

Yields all of the instantiated signals in a device hierarchy

get_plugin_by_asyn_port(port_name)

Get the plugin which has the given asyn port name

missing_plugins()

Find missing ports

pause()

Attempt to 'pause' the device.

put(dev_t, **kwargs)

Put a value to all components of the device

read()

Read data from the device.

read_configuration()

Dictionary mapping names to value dicts with keys: value, timestamp

resume()

Resume a device from a 'paused' state.

stage(*args, **kwargs)

Stage the device for data collection.

stop(*[, success])

Stop the Device and all (instantiated) subdevices

subscribe(callback[, event_type, run])

Subscribe to events this event_type generates.

summary()

trigger()

Trigger the device and return status object.

unstage()

Unstage the device.

unsubscribe(cid)

Remove a subscription

unsubscribe_all()

validate_asyn_ports()

Validate that all components of pipeline are known

visualize_asyn_digraph([ax])

This generates a figure showing the current asyn port layout.

wait_for_connection([all_signals, timeout])

Wait for signals to connect

walk_components()

Walk all components in the Device hierarchy

walk_signals(*[, include_lazy])

Walk all signals in the Device hierarchy

walk_subdevice_classes()

Walk all sub-Devices classes in the Device hierarchy

walk_subdevices(*[, include_lazy])

Walk all sub-Devices in the hierarchy

Attributes

SUB_ACQ_DONE

ad_root

attr_name

component_names

configuration_attrs

configuration_names

A descriptor representing a device component (or signal)

connected

If the device is connected.

dotted_name

Return the dotted name

event_types

Events that can be subscribed to via obj.subscribe

hints

kind

lazy_wait_for_connection

name

name of the device

parent

The parent of the ophyd object.

read_attrs

report

A report on the object.

root

Walk parents to find ultimate ancestor (parent's parent...).

signal_names

subscriptions

trigger_signals