Struct ExperimentDescription 

pub struct ExperimentDescription {
    pub optics: Optics,
    pub illumination: Illumination,
    pub optical_background: Option<Vec<f64>>,
}

Concrete optical experiment description used to compile an image-plane model.

Fields

optics: Optics

Physical microscope parameters in SI units.

illumination: Illumination

Concrete source geometry or calibrated illumination description.

optical_background: Option<Vec<f64>>

Optional optical intensity background, broadcast or stored per frame.

Implementations

impl ExperimentDescription

pub fn new(optics: Optics, illumination: Illumination) -> Self

Creates an experiment without optical intensity background.

pub fn with_optical_background(self, background: Vec<f64>) -> Self

Sets non-negative optical intensity background values.

During compilation the vector must contain either one row-major low-resolution frame or a full (frame, row, column) acquisition stack.

pub fn compile( &self, image_shape: (usize, usize), reconstruction_shape: ReconstructionShape, ) -> Result<ImagePlaneModel>

Compiles optics and illumination into an owned ImagePlaneModel.

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

Validates optics, source compilation, gains, multiplexing, and finite non-negative optical background values.

Trait Implementations

impl Clone for ExperimentDescription

fn clone(&self) -> ExperimentDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExperimentDescription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExperimentDescription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExperimentDescription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.