Skip to main content

Module reconstruction

Module reconstruction 

Source
Expand description

Reconstruction problems, state, schedules, runners, results, and checkpoints. Reconstruction inputs, execution state, schedules, checkpoints, and results.

Pair a compiled model and measurements in crate::reconstruction::ReconstructionProblem, then run an crate::algorithms::ReconstructionAlgorithm directly or configure crate::reconstruction::Runner with crate::reconstruction::RunOptions, callbacks, and a crate::reconstruction::FrameSchedule. The owned crate::reconstruction::ReconstructionResult contains the reconstructed field and trace.

Re-exports§

pub use crate::tabular::parquet::BUNDLE_FORMAT_VERSION;
pub use crate::tabular::parquet::BundleArrays;
pub use crate::tabular::parquet::BundleArtifact;
pub use crate::tabular::parquet::BundleExportOptions;
pub use crate::tabular::parquet::BundlePreviews;
pub use crate::tabular::parquet::BundleTables;
pub use crate::tabular::parquet::BundleVerificationResult;
pub use crate::tabular::parquet::ResultBundle;
pub use crate::tabular::parquet::SPECTRAL_BUNDLE_FORMAT_VERSION;
pub use crate::tabular::parquet::SpectralResultBundle;
pub use crate::tabular::parquet::read_bundle;
pub use crate::tabular::parquet::read_spectral_bundle;

Structs§

AdaptiveAlternatingProjectionAuxiliaryState
Resumable cycle-level feedback state for adaptive alternating projection.
AdmmAuxiliaryState
Resumable per-source auxiliary and scaled-dual fields for ADMM.
AlgorithmMetricRecord
One scalar emitted by an algorithm-specific iteration metric.
Batch
One scheduled group of acquisition frames supplied to an algorithm step.
IterationRecord
Universal information recorded after one complete reconstruction iteration.
MpieAuxiliaryState
Resumable object-spectrum momentum state for mPIE.
MultiWavelengthReconstructionResult
Independent wavelength reconstruction together with referenced common OPD recovery.
OpticalPathDifferenceResult
Owned common-grid OPD and diagnostics in input-channel order.
ReconstructionCheckpoint
Serializable algorithm state used to resume a reconstruction exactly.
ReconstructionProblem
Validated pairing of measurements with a compiled image-plane model.
ReconstructionResult
Owned reconstructed fields, calibration values, trace, and runtime metadata.
ReconstructionState
Mutable numerical state shared by algorithms during reconstruction.
ReconstructionTrace
Execution trace recorded for every reconstruction, independently of diagnostic callbacks.
RunOptions
Algorithm-independent execution options consumed by super::Runner.
Runner
Configurable executor for one reconstruction algorithm.
RuntimeInfo
Execution summary attached to a completed reconstruction.
SpectralChannelResult
Reconstructed channel metadata and owned arrays, kept together as one record.
SpectralCheckpointOptions
Optional periodic checkpoint output at accepted iteration boundaries. A checkpoint is also retained in supported solver results when no directory is set.
SpectralReconstructionCheckpoint
Validated snapshot of a compiled spectral problem and one solver’s numerical state.
SpectralReconstructionProblem
Validated pairing of scalar detector measurements and a compiled spectral model.
SpectralReconstructionResult
Channel-ordered spectral reconstruction output and algorithm-neutral trace.
SpectralReconstructionState
Mutable spectral object state with scratch storage for only the current exposure.
SpectralRunner
Executor for a spectral algorithm, distinct from ordinary reconstruction.
SyntheticWavelengthUnwrapper
Combines registered complex fields into one nondispersive OPD map.

Enums§

AlgorithmAuxiliaryState
Solver-specific state preserved in checkpoints.
FrameSchedule
Rule for ordering acquisition frames within each reconstruction iteration.
PhaseReference
Fixes each channel’s unobservable constant phase before wavelength mixing.
SpectralFrameSchedule
Ordering of physical detector exposures for a spectral solver.

Constants§

CHECKPOINT_FORMAT_VERSION
Current JSON checkpoint serialization format version.
SPECTRAL_CHECKPOINT_FORMAT_VERSION
Version of the separately tagged spectral checkpoint format. Ordinary reconstruction checkpoint versions are independent.