bluesky.plans.ramp_plan

bluesky.plans.ramp_plan(go_plan: Generator[Msg, Any, P], monitor_sig: Readable, inner_plan_func: Callable[[], Generator[Msg, Any, P]], take_pre_data: bool = True, timeout: float | None = None, period: float | None = None, md: dict[str, Any] | None = None) → Generator[Msg, Any, str]

Take data while ramping one or more positioners.

The pseudo code for this plan is

sts = (yield from go_plan)

yield from open_run()
yield from inner_plan_func()
while not st.done:
    yield from inner_plan_func()
yield from inner_plan_func()

yield from close_run()

Parameters:

go_plangenerator

plan to start the ramp. This will be run inside of a open/close run.

This plan must return a ophyd.StatusBase object.

monitor_sigreadable

signal to be monitored

inner_plan_funcgenerator function

generator which takes no input

This will be called for every data point. This should create one or more events.

take_pre_data: Bool, optional

If True, add a pre data at beginning

timeoutfloat, optional

If not None, the maximum time the ramp can run.

In seconds

periodfloat, optional

If not None, take data no faster than this. If None, take data as fast as possible

If running the inner plan takes longer than period than take data with no dead time.

In seconds.