Struct Simulator 

pub struct Simulator { /* private fields */ }

Builder for deterministic synthetic image-plane FPM acquisitions.

The simulator owns its true model and optional object, assumed reconstruction model, camera, and illumination errors. Self::simulate consumes the builder and returns all measurements and ground-truth artifacts.

Implementations

impl Simulator

pub fn new(true_model: ImagePlaneModel) -> Self

Creates a simulator whose input model describes the true experiment.

Use Self::reconstruction_model with a separately compiled assumed optical model to simulate geometry or pupil mismatch.

pub fn ideal(model: ImagePlaneModel) -> Self

Creates an ideal optical-intensity simulator without camera or acquisition errors.

pub fn object(self, object: SyntheticObject) -> Self

Sets the owned high-resolution complex ground-truth object.

pub fn camera(self, camera: CameraModel) -> Self

Adds a detector response and marks the acquisition non-ideal.

pub fn illumination_acquisition_errors( self, errors: IlluminationAcquisitionErrors, ) -> Self

Adds non-geometric illumination acquisition errors.

pub fn reconstruction_model(self, model: ImagePlaneModel) -> Self

Sets the optical model supplied to reconstruction after simulation.

For an optical mismatch, compile this model and the true model from separate experiment descriptions. When a camera model is present, Self::simulate compiles the known linear camera response into this returned reconstruction model.

pub fn seed(self, seed: u64) -> Self

Sets the deterministic random seed used by acquisition and camera noise.

pub fn simulate(self) -> Result<SimulationResult>

Simulates measurements and returns detector counts plus a count-space reconstruction model.

This differs from serialized crate::configuration::SimulationConfiguration, which stores a strict optical reconstruction model and exposes reconstruction_model_for_counts() for callers that load detector counts later.