Plans#

Customize your measurement procedures.

For complete API details see the Full API Reference.

Plans and Support by Activity#

Batch Scanning#

`execute_command_list()`	execute the command list as a plan
`get_command_list()`	return command list from either text or Excel file
`parse_Excel_command_file()`	parse an Excel spreadsheet with commands, return as command list
`parse_text_command_file()`	parse a text file with commands, return as command list
`register_command_handler()`	define the function called to execute the command list
`run_command_file()`	execute a list of commands from a text or Excel file as a plan
`summarize_command_file()`	print the command list from a text or Excel file

Custom Scans#

`documentation_run()`	save text as a bluesky run
`edge_align()`	align to the edge given mover and detector data, relative to absolute position
`label_stream_decorator()`	decorator: write labeled device(s) to bluesky stream(s)
`lineup()`	(deprecated) lineup and center a given axis, relative to current position
`lineup2()`	lineup and center a given mover, relative to the current position
`mesh_list_grid_scan()`	scan over a multi-dimensional mesh with n total points per motor trajectory
`nscan()`	scan over n variables moved together, each in equally spaced steps
`sscan_1D()`	simple 1-D scan using EPICS synApps sscan record
`TuneAxis`	tune a single axis with a signal

Overall#

`addDeviceDataAsStream()`	(deprecated) renamed to `write_stream()`
`command_list_as_table()`	format a command list as a pyRestTable table object
`documentation_run()`	save text as a bluesky run
`execute_command_list()`	execute the command list as a plan
`get_command_list()`	return command list from either text or Excel file
`label_stream_decorator()`	decorator: write labeled device(s) to bluesky stream(s)
`label_stream_stub()`	write ophyd-labeled objects to open bluesky run streams
`label_stream_wrapper()`	decorator support: write labeled device(s) to stream(s)
`lineup()`	(deprecated) lineup and center a given axis, relative to current position
`lineup2()`	lineup and center a given mover, relative to the current position
`mesh_list_grid_scan()`	scan over a multi-dimensional mesh with n total points per motor trajectory
`nscan()`	scan over n variables moved together, each in equally spaced steps
`parse_Excel_command_file()`	parse an Excel spreadsheet with commands, return as command list
`parse_text_command_file()`	parse a text file with commands, return as command list
`register_command_handler()`	define the function called to execute the command list
`request_input()`	request input from the user during a plan
`restorable_stage_sigs()`	decorator: save and restore a device’s stage_sigs around a plan
`run_blocking_function()`	run a blocking function as a bluesky plan in a thread
`run_command_file()`	execute a list of commands from a text or Excel file as a plan
`sscan_1D()`	simple 1-D scan using EPICS synApps sscan record
`summarize_command_file()`	print the command list from a text or Excel file
`TuneAxis`	tune a single axis with a signal
`write_stream()`	add an ophyd Device as an additional document stream

Also consult the Index under the Bluesky heading for links to the Callbacks, Devices, Exceptions, and Plans described here.