Struct IlluminationCalibration 

pub struct IlluminationCalibration {
    pub parameters: PlanarArrayCalibrationParameters,
    pub optimizer: BoundedFiniteDifferenceOptimizer,
    pub loss_type: LossType,
}

Serializable physical illumination-calibration configuration.

Fields

parameters: PlanarArrayCalibrationParameters

Explicit physical and multiplicative parameter selection.

optimizer: BoundedFiniteDifferenceOptimizer

Narrow deterministic bounded optimizer settings.

loss_type: LossType

Canonical measurement-domain data loss; amplitude MSE is the default.

Implementations

impl IlluminationCalibration

pub fn new(parameters: PlanarArrayCalibrationParameters) -> Self

Creates a calibrator using bounded finite differences and amplitude MSE.

pub fn optimizer(self, optimizer: BoundedFiniteDifferenceOptimizer) -> Self

Replaces bounded optimizer settings.

pub fn loss_type(self, loss_type: LossType) -> Self

Replaces the reused reconstruction measurement-domain loss.

pub fn validate_for(&self, illumination: &Illumination) -> Result<()>

Validates configuration against an initial illumination.

pub fn initialize( &self, illumination: &Illumination, optics: &Optics, ) -> Result<IlluminationCalibrationState>

Creates checkpointable absolute and normalized state for illumination.

pub fn calibrate<M: MeasurementRead>( &self, measurements: &M, optics: &Optics, initial_illumination: &Illumination, object_spectrum: ArrayView2<'_, Complex64>, pupil: &Pupil, model: &mut ImagePlaneModel, outer_steps: usize, ) -> Result<IlluminationCalibrationState>

Calibrates physical illumination for a fixed reconstructed object and pupil.

model must have been compiled from initial_illumination; it is refreshed in place and can be reused immediately. outer_steps repeats the configured bounded phase and must be positive. Joint object/illumination reconstruction is provided by crate::algorithms::JointReconstruction.

Trait Implementations

impl Clone for IlluminationCalibration

fn clone(&self) -> IlluminationCalibration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IlluminationCalibration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IlluminationCalibration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IlluminationCalibration

fn eq(&self, other: &IlluminationCalibration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IlluminationCalibration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IlluminationCalibration