Struct SimulationConfiguration 

pub struct SimulationConfiguration {
    pub format_version: u32,
    pub true_experiment: ExperimentDescription,
    pub reconstruction_experiment: ExperimentDescription,
    pub image_shape: (usize, usize),
    pub reconstruction_shape: (usize, usize),
    pub compiled_models: CompiledModelPair,
    pub camera: Option<CameraModel>,
    pub illumination_acquisition_errors: Option<IlluminationAcquisitionErrors>,
    pub random_seed: u64,
}

Complete, versioned configuration for simulation and reconstruction.

Fields

format_version: u32

true_experiment: ExperimentDescription

reconstruction_experiment: ExperimentDescription

image_shape: (usize, usize)

reconstruction_shape: (usize, usize)

compiled_models: CompiledModelPair

camera: Option<CameraModel>

illumination_acquisition_errors: Option<IlluminationAcquisitionErrors>

random_seed: u64

Implementations

impl SimulationConfiguration

pub fn new( true_experiment: ExperimentDescription, reconstruction_experiment: ExperimentDescription, image_shape: (usize, usize), reconstruction_shape: ReconstructionShape, ) -> Result<Self>

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

pub fn with_illumination_acquisition_errors( self, errors: IlluminationAcquisitionErrors, ) -> Result<Self>

pub fn with_random_seed(self, random_seed: u64) -> Self

pub fn reconstruction_model_for_counts(&self) -> Result<ImagePlaneModel>

Returns the assumed model with known linear camera response compiled in.

The serialized compiled_models.reconstruction_model remains the strict optical model. Use this helper when constructing a reconstruction problem from detector counts loaded through a saved configuration.

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

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Trait Implementations

impl Clone for SimulationConfiguration

fn clone(&self) -> SimulationConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimulationConfiguration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SimulationConfiguration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SimulationConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.