Skip to main content

SpectralImagePlaneModel

Struct SpectralImagePlaneModel 

Source
pub struct SpectralImagePlaneModel { /* private fields */ }
Expand description

Algorithm-facing narrowband spectral model, containing no physical geometry.

All channels share detector shape and object-plane pixel pitch. Each keeps its own crops, subpixel offsets, pupil, and wavelength. For detector row f, prediction is gain[f] * sum(weight * local_intensity) + background[f]. Local source powers, source weights, and illumination-frame gains are included in local_intensity. Detector calibration is applied once.

Implementations§

Source§

impl SpectralImagePlaneModel

Source

pub fn from_experiment( channels: &[SpectralChannel], geometry: &SpectralGeometry, acquisition: SpectralAcquisitionPlan, image_shape: (usize, usize), reconstruction_shape: ReconstructionShape, object_coupling: ObjectCoupling, ) -> Result<Self>

Resolves every channel atomically and selects a grid from the union of crop bounds.

IDs and wavelengths must be unique, wavelengths finite and positive, and all detector pitches equal. Shared direct k-vectors and configurations requiring spatial registration or resampling are rejected. An explicit reconstruction shape must contain all channels’ interpolation stencils.

§Example
use fpm_rs::{
    algorithms::{SpectralAlternatingProjection, SpectralReconstructionAlgorithm},
    experiment::{AcquisitionPlan, DirectionList, Optics, SourceCalibration,
        SpectralAcquisitionPlan, SpectralChannel, SpectralGeometry},
    measurements::MeasurementStack,
    model::{ObjectCoupling, ReconstructionShape, SpectralImagePlaneModel},
    reconstruction::SpectralReconstructionProblem,
};
let channels: Vec<_> = [450e-9, 630e-9].into_iter().enumerate().map(|(index, wavelength)| {
    Ok(SpectralChannel {
        channel_id: format!("channel-{index}"),
        optics: Optics {
            wavelength_vacuum_m: wavelength, objective_na: 0.1,
            magnification: 4.0, camera_pixel_size: 6.5e-6,
            illumination_refractive_index: 1.0,
            objective_medium_refractive_index: 1.0,
            defocus_distance: None, pupil_aberration: None,
        },
        calibration: SourceCalibration::unity(),
        acquisition: AcquisitionPlan::all_sources(1)?,
    })
}).collect::<fpm_rs::Result<_>>()?;
let geometry = SpectralGeometry::Shared(
    DirectionList::from_direction_cosines(vec![[0.0, 0.0]])?.into(),
);
let model = SpectralImagePlaneModel::from_experiment(
    &channels, &geometry, SpectralAcquisitionPlan::separate(&[1, 1])?,
    (4, 4), ReconstructionShape::Smooth, ObjectCoupling::Independent,
)?;
let measurements = MeasurementStack::from_vec(vec![1.0; 2 * 4 * 4], (4, 4), vec![])?;
let problem = SpectralReconstructionProblem::new(measurements, model)?;
let result = SpectralAlternatingProjection::default().iterations(2).run(&problem)?;
assert_eq!(result.channels.len(), 2);
let continued = fpm_rs::reconstruction::SpectralRunner::new(
    SpectralAlternatingProjection::default().iterations(3),
).with_checkpoint(result.checkpoint.unwrap()).run(&problem)?;
assert_eq!(continued.runtime.completed_iterations, 3);
Source

pub fn from_compiled_channels( channels: Vec<SpectralModelChannel>, acquisition: SpectralAcquisitionPlan, object_coupling: ObjectCoupling, ) -> Result<Self>

Assembles validated wavelength kernels already compiled on one common grid. Used by external dataset converters; rejects missing wavelength metadata, duplicate IDs/wavelengths, incompatible sampling, and uncovered local frames.

Source

pub fn mixing_diagnostics( &self, relative_tolerance: Option<f64>, ) -> Result<SpectralMixingDiagnostics>

Reports the collapsed detector-exposure/channel mode-weight matrix. Each entry sums detector gain × spectral weight × local frame gain × local incoherent source-weight sum. Background and measurement masks/weights are excluded. Different crops and pupils remain separate forward operators; matrix rank alone does not establish nonlinear reconstruction identifiability.

relative_tolerance must be finite and nonnegative; omission uses max(exposures, channels) * f64::EPSILON. Rank counts singular values strictly above largest * relative_tolerance. Singular values use a scaled cyclic one-sided Jacobi SVD, transposing wide matrices. Nonconvergence fails.

§References

NumPy, matrix_rank documentation, for the default numerical-rank threshold. LAPACK 3.12.1, DGESVJ documentation, for one-sided Jacobi SVD; this crate implements its own cyclic rotations.

Source

pub fn channels(&self) -> &[SpectralModelChannel]

Borrows the ordered channel metadata and ordinary numerical kernels.

Source

pub fn acquisition(&self) -> &SpectralAcquisitionPlan

Borrows the canonical sparse physical detector plan.

Source

pub fn object_coupling(&self) -> ObjectCoupling

Returns the explicitly chosen complex-object sharing rule.

Source

pub fn object_count(&self) -> usize

Returns the number of independently stored object spectra (one when shared).

Source

pub fn object_index(&self, channel: usize) -> Result<usize>

Returns the stored object index used by a given channel.

Source

pub fn image_shape(&self) -> (usize, usize)

Returns the common low-resolution detector (height, width).

Source

pub fn reconstruction_shape(&self) -> (usize, usize)

Returns the common high-resolution object (height, width).

Source

pub fn frame_count(&self) -> usize

Returns the physical detector frame count.

Source

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

Validates common sampling, unique IDs/wavelengths, references, and local coverage.

Source

pub fn forward_intensity( &self, spectra: &[ArrayView2<'_, Complex64>], frame: usize, ) -> Result<Array2<f64>>

Evaluates a detector frame by calling each canonical single-channel forward model.

spectra contains centered, standard-layout common-grid spectra in stored object order, with the core’s 1/(height * width) forward FFT normalization: one per channel for independent objects, one for a shared object. Returns an owned standard-layout intensity image. Geometry, pupil sampling, signs, and subpixel interpolation use the ordinary kernels.

Trait Implementations§

Source§

impl Clone for SpectralImagePlaneModel

Source§

fn clone(&self) -> SpectralImagePlaneModel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpectralImagePlaneModel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SpectralImagePlaneModel

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SpectralImagePlaneModel

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Key for T
where T: Clone,

§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
§

fn size(&self) -> usize

The size of the key in bytes.
§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,