sm_bluesky.electron_analyser.plans#

Members

analysercount

Count with an electron analyser, collecting each enabled region separately.

analyserscan

Perform a scan while collecting each enabled electron analyser region separately.

grid_analyserscan

Perform a grid scan while collecting each enabled electron analyser region separately.
sm_bluesky.electron_analyser.plans.analysercount(analyser: ElectronAnalyserDetector, sequence: BaseSequence, detectors: Sequence[Readable], num: int = 1, delay: float | Iterable[float] = 0.0, shutter: GenericFastShutter | None = None, close_shutter_per_region: bool = False, *, md: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Count with an electron analyser, collecting each enabled region separately.

The analyser is configured for each enabled region in the sequence and the provided detectors are triggered and read for each region. An optional shutter can be opened for each region and closed after each region if requested.

Parameters:

  • analyser – Electron analyser to configure and measure with.

  • sequence – Sequence containing the analyser regions to collect.

  • detectors – Additional detectors to trigger and read for each region.

  • num – Number of readings to acquire.

  • delay – Time delay between readings.

  • shutter – Optional shutter to open before collecting each region.

  • close_shutter_per_region – Whether to close the shutter after collecting each region.

  • md – Additional metadata to include in the run.

sm_bluesky.electron_analyser.plans.analyserscan(analyser: ElectronAnalyserDetector, sequence: BaseSequence, detectors: Sequence[Readable], args: Sequence[Movable | float | int], num: int | None = None, shutter: GenericFastShutter | None = None, close_shutter_per_region: bool = False, *, md: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Perform a scan while collecting each enabled electron analyser region separately.

At each scan step, the scan motors are moved to their target positions, then the analyser is configured for each enabled region in the sequence. The provided detectors and analyser are triggered and read for each region. An optional shutter can be opened for each region and closed after each region if requested.

Parameters:

  • analyser – Electron analyser to configure and measure with.

  • sequence – Sequence containing the analyser regions to collect.

  • detectors – Additional detectors to trigger and read for each region.

  • args – Sequence of scan arguments defining the motors, positions, and number of points or intervals.

  • num – Number of points to acquire at each step.

  • shutter – Optional shutter to open before collecting each region.

  • close_shutter_per_region – Whether to close the shutter after collecting each region.

  • md – Additional metadata to include in the run.

sm_bluesky.electron_analyser.plans.grid_analyserscan(analyser: ElectronAnalyserDetector, sequence: BaseSequence, detectors: Sequence[Readable], args: Sequence[Movable | float | int], shutter: GenericFastShutter | None = None, close_shutter_per_region: bool = False, snake_axes: Iterable | bool | None = None, *, md: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Perform a grid scan while collecting each enabled electron analyser region separately.

At each grid scan step, the scan motors are moved to their target positions, then the analyser is configured for each enabled region in the sequence. The provided detectors and analyser are triggered and read for each region. An optional shutter can be opened for each region and closed after each region if requested.

Parameters:

  • analyser – Electron analyser to configure and measure with.

  • sequence – Sequence containing the analyser regions to collect.

  • detectors – Additional detectors to trigger and read for each region.

  • args – Sequence of grid scan arguments defining the motors, positions, and number of points or intervals.

  • shutter – Optional shutter to open before collecting each region.

  • close_shutter_per_region – Whether to close the shutter after collecting each region.

  • snake_axes – Whether to reverse the direction of alternating axes for each row of the grid scan.

  • md – Additional metadata to include in the run.