Release History¶

v0.6.0 (2023-06-15)¶

The DarkFramePreprocessor has new methods disable() and enable() to conveniently turn it off and on interactively.

It is now possible to have multiple DarkFramePreprocessor instances watching the same detector with different dark_plan and stream_name parameters. Previously, these would interact badly and raise errors.
When the same Snapshot is used multiple times, fresh unique identifiers are assigned to the Resource and Datum documents before they are reissued. That is, we never issue a document with a given unique ID more than once, even if the content is the same.

The dark_plan passed to DarkFramePreprocessor is now expected to accept a detector argument. Previously the dark_plan referred to a specific detector instance in its body, as in:
```
def dark_plan():
    # Do stuff with some_detector.
    ...

dark_frame_preprocessor = bluesky_darkframes.DarkFramePreprocessor(
     dark_plan=dark_plan, detector=some_detector)
```
Now, the dark_plan can be written to accept a generic detector argument, and DarkFramePreprocessor will pass some_detector in, as in:
```
def dark_plan(detector):
    # Do stuff with detector.
    ...

dark_frame_preprocessor = bluesky_darkframes.DarkFramePreprocessor(
     dark_plan=dark_plan, detector=some_detector)
```
The old signature dark_plan() is still supported for backward-compatbility, but a warning will be issued that this will not be supported in a future release.
Version v0.2.0 introduced a pedestal parameter in DarkSubtraction to help avoid overflow wrap-around. The documented default value was 100 but the actual default in the code was 0. The actual default has been changed to 100 to match the documentation.

This release fixes a critical off-by-one issue in v0.2.0. All users are recommended to upgrade.

Associate a given DarkFramePreprocessor instance with a specific detector. This enables it to only intercede when that specific detector is triggered and to ignore all other acquisitions.
Change the timing of when the conditions for a new dark frame are checked: the check now occurs just before the detector of interest is triggered.

Thie release adds two features that change the default behavior:

Check whether a new dark frame is needed and, if so, take one after each Event is closed (i.e. after each ‘save’ message) in addition to after each Run is opened (i.e. after each ‘open_run’ message).
Support a pedestal parameter. DarkSubtraction, which defaults to 100. This helps avoid negative values in the subtracted image. See docstring for details.

This release mostly consists of documentation and small usability improvements.

Fix critical bug in locked_signals feature and one-by-one bug in limit feature.

Initial release