Struct CameraModel 

pub struct CameraModel {
    pub photons_per_pixel: f64,
    pub gain_counts_per_electron: f64,
    pub offset_counts: f64,
    pub read_noise_electrons: f64,
    pub dark_current_electrons: f64,
    pub shot_noise: bool,
    pub pixel_sensitivity: Option<Vec<f64>>,
    pub bit_depth: Option<u8>,
    pub saturation_counts: Option<f64>,
    pub quantize: bool,
    pub bad_pixels: Vec<usize>,
    pub bad_pixel_value_counts: Option<f64>,
}

Concrete detector pipeline from optical intensity to digital counts.

Fields

photons_per_pixel: f64

Expected photoelectrons per pixel at unit optical intensity.

gain_counts_per_electron: f64

Linear conversion gain in digital camera counts per collected electron.

offset_counts: f64

Additive electronic bias in camera counts.

read_noise_electrons: f64

Gaussian read-noise standard deviation in electrons per pixel.

dark_current_electrons: f64

Expected dark-current electrons per pixel per simulated exposure.

shot_noise: bool

Whether to Poisson-sample photoelectrons and dark current.

pixel_sensitivity: Option<Vec<f64>>

Multiplicative detector sensitivity for each pixel.

bit_depth: Option<u8>

Optional digitizer bit depth; maximum code is 2^bits - 1 counts.

saturation_counts: Option<f64>

Optional upper clipping threshold in camera counts.

quantize: bool

Whether to round final camera counts to the nearest integer.

bad_pixels: Vec<usize>

Row-major pixel indices replaced after all other detector effects.

bad_pixel_value_counts: Option<f64>

Replacement value for Self::bad_pixels, in camera counts.

Implementations

impl CameraModel

pub fn new() -> Self

Creates the default noiseless linear detector with 1000 photons per unit intensity.

pub fn ideal() -> Self

Unit detector response without noise, clipping, or quantization.

pub fn photons_per_pixel(self, value: f64) -> Self

Sets the positive expected photoelectrons per pixel at unit optical intensity.

pub fn gain(self, counts_per_electron: f64) -> Self

Sets positive linear gain in camera counts per electron.

pub fn offset_counts(self, value: f64) -> Self

Sets finite additive camera-count bias.

pub fn read_noise_electrons(self, value: f64) -> Self

Sets non-negative Gaussian read-noise standard deviation in electrons.

pub fn dark_current_electrons(self, value: f64) -> Self

Sets non-negative expected dark-current electrons per pixel and exposure.

pub fn shot_noise(self, enabled: bool) -> Self

Enables or disables Poisson sampling of photoelectrons plus dark current.

pub fn pixel_sensitivity(self, values: Vec<f64>) -> Self

Sets one finite non-negative sensitivity multiplier per row-major detector pixel.

pub fn bit_depth(self, bits: u8) -> Self

Sets digitizer bit depth in 1..=53, enabling the corresponding maximum code.

pub fn saturation(self, counts: f64) -> Self

Sets a finite non-negative saturation threshold in camera counts.

pub fn quantize(self, enabled: bool) -> Self

Enables or disables rounding final counts to integer-valued f64 values.

pub fn bad_pixels(self, indices: Vec<usize>, value_counts: f64) -> Self

Replaces unique row-major detector indices with value_counts after measurement.

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

Validates gains, noise parameters, clipping/quantization settings, sensitivities, and uniqueness of bad-pixel indices independently of frame shape.

pub fn validate_for_frame(&self, frame_len: usize) -> Result<()>

Additionally checks sensitivity length and bad-pixel bounds for frame_len pixels.

pub fn measure_frame<R: Rng + ?Sized>( &self, intensity: &mut [f64], rng: &mut R, ) -> Result<()>

Converts one optical-intensity frame into detector counts in place.

pub fn compile_reconstruction_model( &self, model: ImagePlaneModel, ) -> Result<ImagePlaneModel>

Compiles known uniform linear response into a reconstruction model.

Pixel sensitivity, stochastic noise, clipping, quantization, and bad pixels remain detector effects and are not compiled into the model.

Trait Implementations

impl Clone for CameraModel

fn clone(&self) -> CameraModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CameraModel

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

Formats the value using the given formatter.

impl Default for CameraModel

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CameraModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CameraModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.