Struct DiagnosticRecorder 

pub struct DiagnosticRecorder { /* private fields */ }

A cloneable callback whose recorded output remains accessible after a run.

Pass a clone to a runner and retain the original handle:

let recorder = DiagnosticRecorder::new(DiagnosticRecorderConfig::default());
let callback = Box::new(recorder.clone());
// Run with `callback`, then read `recorder.diagnostics()`.

Clones share one recorder state and may be read from another thread while a run is active, but they must not be installed in multiple concurrent runs: each run resets the shared state at its start. Recorder state is best-effort diagnostics, so a poisoned mutex is recovered and reset on the next run rather than preventing later diagnostic reads or reuse.

Implementations

impl DiagnosticRecorder

pub fn new(config: DiagnosticRecorderConfig) -> Self

Creates a recorder with shared state so clones observe the same captured data.

pub fn diagnostics(&self) -> ReconstructionDiagnostics

Returns a cloned, serializable snapshot of all collected diagnostic records.

pub fn into_diagnostics(self) -> ReconstructionDiagnostics

Consumes this handle and returns a cloned diagnostics snapshot shared with any clones.

pub fn object_snapshots(&self) -> Vec<(usize, Array2<f64>, Array2<f64>)>

Returns cloned (iteration, amplitude, wrapped_phase) object snapshots.

pub fn pupil_snapshots(&self) -> Vec<(usize, Array2<f64>, Array2<f64>)>

Returns cloned (iteration, amplitude, wrapped_phase) pupil snapshots.

pub fn reset(&self)

Clears all values collected by this recorder and its clones.

Trait Implementations

impl Callback for DiagnosticRecorder

fn requires_for( &self, hook: CallbackHook, iteration: usize, ) -> Vec<DiagnosticRequest>

Requests diagnostics for a specific hook. Built-in periodic callbacks override this to avoid computing snapshots on inactive iterations.

fn on_start(&mut self, context: &StepContext<'_>) -> Result<CallbackAction>

Runs once after state initialization and may stop before processing frames.

fn on_iteration_end( &mut self, context: &StepContext<'_>, ) -> Result<CallbackAction>

Runs after a complete iteration and may request clean termination.

fn on_finish(&mut self, _result: &ReconstructionResult) -> Result<()>

Runs once with the final owned result; errors are propagated by the runner.

fn requires(&self) -> Vec<DiagnosticRequest>

Declares diagnostics required at every hook by legacy or non-periodic callbacks.

fn on_frame_end(&mut self, _context: &StepContext<'_>) -> Result<CallbackAction>

Runs once for every completed frame when frame callbacks are enabled. For multi-frame algorithms, all frames in a batch observe the same post-batch state while frame_index and natural loss remain per-frame.

impl Clone for DiagnosticRecorder

fn clone(&self) -> DiagnosticRecorder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.