pcdsdevices.areadetector.plugins.HDF5FileStore

class pcdsdevices.areadetector.plugins.HDF5FileStore(*args, **kwargs)

HDF5 Plugin to use for interactive/in-scan saving at LCLS.

Includes some mangling of the filename selection to keep the names human-readable because we don’t actually use filestore/databroker at LCLS.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
auto_increment (ADComponent)	EpicsSignalWithRBV	AutoIncrement		config	Inherited from HDF5Plugin_V31
auto_save (ADComponent)	EpicsSignalWithRBV	AutoSave		config	Inherited from HDF5Plugin_V31
capture (ADComponent)	EpicsSignalWithRBV	Capture		normal	Inherited from HDF5Plugin_V31
delete_driver_file (ADComponent)	EpicsSignalWithRBV	DeleteDriverFile		config	Inherited from HDF5Plugin_V31
file_format (ADComponent)	EpicsSignalWithRBV	FileFormat		config	Inherited from HDF5Plugin_V31
file_name (ADComponent)	EpicsSignalWithRBV	FileName		config	Inherited from HDF5Plugin_V31
file_number (ADComponent)	EpicsSignalWithRBV	FileNumber	[FileNumber r/w longout] File number	normal	Inherited from HDF5Plugin_V31
file_path (ADComponent)	EpicsPathSignal	FilePath		config	Inherited from HDF5Plugin_V31
file_path_exists (ADComponent)	EpicsSignalRO	FilePathExists_RBV		config	Inherited from HDF5Plugin_V31
file_template (ADComponent)	EpicsSignalWithRBV	FileTemplate		config	Inherited from HDF5Plugin_V31
file_write_mode (ADComponent)	EpicsSignalWithRBV	FileWriteMode		config	Inherited from HDF5Plugin_V31
full_file_name (ADComponent)	EpicsSignalRO	FullFileName_RBV		config	Inherited from HDF5Plugin_V31
num_capture (ADComponent)	EpicsSignalWithRBV	NumCapture		config	Inherited from HDF5Plugin_V31
num_captured (ADComponent)	EpicsSignalRO	NumCaptured_RBV		normal	Inherited from HDF5Plugin_V31
read_file (ADComponent)	EpicsSignalWithRBV	ReadFile		normal	Inherited from HDF5Plugin_V31
write_file (ADComponent)	EpicsSignalWithRBV	WriteFile		normal	Inherited from HDF5Plugin_V31
write_message (ADComponent)	EpicsSignal	WriteMessage		normal	Inherited from HDF5Plugin_V31
write_status (ADComponent)	EpicsSignal	WriteStatus		normal	Inherited from HDF5Plugin_V31
configuration_names	ArrayAttributeSignal			config	Inherited from HDF5Plugin_V31
array_counter (ADComponent)	EpicsSignalWithRBV	ArrayCounter	[ArrayCounter r/w longout] Counter that increments by 1 each time an NDArray callback is processed	normal	Inherited from HDF5Plugin_V31
array_rate (ADComponent)	EpicsSignalRO	ArrayRate_RBV	[ArrayRate_RBV r/o calc] Rate (Hz) at which ArrayCounter is incrementing. Computed in database.	normal	Inherited from HDF5Plugin_V31
asyn_io (ADComponent)	EpicsSignal	AsynIO	[AsynIO N/A asyn] asyn record to control debugging (asynTrace)	normal	Inherited from HDF5Plugin_V31
nd_attributes_file (ADComponent)	EpicsSignal	NDAttributesFile	[NDAttributesFile r/w waveform] The name of an XML file defining the PVAttributes and paramAttributes to be added to each NDArray by this plugin. The format of the XML file is described in the documentation for asynNDArrayDriver::readNDAttributesFile().	normal	Inherited from HDF5Plugin_V31
pool_alloc_buffers (ADComponent)	EpicsSignalRO	PoolAllocBuffers	[PoolAllocBuffers r/o longin] The number of NDArrays this plugin has currently allocated.	normal	Inherited from HDF5Plugin_V31
pool_free_buffers (ADComponent)	EpicsSignalRO	PoolFreeBuffers	[PoolFreeBuffers r/o longin] The number of free NDArrays this plugin has in its NDArrayPool.	normal	Inherited from HDF5Plugin_V31
pool_max_buffers (ADComponent)	EpicsSignalRO	PoolMaxBuffers	[PoolMaxBuffers r/o longin] The maximum number of NDArrays this plugin is allowed to allocate.	normal	Inherited from HDF5Plugin_V31
pool_max_mem (ADComponent)	EpicsSignalRO	PoolMaxMem	[PoolMaxMem r/o ai] The maximum amount of NDArrayPool memory this plugin is allowed to allocate.	normal	Inherited from HDF5Plugin_V31
pool_used_buffers (ADComponent)	EpicsSignalRO	PoolUsedBuffers	[PoolUsedBuffers N/A calc] The number of used NDArrays this plugin has in its NDArrayPool. Calculated from PoolAllocBuffers and PoolFreeBuffers.	normal	Inherited from HDF5Plugin_V31
pool_used_mem (ADComponent)	EpicsSignalRO	PoolUsedMem	[PoolUsedMem r/o ai] The actual amount of NDArrayPool memory this plugin is currently using.	normal	Inherited from HDF5Plugin_V31
port_name (ADComponent)	EpicsSignalRO	PortName_RBV	[PortName_RBV r/o stringin] asyn port name	config	Inherited from HDF5Plugin_V31
asyn_pipeline_config	ArrayAttributeSignal			config	Inherited from HDF5Plugin_V31
width (ADComponent)	EpicsSignalRO	ArraySize0_RBV	[ArraySize0_RBV r/o longin] First dimension of NDArray callback data	normal	Inherited from HDF5Plugin_V31
height (ADComponent)	EpicsSignalRO	ArraySize1_RBV	[ArraySize1_RBV r/o longin] Second dimension of NDArray callback data	normal	Inherited from HDF5Plugin_V31
depth (ADComponent)	EpicsSignalRO	ArraySize2_RBV	[ArraySize2_RBV r/o longin] Third dimension of NDArray callback data	normal	Inherited from HDF5Plugin_V31
array_size (DDC)	ArraySize	(See below)		normal	Inherited from HDF5Plugin_V31
bayer_pattern (ADComponent)	EpicsSignalRO	BayerPattern_RBV	[BayerPattern_RBV r/o mbbi] BayerPattern of last NDArray callback data (NDBayerPattern_t).	normal	Inherited from HDF5Plugin_V31
blocking_callbacks (ADComponent)	EpicsSignalWithRBV	BlockingCallbacks	[BlockingCallbacks r/w bo] 0 = callbacks from the driver do not block; the NDArray data is put on a queue and the callback processes in its own thread. 1 = callbacks from the driver block; the callback processes in the driver callback thread.	config	Inherited from HDF5Plugin_V31
color_mode (ADComponent)	EpicsSignalWithRBV	ColorMode	0=Mono 1=Bayer 2=RGB1 3=RGB2 4=RGB3 5=YUV444 6=YUV422 7=YUV421	normal	Inherited from HDF5Plugin_V31
data_type (ADComponent)	EpicsSignalWithRBV	DataType	0=Int8 1=UInt8 2=Int16 3=UInt16 4=Int32 5=UInt32 6=Float32 7=Float64	normal	Inherited from HDF5Plugin_V31
dim0_sa (ADComponent)	EpicsSignal	Dim0SA		normal	Inherited from HDF5Plugin_V31
dim1_sa (ADComponent)	EpicsSignal	Dim1SA		normal	Inherited from HDF5Plugin_V31
dim2_sa (ADComponent)	EpicsSignal	Dim2SA		normal	Inherited from HDF5Plugin_V31
dim_sa (DDC)	DimSa	(See below)		normal	Inherited from HDF5Plugin_V31
dimensions (ADComponent)	EpicsSignalWithRBV	Dimensions		normal	Inherited from HDF5Plugin_V31
dropped_arrays (ADComponent)	EpicsSignalWithRBV	DroppedArrays	[DroppedArrays r/w longout] Counter that increments by 1 each time an NDArray callback occurs when NDPluginDriverBlockingCallbacks=0 and the plugin driver queue is full, so the callback cannot be processed.	normal	Inherited from HDF5Plugin_V31
enable (ADComponent)	EpicsSignalWithRBV	EnableCallbacks	[EnableCallbacks r/w bo] Enable (1) or disable (0) callbacks from the driver to this plugin. If callbacks are disabled then the plugin will normally be idle and consume no CPU resources.	config	Inherited from HDF5Plugin_V31
min_callback_time (ADComponent)	EpicsSignalWithRBV	MinCallbackTime	[MinCallbackTime r/w ao] The minimum time in seconds between calls to processCallbacks. Any callbacks occuring before this minimum time has elapsed will be ignored. 0 means no minimum time, i.e. process all callbacks.	normal	Inherited from HDF5Plugin_V31
nd_array_address (ADComponent)	EpicsSignalWithRBV	NDArrayAddress	[NDArrayAddress r/w longout] asyn port address for NDArray driver that will make callbacks to this plugin. This address can be changed at run time, connecting the plugin to a different address in the NDArray driver.	normal	Inherited from HDF5Plugin_V31
nd_array_port (ADComponent)	EpicsSignalWithRBV	NDArrayPort	[NDArrayPort r/w stringout] asyn port name for NDArray driver that will make callbacks to this plugin. This port can be changed at run time, connecting the plugin to a different NDArray driver.	config	Inherited from HDF5Plugin_V31
ndimensions (ADComponent)	EpicsSignalWithRBV	NDimensions		normal	Inherited from HDF5Plugin_V31
plugin_type (ADComponent)	EpicsSignalRO	PluginType_RBV	[PluginType_RBV r/o stringin] A string describing the plugin type.	config	Inherited from HDF5Plugin_V31
queue_free (ADComponent)	EpicsSignal	QueueFree	[QueueFree r/o longin] The number of free queue elements.	normal	Inherited from HDF5Plugin_V31
queue_free_low (ADComponent)	EpicsSignal	QueueFreeLow		normal	Inherited from HDF5Plugin_V31
queue_size (ADComponent)	EpicsSignalWithRBV	QueueSize	[QueueSize r/o longin] The total queue size for callbacks when BlockingCallbacks=0.	normal	Inherited from HDF5Plugin_V31
queue_use (ADComponent)	EpicsSignal	QueueUse	[QueueUse r/o calc] The number of used queue elements.	normal	Inherited from HDF5Plugin_V31
queue_use_high (ADComponent)	EpicsSignal	QueueUseHIGH		normal	Inherited from HDF5Plugin_V31
queue_use_hihi (ADComponent)	EpicsSignal	QueueUseHIHI		normal	Inherited from HDF5Plugin_V31
time_stamp (ADComponent)	EpicsSignalRO	TimeStamp_RBV	[TimeStamp_RBV r/o ai] Time stamp number of last NDArray callback data	normal	Inherited from HDF5Plugin_V31
unique_id (ADComponent)	EpicsSignalRO	UniqueId_RBV	[UniqueId_RBV r/o longin] Unique ID number of last NDArray callback data	normal	Inherited from HDF5Plugin_V31
boundary_align (ADComponent)	EpicsSignalWithRBV	BoundaryAlign	[BoundaryAlign r/w longout] Set the disk boundary alignment in bytes. This parameter can be used to optimise file I/O performance on some file systems. For instance on the Lustre file system where the it is optimal to align data to the ‘stripe size’ (default 1MB). This parameter applies to all datasets in the file. Setting this parameter to 0 disables use of disk boundary alignment. Warning: setting this parameter to a larger size than the size of a single chunk will cause datafiles to grow larger than the actual contained data.	config	Inherited from HDF5Plugin_V31
boundary_threshold (ADComponent)	EpicsSignalWithRBV	BoundaryThreshold	[BoundaryThreshold r/w longout] Set a minimum size (bytes) of chunk or dataset where boundary alignment is to be applied. This can be used to filter out small datasets like NDAttributes from the boundary alignment as it could blow up the file size. Setting this parameter to 0 will disable the use of boundary alignment	config	Inherited from HDF5Plugin_V31
compression (ADComponent)	EpicsSignalWithRBV	Compression	[Compression r/w mbbo] Select or switch off compression filter	config	Inherited from HDF5Plugin_V31
data_bits_offset (ADComponent)	EpicsSignalWithRBV	DataBitsOffset	[DataBitsOffset r/w longout] N-bit compression filter: dataword bit-offset in pixel	config	Inherited from HDF5Plugin_V31
extra_dim_name (DDC)	ExtraDimName	(See below)		normal	Inherited from HDF5Plugin_V31
extra_dim_size (DDC)	ExtraDimSize	(See below)		normal	Inherited from HDF5Plugin_V31
io_speed (ADComponent)	EpicsSignal	IOSpeed	[IOSpeed r/o ai] Overall IO write speed in megabit per second from first frame to file closed	config	Inherited from HDF5Plugin_V31
num_col_chunks (ADComponent)	EpicsSignalWithRBV	NumColChunks	[NumColChunks r/w longout] Configure HDF5 “chunking” to approriate size for the filesystem: sets number of columns to use per chunk	config	Inherited from HDF5Plugin_V31
num_data_bits (ADComponent)	EpicsSignalWithRBV	NumDataBits	[NumDataBits r/w longout] N-bit compression filter: number of data bits per pixel	config	Inherited from HDF5Plugin_V31
num_extra_dims (ADComponent)	EpicsSignalWithRBV	NumExtraDims	[NumExtraDims r/w mbbo] Number of extra dimensions [0..2]	config	Inherited from HDF5Plugin_V31
num_frames_chunks (ADComponent)	EpicsSignalWithRBV	NumFramesChunks	[NumFramesChunks r/w longout] Configure HDF5 “chunking” to approriate size for the filesystem: sets number of frames to use per chunk. For a 2D image, setting this parameter > 1 essentially implies using in-memory cache as HDF5 only writes full chunks to disk.	config	Inherited from HDF5Plugin_V31
num_frames_flush (ADComponent)	EpicsSignalWithRBV	NumFramesFlush	[NumFramesFlush r/w longout] Flush the file metadata to disk every N’th frame. Image data is written to disk on every write operation, but HDF5 internal metadata to describe the data layout and indices is normally only written at close time.	config	Inherited from HDF5Plugin_V31
num_row_chunks (ADComponent)	EpicsSignalWithRBV	NumRowChunks	[NumRowChunks r/w longout] Configure HDF5 “chunking” to approriate size for the filesystem: sets number of rows to use per chunk	config	Inherited from HDF5Plugin_V31
run_time (ADComponent)	EpicsSignal	RunTime		config	Inherited from HDF5Plugin_V31
szip_num_pixels (ADComponent)	EpicsSignalWithRBV	SZipNumPixels	[SZipNumPixels r/w longout] szip compression filter: number of pixels in filter [1..32]	config	Inherited from HDF5Plugin_V31
store_attr (ADComponent)	EpicsSignalWithRBV	StoreAttr	0=’No’ 1=’Yes’	config	Inherited from HDF5Plugin_V31
store_perform (ADComponent)	EpicsSignalWithRBV	StorePerform	0=’No’ 1=’Yes’	config	Inherited from HDF5Plugin_V31
zlevel (ADComponent)	EpicsSignalWithRBV	ZLevel	[ZLevel r/w longout] zlib compression filter: compression level [1..9]	config	Inherited from HDF5Plugin_V31
epics_ts_sec (ADComponent)	EpicsSignalRO	EpicsTSSec_RBV		normal	Inherited from HDF5Plugin_V31
epics_ts_nsec (ADComponent)	EpicsSignalRO	EpicsTSNsec_RBV		normal	Inherited from HDF5Plugin_V31
lazy_open (ADComponent)	EpicsSignalWithRBV	LazyOpen	0=’No’ 1=’Yes’	normal	Inherited from HDF5Plugin_V31
xml_error_msg (ADComponent)	EpicsSignalRO	XMLErrorMsg_RBV	[XMLErrorMsg_RBV r/o waveform] XML parser error message	normal	Inherited from HDF5Plugin_V31
xml_file_name (ADComponent)	EpicsSignalWithRBV	XMLFileName	[XMLFileName r/w waveform] XML filename, pointing to an XML HDF5 Layout Definition This waveform also supports loading raw XML code directly; up to a maximum of 1MB long (NELM=1MB)	config	Inherited from HDF5Plugin_V31
xml_valid (ADComponent)	EpicsSignalRO	XMLValid_RBV	0=’No’ 1=’Yes’	normal	Inherited from HDF5Plugin_V31
ad_core_version (ADComponent)	EpicsSignalRO	ADCoreVersion_RBV		normal	Inherited from HDF5Plugin_V31
array_callbacks (ADComponent)	EpicsSignalWithRBV	ArrayCallbacks	0=’Disable’ 1=’Enable’	normal	Inherited from HDF5Plugin_V31
array_size_int (ADComponent)	EpicsSignalRO	ArraySize_RBV	[ArraySize_RBV r/o longin] Total size of the array data in bytes	normal	Inherited from HDF5Plugin_V31
array_size_xyz (DDC)	ArraySizeXyz	(See below)		normal	Inherited from HDF5Plugin_V31
create_directory (ADComponent)	EpicsSignalWithRBV	CreateDirectory		config	Inherited from HDF5Plugin_V31
temp_suffix (ADComponent)	EpicsSignalWithRBV	TempSuffix		normal	Inherited from HDF5Plugin_V31
nd_attribute_chunk (ADComponent)	EpicsSignalWithRBV	NDAttributeChunk		normal	Inherited from HDF5Plugin_V31
dim_att_datasets (ADComponent)	EpicsSignalWithRBV	DimAttDatasets	0=’No’ 1=’Yes’	normal	Inherited from HDF5Plugin_V31
fill_value (ADComponent)	EpicsSignalWithRBV	FillValue		normal	Inherited from HDF5Plugin_V31
position_mode (ADComponent)	EpicsSignalWithRBV	PositionMode	0=’Off’ 1=’On’	normal	Inherited from HDF5Plugin_V31
swmr_active (ADComponent)	EpicsSignalRO	SWMRActive_RBV	0=’Off’ 1=’Active’	normal	Inherited from HDF5Plugin_V31
swmr_cb_counter (ADComponent)	EpicsSignalRO	SWMRCbCounter_RBV		normal	Inherited from HDF5Plugin_V31
swmr_mode (ADComponent)	EpicsSignalWithRBV	SWMRMode	0=’Off’ 1=’On’	normal	Inherited from HDF5Plugin_V31
swmr_supported (ADComponent)	EpicsSignalRO	SWMRSupported_RBV	0=’Not Supported’ 1=’Supported’	normal	Inherited from HDF5Plugin_V31
extra_dim_chunk (DDC)	ExtraDimChunk	(See below)		normal	Inherited from HDF5Plugin_V31
pos_index_dim (DDC)	PosIndexDim	(See below)		normal	Inherited from HDF5Plugin_V31
pos_name_dim (DDC)	PosNameDim	(See below)		normal	Inherited from HDF5Plugin_V31
driver_version (ADComponent)	EpicsSignalRO	DriverVersion_RBV		normal	Inherited from HDF5Plugin_V31
execution_time (ADComponent)	EpicsSignalRO	ExecutionTime_RBV		normal	Inherited from HDF5Plugin_V31
array_size_all (DDC)	ArraySizeAll	(See below)		normal	Inherited from HDF5Plugin_V31
disordered_arrays (ADComponent)	EpicsSignalWithRBV	DisorderedArrays		normal	Inherited from HDF5Plugin_V31
dropped_output_arrays (ADComponent)	EpicsSignalWithRBV	DroppedOutputArrays		normal	Inherited from HDF5Plugin_V31
max_threads (ADComponent)	EpicsSignalRO	MaxThreads_RBV		normal	Inherited from HDF5Plugin_V31
nd_attributes_macros (ADComponent)	EpicsSignal	NDAttributesMacros		normal	Inherited from HDF5Plugin_V31
nd_attributes_status (ADComponent)	EpicsSignal	NDAttributesStatus	0=’Attributes file OK’ 1=’File not found’ 2=’XML syntax error’ 3=’Macro substitution error’	normal	Inherited from HDF5Plugin_V31
num_threads (ADComponent)	EpicsSignalWithRBV	NumThreads		normal	Inherited from HDF5Plugin_V31
process_plugin (ADComponent)	EpicsSignal	ProcessPlugin		normal	Inherited from HDF5Plugin_V31
sort_free (ADComponent)	EpicsSignal	SortFree		normal	Inherited from HDF5Plugin_V31
sort_free_low (ADComponent)	EpicsSignal	SortFreeLow		normal	Inherited from HDF5Plugin_V31
sort_mode (ADComponent)	EpicsSignalWithRBV	SortMode	0=Unsorted 1=Sorted	normal	Inherited from HDF5Plugin_V31
sort_size (ADComponent)	EpicsSignalWithRBV	SortSize		normal	Inherited from HDF5Plugin_V31
sort_time (ADComponent)	EpicsSignalWithRBV	SortTime		normal	Inherited from HDF5Plugin_V31

