Struct SaveResidualsEvery 

pub struct SaveResidualsEvery { /* private fields */ }

Periodically saves one signed intensity-residual PNG per measured frame.

Each image is scaled symmetrically around zero so mid-gray represents zero, dark pixels are negative residuals, and bright pixels are positive residuals.

Implementations

impl SaveResidualsEvery

pub fn new(frequency: usize, directory: impl Into<PathBuf>) -> Self

Creates a residual callback; zero frequency is normalized to one.

Trait Implementations

impl Callback for SaveResidualsEvery

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

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

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_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.

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

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