Skip to main content

SpectralReconstructionCheckpoint

Struct SpectralReconstructionCheckpoint 

Source
pub struct SpectralReconstructionCheckpoint { /* private fields */ }
Expand description

Validated snapshot of a compiled spectral problem and one solver’s numerical state.

Spectral state stores centered spectra directly. Joint state stores amplitudes, OPD bounds and the fixed gauge, and retains automatic initialization records. Resume checks the exact ordered compiled model and a streaming SHA-256 of detector values, masks and weights. A changed total iteration target is allowed; stepping options and explicitly selected schedules must match. Scientific arrays and objectives resume exactly; elapsed wall times accumulate. The format rejects ordinary checkpoints and other spectral solver kinds.

§Example

use fpm_rs::{Result, algorithms::SpectralAlternatingProjection,
    measurements::MeasurementRead, reconstruction::{SpectralRunner,
    SpectralReconstructionCheckpoint, SpectralReconstructionProblem,
    SpectralReconstructionResult}};
fn resume<M: MeasurementRead>(problem: &SpectralReconstructionProblem<M>,
    checkpoint: SpectralReconstructionCheckpoint) -> Result<SpectralReconstructionResult> {
    SpectralRunner::new(SpectralAlternatingProjection::default().iterations(50))
        .with_checkpoint(checkpoint).run(problem)
}

The example requires saved default stepping options and a target of at least the completed pass count. The saved schedule is inherited.

Implementations§

Source§

impl SpectralReconstructionCheckpoint

Source

pub fn format_version(&self) -> u32

Returns the separately versioned format number.

Source

pub fn completed_iterations(&self) -> usize

Returns completed passes or accepted joint updates, including those before resume.

Source

pub fn algorithm(&self) -> &str

Returns the solver name; it determines which resume entry point may consume this snapshot.

Source

pub fn model(&self) -> &SpectralImagePlaneModel

Borrows the exact ordered compiled model, including fixed pupils and detector calibration.

Source

pub fn trace(&self) -> &ReconstructionTrace

Borrows the accumulated objective trace; timing includes earlier runs.

Source

pub fn opd_m(&self) -> Option<ArrayView2<'_, f64>>

Borrows the authoritative joint OPD map in metres, or returns None for spectral AP.

Source

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

Validates and atomically saves JSON, preserving binary64 values through float-roundtrip parsing. A failed write leaves an existing destination intact.

Source

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

Loads a spectral checkpoint, rejecting unknown fields, wrong kind/version, and invalid state.

Source

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

Loads and verifies the model plus a streaming fingerprint of measurements, masks, and weights.

Source

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

Checks metadata, array layouts/shapes, finite values, gauge, and contiguous trace numbering.

Source

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

Rejects changed ordered kernels, acquisition, detector data, masks, or weights. Fingerprinting streams one detector frame at a time and performs no reconstruction.

Trait Implementations§

Source§

impl Clone for SpectralReconstructionCheckpoint

Source§

fn clone(&self) -> SpectralReconstructionCheckpoint

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpectralReconstructionCheckpoint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SpectralReconstructionCheckpoint

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SpectralReconstructionCheckpoint

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Key for T
where T: Clone,

§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
§

fn size(&self) -> usize

The size of the key in bytes.
§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,