Struct MeasurementStack 

pub struct MeasurementStack { /* private fields */ }

An in-memory stack of image-plane intensity measurements.

Data are owned as a C-contiguous ndarray with dimension order (frame, row, column). Public ndarray views borrow this allocation without copying. The super::MeasurementRead boundary continues to expose flat frame slices for reconstruction and lazy-stack parity.

Implementations

impl MeasurementStack

pub fn from_vec( data: Vec<f64>, image_shape: (usize, usize), frame_metadata: Vec<FrameMetadata>, ) -> Result<Self>

Stores an owned row-major (frame, row, column) buffer with image shape (height, width), deriving default metadata when frame_metadata is empty.

pub fn new( data: Array3<f64>, frame_metadata: Vec<FrameMetadata>, ) -> Result<Self>

Stores an owned standard-layout (frame,row,column) array without a copy.

pub fn from_frames( frames: &[Vec<f64>], image_shape: (usize, usize), ) -> Result<Self>

Copies equally shaped row-major intensity frames into one resident stack.

pub fn from_image_files<P: AsRef<Path>>( paths: &[P], frame_metadata: Vec<FrameMetadata>, ) -> Result<Self>

Loads grayscale image files in acquisition order, converting native pixel values to f64.

pub fn from_tiff_stack( path: impl AsRef<Path>, frame_metadata: Vec<FrameMetadata>, ) -> Result<Self>

Loads every page of a same-shaped grayscale TIFF as one acquisition frame.

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

Loads a JSON MeasurementSpec and all referenced images.

pub fn from_manifest_definition( manifest: MeasurementSpec, base_directory: impl AsRef<Path>, ) -> Result<Self>

Loads a manifest value, resolving relative paths beneath base_directory.

pub fn data(&self) -> ArrayView3<'_, f64>

Borrows intensity data as (frame, row, column) without allocating or copying.

pub fn frame_view(&self, index: usize) -> Result<ArrayView2<'_, f64>>

Borrows one (row, column) intensity frame without copying.

pub fn frame_view_mut(&mut self, index: usize) -> Result<ArrayViewMut2<'_, f64>>

Mutably borrows one (row, column) intensity frame without copying.

pub fn frame_count(&self) -> usize

Returns the acquisition-frame count.

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

Returns low-resolution frame shape as (height, width).

pub fn frame_len(&self) -> usize

Returns the row-major element count of one frame.

pub fn as_slice(&self) -> &[f64]

Borrows the complete standard-layout (frame, row, column) stack as a flat slice.

pub fn frame_metadata(&self) -> &[FrameMetadata]

Borrows metadata in acquisition-frame order.

pub fn set_frame_weight(&mut self, index: usize, weight: f64) -> Result<()>

Sets a frame’s reconstruction weight after validating it.

pub fn preprocessing(&self) -> &PreprocessingConfig

Borrows the correction flags associated with this stack.

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

Checks non-empty consistent shapes and counts, standard layout, finite intensities, metadata indices/exposures/weights, correction arrays, and binary masks.

pub fn frame(&self, index: usize) -> Result<&[f64]>

Borrows one row-major intensity frame by acquisition index.

pub fn frame_mut(&mut self, index: usize) -> Result<&mut [f64]>

Mutably borrows one row-major intensity frame by acquisition index.

pub fn frame_weight(&self, index: usize) -> Result<f64>

Returns a frame’s non-negative reconstruction weight.

pub fn frame_mask(&self, index: usize) -> Result<Option<&[u8]>>

Borrows a frame’s row-major binary validity mask, including a broadcast mask.

pub fn with_dark_frame(self, dark: Array2<f64>) -> Result<Self>

Stores a finite same-shaped detector dark image and enables dark subtraction.

pub fn with_flat_field(self, flat: Array2<f64>) -> Result<Self>

Stores a positive finite same-shaped flat field and enables division by it.

pub fn with_background(self, background: Array2<f64>) -> Result<Self>

Stores one finite background image broadcast to every frame and enables subtraction.

pub fn with_per_frame_background(self, background: Array3<f64>) -> Result<Self>

Stores a finite (frame, row, column) background stack and enables subtraction.

pub fn with_masks(self, masks: Array2<u8>) -> Result<Self>

Stores one same-shaped binary mask broadcast to every frame.

pub fn with_per_frame_masks(self, masks: Array3<u8>) -> Result<Self>

Stores binary validity masks shaped (frame, row, column).

pub fn normalize_exposure(self) -> Self

Enables division by each frame’s positive exposure time during preprocessing.

pub fn clamp_negative(self) -> Self

Enables clamping corrected negative intensities to zero.

pub fn with_preprocessing( self, preprocessing: PreprocessingConfig, ) -> Result<Self>

Replaces correction flags, requiring every enabled correction array to be present.

pub fn apply_preprocessing(self) -> Result<Self>

Applies configured corrections in place and returns the owned stack.

Order is dark subtraction, flat-field division, exposure normalization, background subtraction, then optional non-negative clamping.

Trait Implementations

impl Clone for MeasurementStack

fn clone(&self) -> MeasurementStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MeasurementStack

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MeasurementStack

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MeasurementRead for MeasurementStack

fn frame_count(&self) -> usize

Returns the number of acquisition frames.

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

Returns low-resolution image shape as (height, width).

fn frame_len(&self) -> usize

Returns height * width, the row-major element count of one frame.

fn frame(&self, index: usize) -> Result<impl Deref<Target = [f64]> + '_>

Borrows or shares a row-major intensity frame by zero-based acquisition index.

fn frame_weight(&self, index: usize) -> Result<f64>

Returns a frame’s non-negative reconstruction weight.

fn frame_mask(&self, index: usize) -> Result<Option<&[u8]>>

Borrows an optional row-major binary validity mask for one frame.

fn frame_metadata(&self) -> &[FrameMetadata]

Borrows metadata in acquisition-frame order.

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

Checks shapes, counts, finite intensities, metadata, weights, and masks.

impl Serialize for MeasurementStack

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.