Struct JointReconstruction 

pub struct JointReconstruction<A> {
    pub object_algorithm: A,
    pub optics: Optics,
    pub initial_illumination: Illumination,
    pub illumination_calibration: IlluminationCalibration,
    pub outer_iterations: usize,
    pub object_iterations_per_outer: usize,
    pub illumination_steps_per_outer: usize,
}

Alternates an existing object or object/pupil algorithm with physical LED calibration.

One runner iteration is one outer iteration. The complete acquisition order is supplied to the wrapped algorithm object_iterations_per_outer times, then bounded physical updates refresh only illumination-dependent model state. Generic Fourier-grid correction remains an independent feature of crate::algorithms::GradientDescent.

The joint-estimation motivation follows J. Sun, Q. Chen, Y. Zhang, and C. Zuo, “Efficient positional misalignment correction method for Fourier ptychographic microscopy,” Biomedical Optics Express 7(4), 1336–1350 (2016). This implementation uses bounded, scaled finite differences rather than that work’s simulated annealing and nonlinear regression. It does not implement the brightfield circle detection or spectral correlation of R. Eckert, Z. F. Phillips, and L. Waller, “Efficient illumination angle self-calibration in Fourier ptychography,” Applied Optics 57(19), 5434–5442 (2018).

Fields

object_algorithm: A

Existing analytic object or object/pupil update algorithm.

optics: Optics

Optical configuration used to resolve physical source positions.

initial_illumination: Illumination

Nominal reusable physical illumination.

illumination_calibration: IlluminationCalibration

Physical parameter selection, priors, loss, and bounded optimizer.

outer_iterations: usize

Number of alternating outer iterations.

object_iterations_per_outer: usize

Complete object-update passes before each physical phase.

illumination_steps_per_outer: usize

Repetitions of the configured bounded physical phase per outer iteration.

Implementations

impl<A> JointReconstruction<A>

pub fn new( object_algorithm: A, optics: Optics, initial_illumination: Illumination, illumination_calibration: IlluminationCalibration, outer_iterations: usize, ) -> Self

Creates an alternating reconstruction with one object pass and one calibration phase.

pub fn object_iterations_per_outer(self, iterations: usize) -> Self

Sets the positive number of complete object passes in each outer iteration.

pub fn illumination_steps_per_outer(self, steps: usize) -> Self

Sets the positive number of bounded illumination phases in each outer iteration.

impl<A: ReconstructionAlgorithm> JointReconstruction<A>

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

Runs alternating reconstruction without callbacks and returns structured physical output.

pub fn run_with_callbacks<M: MeasurementRead>( self, problem: &ReconstructionProblem<M>, callbacks: Vec<Box<dyn Callback>>, ) -> Result<JointReconstructionResult>

Runs alternating reconstruction with ordinary runner callbacks.

Outer-iteration callbacks receive physical phase metrics in the physical_illumination namespace, and checkpoint callbacks capture the complete physical state and refreshed model.

pub fn run_from_checkpoint<M: MeasurementRead>( self, problem: &ReconstructionProblem<M>, checkpoint: ReconstructionCheckpoint, ) -> Result<JointReconstructionResult>

Resumes alternating reconstruction from a checkpoint containing physical state.

Trait Implementations

impl<A: Clone> Clone for JointReconstruction<A>

fn clone(&self) -> JointReconstruction<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for JointReconstruction<A>

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

Formats the value using the given formatter.

impl<A: ReconstructionAlgorithm> ReconstructionAlgorithm for JointReconstruction<A>

type IterationMetrics = JointIterationMetrics

Algorithm-specific metrics emitted by each step and appended to the trace.

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

Validates solver parameters independently of a reconstruction problem.

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

Validates solver requirements that depend on problem.

fn initialize<M: MeasurementRead>( &self, problem: &ReconstructionProblem<M>, ) -> Result<ReconstructionState>

Creates the default CPU-backed state for problem.

fn initialize_with_backend<M: MeasurementRead>( &self, problem: &ReconstructionProblem<M>, backend: Arc<dyn Backend>, ) -> Result<ReconstructionState>

Creates reconstruction state using the supplied execution backend.

fn step<M: MeasurementRead>( &mut self, problem: &ReconstructionProblem<M>, state: &mut ReconstructionState, batch: &Batch, iteration: usize, ) -> Result<StepOutput<Self::IterationMetrics>>

Updates state for one scheduled batch in zero-based iteration.

fn canonicalize_state<M: MeasurementRead>( &self, problem: &ReconstructionProblem<M>, state: &mut ReconstructionState, ) -> Result<()>

Projects algorithm-owned ambiguities into a stable reported convention.

fn iterations(&self) -> usize

Returns the requested number of complete schedule passes.

fn batch_size(&self) -> usize

Returns the number of measured frames combined into one step.

fn supports_joint_reconstruction(&self) -> bool

Reports whether the algorithm may run inside physical joint calibration.

fn run<M: MeasurementRead>( self, problem: &ReconstructionProblem<M>, ) -> Result<ReconstructionResult>

where Self: Sized,

Runs the algorithm with default sequential scheduling and no callbacks.

fn run_with_callbacks<M: MeasurementRead>( self, problem: &ReconstructionProblem<M>, callbacks: Vec<Box<dyn Callback>>, ) -> Result<ReconstructionResult>

where Self: Sized,

Runs the algorithm and invokes callbacks at their declared hooks.

fn run_from_checkpoint<M: MeasurementRead>( self, problem: &ReconstructionProblem<M>, checkpoint: ReconstructionCheckpoint, ) -> Result<ReconstructionResult>

where Self: Sized,

Resumes a run from a checkpoint after validating it against problem.