Struct SpectrumGroup 

pub struct SpectrumGroup<C = CentroidPeak, D = DeconvolutedPeak, S = MultiLayerSpectrum<C, D>>
where
    C: CentroidLike,
    D: DeconvolutedCentroidLike,
    S: SpectrumLike<C, D>,
{
    pub precursor: Option<S>,
    pub products: Vec<S>,
    /* private fields */
}

A pairing of an optional MS1 spectrum with all its associated MSn spectra.

Fields

precursor: Option<S>

The MS1 spectrum of a group. This may be absent when the source does not contain any MS1 spectra

products: Vec<S>

The collection of related MSn spectra. If MSn for n > 2 is used, all levels are present in this collection, though there is no ordering guarantee.

Implementations

impl<'a, C, D, S> SpectrumGroup<C, D, S>

where C: CentroidLike, D: DeconvolutedCentroidLike, S: SpectrumLike<C, D>,

pub fn new(precursor: Option<S>, products: Vec<S>) -> Self

pub fn iter(&'a self) -> SpectrumGroupIter<'a, C, D, S>

Trait Implementations

impl<C, D, S> Clone for SpectrumGroup<C, D, S>

where C: CentroidLike + Clone, D: DeconvolutedCentroidLike + Clone, S: SpectrumLike<C, D> + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, D, S> Debug for SpectrumGroup<C, D, S>

where C: CentroidLike + Debug, D: DeconvolutedCentroidLike + Debug, S: SpectrumLike<C, D> + Debug,

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

Formats the value using the given formatter.

impl<C: CentroidLike, D: DeconvolutedCentroidLike, S: SpectrumLike<C, D>> Default for SpectrumGroup<C, D, S>

fn default() -> Self

Returns the “default value” for a type.

impl<C, D, S> IntoIterator for SpectrumGroup<C, D, S>

where C: CentroidLike, D: DeconvolutedCentroidLike, S: SpectrumLike<C, D> + Default,

type Item = S

The type of the elements being iterated over.

type IntoIter = SpectrumGroupIntoIter<C, D, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C, D, S> PartialEq for SpectrumGroup<C, D, S>

where C: CentroidLike + PartialEq, D: DeconvolutedCentroidLike + PartialEq, S: SpectrumLike<C, D> + PartialEq,

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<C, D, S> SpectrumGrouping<C, D, S> for SpectrumGroup<C, D, S>

where C: CentroidLike, D: DeconvolutedCentroidLike, S: SpectrumLike<C, D>,

fn precursor(&self) -> Option<&S>

Get the precursor spectrum, which may be absent

fn precursor_mut(&mut self) -> Option<&mut S>

Get a mutable reference to the precursor spectrum, which may be absent

fn set_precursor(&mut self, prec: S)

Explicitly set the precursor spectrum directly.

fn products(&self) -> &[S]

Get a reference to the collection of product spectra

fn products_mut(&mut self) -> &mut Vec<S>

Get a mutable reference to the collection of product spectra

fn into_parts(self) -> (Option<S>, Vec<S>)

Decompose the group into its components, discarding any additional metrics

fn total_spectra(&self) -> usize

The total number of spectra in the group

fn earliest_spectrum(&self) -> Option<&S>

The spectrum that occurred first chronologically

fn latest_spectrum(&self) -> Option<&S>

The spectrum that occurred last chronologically

fn lowest_ms_level(&self) -> Option<u8>

The lowest MS level in the group. Returns None if the group is empty or the MS level is 0.

fn highest_ms_level(&self) -> Option<u8>

The highest MS level in the group. Returns None if the group is empty or the MS level is 0.

impl<C, D, S> StructuralPartialEq for SpectrumGroup<C, D, S>

where C: CentroidLike + PartialEq, D: DeconvolutedCentroidLike + PartialEq, S: SpectrumLike<C, D> + PartialEq,