ophyd.areadetector.plugins.OverlayPlugin

class ophyd.areadetector.plugins.OverlayPlugin(*args, **kwargs)

Plugin which adds graphics overlays to an NDArray image

Keyword arguments are passed to the base class, PluginBase

Parameters
prefixstr

The areaDetector plugin prefix

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

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

disable_on_stage()

when the plugin is staged, ensure that it is disabled.

enable_on_stage()

when the plugin is staged, ensure that it is enabled.

ensure_blocking()

Ensure that if plugin is enabled after staging, callbacks block.

ensure_nonblocking()

Ensure that if plugin is enabled after staging, callbacks don't block.

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()

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

array_counter

array_pixels

The total number of pixels, calculated from array_size

array_rate

array_size

An Device component that dynamically creates an ophyd Device

asyn_io

asyn_pipeline_config

A descriptor representing a device component (or signal)

attr_name

bayer_pattern

blocking_callbacks

color_mode

component_names

configuration_attrs

configuration_names

A descriptor representing a device component (or signal)

connected

If the device is connected.

data_type

depth

dim0_sa

dim1_sa

dim2_sa

dim_sa

An Device component that dynamically creates an ophyd Device

dimensions

dotted_name

Return the dotted name

dropped_arrays

enable

event_types

Events that can be subscribed to via obj.subscribe

height

hints

kind

lazy_wait_for_connection

max_size

An Device component that dynamically creates an ophyd Device

min_callback_time

name

name of the device

nd_array_address

nd_array_port

nd_attributes_file

ndimensions

overlay_1

overlay_2

overlay_3

overlay_4

overlay_5

overlay_6

overlay_7

overlay_8

parent

The parent of the ophyd object.

plugin_type

pool_alloc_buffers

pool_free_buffers

pool_max_buffers

pool_max_mem

pool_used_buffers

pool_used_mem

port_name

queue_free

queue_free_low

queue_size

queue_use

queue_use_high

queue_use_hihi

read_attrs

report

A report on the object.

root

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

signal_names

source_plugin

The PluginBase object that is the asyn source for this plugin.

subscriptions

time_stamp

trigger_signals

unique_id

width