HDF5FileStore.array_size (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
depth	EpicsSignalRO	ArraySize2_RBV		config	Inherited from HDF5Plugin_V31
height	EpicsSignalRO	ArraySize1_RBV		config	Inherited from HDF5Plugin_V31
width	EpicsSignalRO	ArraySize0_RBV		config	Inherited from HDF5Plugin_V31

HDF5FileStore.dim_sa (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
dim0_sa	EpicsSignalWithRBV	Dim0SA		config	Inherited from HDF5Plugin_V31
dim1_sa	EpicsSignalWithRBV	Dim1SA		config	Inherited from HDF5Plugin_V31
dim2_sa	EpicsSignalWithRBV	Dim2SA		config	Inherited from HDF5Plugin_V31
dim3_sa	EpicsSignalWithRBV	Dim3SA		config
dim4_sa	EpicsSignalWithRBV	Dim4SA		config
dim5_sa	EpicsSignalWithRBV	Dim5SA		config
dim6_sa	EpicsSignalWithRBV	Dim6SA		config
dim7_sa	EpicsSignalWithRBV	Dim7SA		config
dim8_sa	EpicsSignalWithRBV	Dim8SA		config
dim9_sa	EpicsSignalWithRBV	Dim9SA		config

HDF5FileStore.extra_dim_name (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
name_3	EpicsSignalRO	ExtraDimName3_RBV		config
name_4	EpicsSignalRO	ExtraDimName4_RBV		config
name_5	EpicsSignalRO	ExtraDimName5_RBV		config
name_6	EpicsSignalRO	ExtraDimName6_RBV		config
name_7	EpicsSignalRO	ExtraDimName7_RBV		config
name_8	EpicsSignalRO	ExtraDimName8_RBV		config
name_9	EpicsSignalRO	ExtraDimName9_RBV		config
name_x	EpicsSignalRO	ExtraDimNameX_RBV		config
name_y	EpicsSignalRO	ExtraDimNameY_RBV		config
name_n	EpicsSignalRO	ExtraDimNameN_RBV		config

HDF5FileStore.extra_dim_size (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
size_3	EpicsSignalWithRBV	ExtraDimSize3		config
size_4	EpicsSignalWithRBV	ExtraDimSize4		config
size_5	EpicsSignalWithRBV	ExtraDimSize5		config
size_6	EpicsSignalWithRBV	ExtraDimSize6		config
size_7	EpicsSignalWithRBV	ExtraDimSize7		config
size_8	EpicsSignalWithRBV	ExtraDimSize8		config
size_9	EpicsSignalWithRBV	ExtraDimSize9		config
size_x	EpicsSignalWithRBV	ExtraDimSizeX		config
size_y	EpicsSignalWithRBV	ExtraDimSizeY		config
size_n	EpicsSignalWithRBV	ExtraDimSizeN		config

HDF5FileStore.array_size_xyz (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
array_size_x	EpicsSignalRO	ArraySizeX_RBV		config
array_size_y	EpicsSignalRO	ArraySizeY_RBV		config
array_size_z	EpicsSignalRO	ArraySizeZ_RBV		config

HDF5FileStore.extra_dim_chunk (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
chunk_3	EpicsSignalWithRBV	ExtraDimChunk3		config
chunk_4	EpicsSignalWithRBV	ExtraDimChunk4		config
chunk_5	EpicsSignalWithRBV	ExtraDimChunk5		config
chunk_6	EpicsSignalWithRBV	ExtraDimChunk6		config
chunk_7	EpicsSignalWithRBV	ExtraDimChunk7		config
chunk_8	EpicsSignalWithRBV	ExtraDimChunk8		config
chunk_9	EpicsSignalWithRBV	ExtraDimChunk9		config
chunk_x	EpicsSignalWithRBV	ExtraDimChunkX		config
chunk_y	EpicsSignalWithRBV	ExtraDimChunkY		config

HDF5FileStore.pos_index_dim (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
dim_3	EpicsSignalWithRBV	PosIndexDim3		config
dim_4	EpicsSignalWithRBV	PosIndexDim4		config
dim_5	EpicsSignalWithRBV	PosIndexDim5		config
dim_6	EpicsSignalWithRBV	PosIndexDim6		config
dim_7	EpicsSignalWithRBV	PosIndexDim7		config
dim_8	EpicsSignalWithRBV	PosIndexDim8		config
dim_9	EpicsSignalWithRBV	PosIndexDim9		config
dim_x	EpicsSignalWithRBV	PosIndexDimX		config
dim_y	EpicsSignalWithRBV	PosIndexDimY		config
dim_n	EpicsSignalWithRBV	PosIndexDimN		config

HDF5FileStore.pos_name_dim (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
dim_3	EpicsSignalWithRBV	PosNameDim3		config
dim_4	EpicsSignalWithRBV	PosNameDim4		config
dim_5	EpicsSignalWithRBV	PosNameDim5		config
dim_6	EpicsSignalWithRBV	PosNameDim6		config
dim_7	EpicsSignalWithRBV	PosNameDim7		config
dim_8	EpicsSignalWithRBV	PosNameDim8		config
dim_9	EpicsSignalWithRBV	PosNameDim9		config
dim_x	EpicsSignalWithRBV	PosNameDimX		config
dim_y	EpicsSignalWithRBV	PosNameDimY		config
dim_n	EpicsSignalWithRBV	PosNameDimN		config

HDF5FileStore.array_size_all (DDC) Dynamic Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
array_size0	EpicsSignalWithRBV	ArraySize0		config
array_size1	EpicsSignalWithRBV	ArraySize1		config
array_size2	EpicsSignalWithRBV	ArraySize2		config
array_size3	EpicsSignalWithRBV	ArraySize3		config
array_size4	EpicsSignalWithRBV	ArraySize4		config
array_size5	EpicsSignalWithRBV	ArraySize5		config
array_size6	EpicsSignalWithRBV	ArraySize6		config
array_size7	EpicsSignalWithRBV	ArraySize7		config
array_size8	EpicsSignalWithRBV	ArraySize8		config
array_size9	EpicsSignalWithRBV	ArraySize9		config

Methods

collect_asset_docs()

configure(d: Dict[str, Any]) → Tuple[Dict[str, Any], Dict[str, Any]]

Configure the device for something during a run

This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

Parameters:

d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

Returns:

• (old, new) tuple of dictionaries

• Where old and new are pre- and post-configure configuration states.

describe()

Provide schema and meta-data for read().

This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

This provides schema related information, (ex shape, dtype), the source (ex PV name), and if available, units, limits, precision etc.

Returns:

data_keys (OrderedDict) – The keys must be strings and the values must be dict-like with the event_model.event_descriptor.data_key schema.

disable_on_stage()

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

a convenience method for adding `('enable', 0) to stage_sigs

enable_on_stage()

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

a convenience method for adding (‘enable’, 1) to stage_sigs

ensure_blocking()

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

a convenience method for adding `('blocking_callbacks', 1) to stage_sigs

ensure_nonblocking()

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

a convenience method for adding `('blocking_callbacks', 0) to stage_sigs

find_signal(text, use_re=False, case_sensitive=False, match_fcn=None, f=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)

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

Parameters:

• text (str) – Text to find

• use_re (bool, optional) – Use regular expressions

• case_sensitive (bool, optional) – Case sensitive search

• match_fcn (callable, optional) – Function to call when matches are found Defaults to a function that prints matches to f

• f (file-like, optional) – File-like object that the default match function prints to (Defaults to sys.stdout)

generate_datum(key, timestamp, datum_kwargs)

Generate a uid and cache it with its key for later insertion.

get(**kwargs)

Get the value of all components in the device

Keyword arguments are passed onto each signal.get(). Components beginning with an underscore will not be included.

get_asyn_digraph()

Get the directed graph of the ASYN ports

Returns:

• G (networkx.DiGraph) – Directed graph of pipelines

• port_map (dict) – Mapping between port_name and ADBase objects

get_asyn_port_dictionary()

Return port name : component map

Returns:

port_map (dict) – Mapping between port_name and ADBase objects

get_frames_per_point()

get_plugin_by_asyn_port(port_name)

Get the plugin which has the given asyn port name

Parameters:

port_name (str) – The port name to search for

Returns:

ret (ADBase or None) – Either the requested plugin or None if not found

make_filename() → str

Select a filename that makes SLAC scientists happy

missing_plugins()

Find missing ports

read()

Read data from the device.

This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in trigger().

The OrderedDict returned by this method must have identical keys (in the same order) as the OrderedDict returned by describe().

By convention, the first key in the return is the ‘primary’ key and maybe used by heuristics in bluesky.

The values in the ordered dictionary must be dict (-likes) with the keys {'value', 'timestamp'}. The 'value' may have any type, the timestamp must be a float UNIX epoch timestamp in UTC.

Returns:

data (OrderedDict) – The keys must be strings and the values must be dict-like with the keys {'value', 'timestamp'}

read_configuration()

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

To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

stop(*, success=False)

Stop the Device and all (instantiated) subdevices

summary()

trigger() → StatusBase

Trigger the device and return status object.

This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

If there is an appreciable time between triggering the device and it being able to be read (via the read() method) then this method is also responsible for arranging that the StatusBase object returned by this method is notified when the device is ready to be read.

If there is no delay between triggering and being readable, then this method must return a StatusBase object which is already completed.

Returns:

status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

validate_asyn_ports()

Validate that all components of pipeline are known

Raises:

RuntimeError – If there any input ports to known plugins where the source is not known to ophyd

visualize_asyn_digraph(ax=None, *args, **kwargs)

This generates a figure showing the current asyn port layout.

This method generates a plot showing all of the currently enabled Areadetector plugin asyn ports and their relationships. The current ports and relationships are found using self.get_asyn_digraph.

Parameters:

• ax (matplotlib axes) – if None (default) then a new figure is created otherwise it is plotted on the specified axes.

• *args (networkx.draw_networkx args and kwargs.) – For the allowed args and kwargs see the networkx.draw_networkx documentation

• **kwargs (networkx.draw_networkx args and kwargs.) –

  For the allowed args and kwargs see the networkx.draw_networkx documentation

warmup()

A convenience method for ‘priming’ the plugin.

The plugin has to ‘see’ one acquisition before it is ready to capture. This sets the array size, etc.

Attributes

ad_root

array_pixels

The total number of pixels, calculated from array_size

configuration_attrs

connected

file_number_sync = None

file_number_write = None

fs_root

The ‘root’ put into the Asset registry, use reg_root

Type:

DEPRECATED

hints

kind

read_path_template

Returns write_path_template if read_path_template is not set

reg_root

The ‘root’ put into the Asset Registry

source_plugin

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

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

write_path_template