Struct SpectrumDescription

pub struct SpectrumDescription {
    pub id: String,
    pub index: usize,
    pub ms_level: u8,
    pub polarity: ScanPolarity,
    pub signal_continuity: SignalContinuity,
    pub params: Vec<Param>,
    pub acquisition: Acquisition,
    pub precursor: Option<Precursor>,
}

The set of descriptive metadata that give context for how a mass spectrum was acquired within a particular run. This forms the basis for a large portion of the SpectrumLike trait.

Fields

id: String

The spectrum’s native identifier

index: usize

The ordinal sequence number for the spectrum

ms_level: u8

The degree of exponentiation of the spectrum, e.g MS1, MS2, MS3, etc

polarity: ScanPolarity

The spectrum is in positive or negative mode

signal_continuity: SignalContinuity

The spectrum’s main representation is as a peak list or a continuous profile

params: Vec<Param>

A set of controlled or uncontrolled descriptors of the spectrum not already covered by fields

acquisition: Acquisition

A description of how the spectrum was acquired including time, scan windows, and more

precursor: Option<Precursor>

The parent ion or ions and their isolation and activation description

Implementations

impl SpectrumDescription

pub fn new( id: String, index: usize, ms_level: u8, polarity: ScanPolarity, signal_continuity: SignalContinuity, params: Vec<Param>, acquisition: Acquisition, precursor: Option<Precursor>, ) -> SpectrumDescription

pub fn title(&self) -> Option<Cow<'_, str>>

Find a parameter by its CURIE

Trait Implementations

impl Clone for SpectrumDescription

fn clone(&self) -> SpectrumDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpectrumDescription

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

Formats the value using the given formatter.

impl Default for SpectrumDescription

fn default() -> SpectrumDescription

Returns the “default value” for a type.

impl From<IonMobilityFrameDescription> for SpectrumDescription

fn from(value: IonMobilityFrameDescription) -> SpectrumDescription

Converts to this type from the input type.

impl From<SpectrumDescription> for IonMobilityFrameDescription

fn from(value: SpectrumDescription) -> IonMobilityFrameDescription

Converts to this type from the input type.

impl ParamDescribed for SpectrumDescription

fn params(&self) -> &[Param]

Obtain an immutable slice over the encapsulated Param list

fn params_mut(&mut self) -> &mut Vec<Param>

Obtain an mutable slice over the encapsulated Param list

fn add_param(&mut self, param: Param)

Add a new Param to the entity

fn extend_params(&mut self, it: impl IntoIterator<Item = Param>)

Add all parameters from an iterator of Param to the entity

fn remove_param(&mut self, index: usize) -> Param

Remove the ith Param from the entity.

fn get_param_by_name(&self, name: &str) -> Option<&Param>

Find the first Param whose name matches name

fn get_param_by_curie(&self, curie: &CURIE) -> Option<&Param>

Find the first Param whose CURIE matches curie

fn get_param_by_accession(&self, accession: &str) -> Option<&Param>

Find the first Param whose Param::accession matches accession

fn iter_params(&self) -> Iter<'_, Param>

Iterate over the encapsulated parameter list

fn iter_params_mut(&mut self) -> IterMut<'_, Param>

Iterate mutably over the encapsulated parameter list

impl PartialEq for SpectrumDescription

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SpectrumDescription