ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing

class ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing(*args, images_per_set_name='images_per_set', number_of_sets_name='number_of_sets', cam_name='cam', proc_name='proc1', **kwargs)

Write out ‘squashed’ tiffs

Note

See FileStoreBase for the rest of the required parametrs

This mixin will also configure the cam and proc plugins on the parent.

This is useful to work around the dynamic range of detectors and minimizing disk spaced used by synthetically increasing the exposure time of the saved images.

Parameters
images_per_set_name, number_of_sets_namestr, optional

The names of the signals on the parent to get the images_pre_set and number_of_sets from.

The total number of frames extracted from the camera will be \(number\_of\_sets * images\_per\_set\) and result in number_of_sets tiff files each of which is the average of images_per_set frames from the detector.

Defaults to 'images_per_set' and 'number_of_sets'

cam_namestr, optional

The name of the CamBase instance on the parent.

Defaults to 'cam'

proc_namestr, optional

The name of the ProcessPlugin instance on the parent.

Defaults to 'proc1'

Notes

This class in cooperative and expected to particpate in multiple inheritance, all *args and extra **kwargs are passed up the MRO chain.

__init__(*args, images_per_set_name='images_per_set', number_of_sets_name='number_of_sets', cam_name='cam', proc_name='proc1', **kwargs)

Methods

__init__(*args[, images_per_set_name, …])

collect_asset_docs()

describe()

Provide schema and meta-data for read().

generate_datum(key, timestamp, datum_kwargs)

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

get_frames_per_point()

make_filename()

Make a filename.

pause()

Attempt to ‘pause’ the device.

read()

Read data from the device.

resume()

Resume a device from a ‘paused’ state.

stage()

Stage the device for data collection.

trigger()

Trigger the device and return status object.

unstage()

Unstage the device.

Attributes

fs_root

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

read_path_template

Returns write_path_template if read_path_template is not set

reg_root

The ‘root’ put into the Asset Registry

write_path_template