Skip to main content

fpm_rs/reconstruction/
mod.rs

1//! Reconstruction inputs, execution state, schedules, checkpoints, and results.
2//!
3//! Pair a compiled model and measurements in
4//! [`crate::reconstruction::ReconstructionProblem`], then run an
5//! [`crate::algorithms::ReconstructionAlgorithm`] directly or configure
6//! [`crate::reconstruction::Runner`] with [`crate::reconstruction::RunOptions`],
7//! callbacks, and a [`crate::reconstruction::FrameSchedule`]. The owned
8//! [`crate::reconstruction::ReconstructionResult`] contains the reconstructed field and
9//! trace.
10
11mod batch;
12mod checkpoint;
13mod opd;
14mod options;
15mod problem;
16mod result;
17mod runner;
18mod schedule;
19mod spectral;
20pub(crate) mod spectral_checkpoint;
21mod state;
22mod trace;
23
24#[cfg(feature = "parquet")]
25pub use crate::tabular::parquet::{
26    BUNDLE_FORMAT_VERSION, BundleArrays, BundleArtifact, BundleExportOptions, BundlePreviews,
27    BundleTables, BundleVerificationResult, ResultBundle, SPECTRAL_BUNDLE_FORMAT_VERSION,
28    SpectralResultBundle, read_bundle, read_spectral_bundle,
29};
30pub use batch::Batch;
31pub use checkpoint::{CHECKPOINT_FORMAT_VERSION, ReconstructionCheckpoint};
32pub use opd::{
33    MultiWavelengthReconstructionResult, OpticalPathDifferenceResult, PhaseReference,
34    SyntheticWavelengthUnwrapper,
35};
36pub use options::RunOptions;
37pub use problem::ReconstructionProblem;
38pub use result::{ReconstructionResult, RuntimeInfo};
39pub(crate) use result::{save_grayscale, save_signed_grayscale, state_object};
40pub use runner::Runner;
41pub use schedule::FrameSchedule;
42pub use spectral::{
43    SpectralChannelResult, SpectralFrameSchedule, SpectralReconstructionProblem,
44    SpectralReconstructionResult, SpectralReconstructionState, SpectralRunner,
45};
46pub use spectral_checkpoint::{
47    SPECTRAL_CHECKPOINT_FORMAT_VERSION, SpectralCheckpointOptions, SpectralReconstructionCheckpoint,
48};
49pub use state::{
50    AdaptiveAlternatingProjectionAuxiliaryState, AdmmAuxiliaryState, AlgorithmAuxiliaryState,
51    MpieAuxiliaryState, ReconstructionState,
52};
53pub use trace::{AlgorithmMetricRecord, IterationRecord, ReconstructionTrace};