Skip to main content

SpectrumRecord

Struct SpectrumRecord 

Source
pub struct SpectrumRecord {
    pub id: String,
    pub metadata: SpectrumMetadata,
    pub wavelength_axis: WavelengthAxis,
    pub spectral_data: SpectralData,
    pub color_science: Option<ColorScience>,
    pub provenance: Option<Provenance>,
}
Expand description

A single spectral measurement.

Fields§

§id: String§metadata: SpectrumMetadata§wavelength_axis: WavelengthAxis§spectral_data: SpectralData§color_science: Option<ColorScience>§provenance: Option<Provenance>

Implementations§

Source§

impl SpectrumRecord

Source

pub fn resample(&self, target: &WavelengthAxis, method: ResampleMethod) -> Self

Resample this spectrum onto target, returning a new SpectrumRecord.

The source spectrum’s metadata, colour-science block, and provenance are preserved; a ProcessingStep describing the operation is appended to the provenance trail.

§Preconditions

The source wavelength axis must be sorted in ascending order. WavelengthAxis values produced by this library always satisfy this requirement; an unsorted axis will produce silently incorrect output.

§Uncertainty

Any uncertainty values on the source spectrum are not carried forward — the returned SpectralData always has uncertainty: None. Correct propagation of uncertainty through interpolation and averaging requires knowledge of the correlation structure of the input errors and is left to the caller.

Source§

impl SpectrumRecord

Source

pub fn points(&self) -> Vec<(f64, f64)>

Returns all (wavelength_nm, value) pairs.

Source

pub fn wavelength_range_nm(&self) -> Option<(f64, f64)>

Wavelength range as (min_nm, max_nm), or None if the axis is empty.

Source

pub fn n_points(&self) -> usize

Number of spectral data points.

Trait Implementations§

Source§

impl Clone for SpectrumRecord

Source§

fn clone(&self) -> SpectrumRecord

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 SpectrumRecord

Source§

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

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

impl<'de> Deserialize<'de> for SpectrumRecord

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

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

impl Serialize for SpectrumRecord

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> 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> 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.
Source§

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