Expand description
OpenReadout live: data that is still being acquired.
replayrewrites a finished file step by step in the order acquisition software plausibly writes it (each pattern marked documented or assumed), so that reading growing files can be tested without an instrument.watchis a polling directory watcher: onewatch::WatchEventper new data set, plane, scan or sweep, per completed or stalled data set, per QC finding and per error.synthbuilds a small synthetic OME-TIFF for tests and demos.qccomputes live QC metrics (saturation, focus-drift proxy, dropped frames, TIC drop) and evaluates declarative TOML rules over them.
Whether a single file is still being written is decided in
openreadout_core::live from the evidence each reader reports. See book/src/guides/lab-shares.md.
§Example
use openreadout_core::Registry;
use openreadout_live::watch::{WatchOptions, Watcher};
// Register readers: `Registry::new().with(Box::new(openreadout_nd2::Nd2Reader))`.
let registry = Registry::new();
let mut options = WatchOptions::default();
options.roots.push("/data/incoming".into());
let mut watcher = Watcher::new(options);
loop {
watcher.poll(®istry, &mut |event| {
println!("{}", serde_json::to_string(&event).unwrap());
});
std::thread::sleep(std::time::Duration::from_millis(250));
}Modules§
- qc
- Live QC: metrics computed on each new plane or scan and declarative rules over them.
- replay
- Acquisition replay: rewrite a finished file into a new file (or directory) step by step,
in the order acquisition software plausibly writes it, so that reading growing files and
watchcan be tested without an instrument. After the last step the output is byte-identical to the source. - synth
- Small synthetic files for tests and demos (no corpus needed). Every value is invented.
- watch
- A polling directory watcher that reports new data sets, new planes, scans and sweeps, completion and stalls as events.