Skip to main content

SpectralReconstructionAlgorithm

Trait SpectralReconstructionAlgorithm 

Source
pub trait SpectralReconstructionAlgorithm {
    type IterationMetrics: AlgorithmIterationMetrics;

    // Required methods
    fn step<M: MeasurementRead>(
        &mut self,
        problem: &SpectralReconstructionProblem<M>,
        state: &mut SpectralReconstructionState,
        batch: &Batch,
        iteration: usize,
    ) -> Result<StepOutput<Self::IterationMetrics>>;
    fn iterations(&self) -> usize;

    // Provided methods
    fn validate(&self) -> Result<()> { ... }
    fn validate_problem<M: MeasurementRead>(
        &self,
        _problem: &SpectralReconstructionProblem<M>,
    ) -> Result<()> { ... }
    fn initialize<M: MeasurementRead>(
        &self,
        problem: &SpectralReconstructionProblem<M>,
    ) -> Result<SpectralReconstructionState> { ... }
    fn batch_size(&self) -> usize { ... }
    fn checkpoint_configuration(&self) -> Option<String> { ... }
    fn run<M: MeasurementRead>(
        self,
        problem: &SpectralReconstructionProblem<M>,
    ) -> Result<SpectralReconstructionResult>
       where Self: Sized { ... }
}
Expand description

Separate solver contract for compiled narrowband spectral models.

Implementors consume only the compiled spectral model and scalar MeasurementRead, never physical illumination geometry. Ordinary super::ReconstructionAlgorithm implementations are intentionally incompatible.

Required Associated Types§

Source

type IterationMetrics: AlgorithmIterationMetrics

Algorithm-owned metrics reduced in exact global detector schedule order.

Required Methods§

Source

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

Updates a batch of physical detector exposures in the supplied order.

Source

fn iterations(&self) -> usize

Returns the positive number of complete global schedule passes.

Provided Methods§

Source

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

Validates solver parameters before state initialization.

Source

fn validate_problem<M: MeasurementRead>( &self, _problem: &SpectralReconstructionProblem<M>, ) -> Result<()>

Validates algorithm-specific requirements on a spectral problem.

Source

fn initialize<M: MeasurementRead>( &self, problem: &SpectralReconstructionProblem<M>, ) -> Result<SpectralReconstructionState>

Creates default CPU spectral state using mask-aware amplitude initialization.

Source

fn batch_size(&self) -> usize

Returns a positive batch size; implementations still stream individual frames.

Source

fn checkpoint_configuration(&self) -> Option<String>

Returns canonical JSON stepping options for a stateless checkpointable solver. None (the default) disables capture/resume for custom implementations. Implementors opting in must keep every persistent numerical variable in the spectral state and exclude only the total iteration target here.

Source

fn run<M: MeasurementRead>( self, problem: &SpectralReconstructionProblem<M>, ) -> Result<SpectralReconstructionResult>
where Self: Sized,

Runs with sequential physical detector order and default initialization.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§