Struct MeasurementSpec 

pub struct MeasurementSpec {
    pub frames: Vec<FrameSpec>,
    pub dark_frame: Option<PathBuf>,
    pub flat_field: Option<PathBuf>,
    pub background: Option<ImageSet>,
    pub mask: Option<ImageSet>,
    pub preprocessing: PreprocessingConfig,
}

Serializable specification for loading a measurement stack.

Fields

frames: Vec<FrameSpec>

Measurement files in acquisition-frame order.

dark_frame: Option<PathBuf>

Optional shared detector dark image, resolved relative to the manifest.

flat_field: Option<PathBuf>

Optional shared positive flat-field image, resolved relative to the manifest.

background: Option<ImageSet>

Optional shared or per-frame additive background images.

mask: Option<ImageSet>

Optional shared or per-frame binary mask images; non-zero pixels are valid.

preprocessing: PreprocessingConfig

Corrections applied when the resident stack is built or a lazy frame is decoded.

Implementations

impl MeasurementSpec

pub fn new(frames: Vec<FrameSpec>) -> Self

Creates a specification with no correction images and preprocessing disabled.

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

Serializes this specification as pretty-printed JSON at path.

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

Deserializes a JSON measurement specification without loading its image files.

Trait Implementations

impl Clone for MeasurementSpec

fn clone(&self) -> MeasurementSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MeasurementSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MeasurementSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MeasurementSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.