Struct ReconstructionCheckpoint 

pub struct ReconstructionCheckpoint { /* private fields */ }

Serializable algorithm state used to resume a reconstruction exactly.

Built-in pupil-recovering algorithms capture object and pupil arrays after their iteration-boundary gauge projection. Older valid checkpoints are projected immediately after restoration. Problem-aware validation requires the stored pupil support to equal the compiled model support, not only to have the same shape. Format version 2 uses algorithm_auxiliary as an extension point for solver state. Readers predating a particular auxiliary enum variant cannot deserialize checkpoints containing that variant.

Implementations

impl ReconstructionCheckpoint

pub fn capture( completed_iterations: usize, state: &ReconstructionState, trace: &ReconstructionTrace, ) -> Self

Clones resumable state and trace after completed_iterations complete passes.

pub const fn format_version(&self) -> u32

Returns the serialized checkpoint format version.

pub const fn completed_iterations(&self) -> usize

Returns the number of complete iterations represented by this state.

pub fn object_spectrum(&self) -> ArrayView2<'_, Complex64>

Borrows the centered high-resolution complex object spectrum.

pub fn pupil(&self) -> &Pupil

Borrows the low-resolution recovered pupil state.

pub fn illumination_corrections(&self) -> Option<&[(f64, f64)]>

Borrows optional per-source (row, column) corrections in Fourier-grid pixels.

pub fn frame_gains(&self) -> Option<&[f64]>

Borrows optional positive calibration gains in acquisition-frame order.

pub fn background(&self) -> Option<&[f64]>

Borrows optional additive intensity backgrounds in acquisition-frame order.

pub fn physical_illumination_calibration( &self, ) -> Option<&IlluminationCalibrationState>

Borrows physical planar-array calibration state, when joint calibration is active.

pub fn calibrated_model(&self) -> Option<&ImagePlaneModel>

Borrows the illumination-refreshed model used at checkpoint capture.

pub fn algorithm_auxiliary(&self) -> Option<&AlgorithmAuxiliaryState>

Borrows optional solver-specific resumable state.

pub const fn trace(&self) -> &ReconstructionTrace

Borrows the iteration trace accumulated before capture.

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Validates and serializes this checkpoint as JSON.

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Deserializes and validates a JSON checkpoint independently of a problem.

pub fn load_for_problem<M: MeasurementRead>( path: impl AsRef<Path>, problem: &ReconstructionProblem<M>, ) -> Result<Self>

Loads a checkpoint and verifies all dimensions, the exact pupil support, and calibration counts against the problem that will resume it.

pub fn validate(&self) -> Result<()>

Validates integrity that does not depend on a reconstruction problem.

pub fn validate_for_problem<M: MeasurementRead>( &self, problem: &ReconstructionProblem<M>, ) -> Result<()>

Validates checkpoint dimensions and calibration variables for problem.

Trait Implementations

impl Clone for ReconstructionCheckpoint

fn clone(&self) -> ReconstructionCheckpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReconstructionCheckpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReconstructionCheckpoint

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ReconstructionCheckpoint

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.