Struct mzdata::spectrum::SpectrumDescription
source · pub struct SpectrumDescription {
pub id: String,
pub index: usize,
pub ms_level: u8,
pub polarity: ScanPolarity,
pub signal_continuity: SignalContinuity,
pub params: ParamList,
pub acquisition: Acquisition,
pub precursor: Option<Precursor>,
}
Expand description
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 SpectrumDescription
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: ParamList
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§
Trait Implementations§
source§impl Clone for SpectrumDescription
impl Clone for SpectrumDescription
source§fn clone(&self) -> SpectrumDescription
fn clone(&self) -> SpectrumDescription
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for SpectrumDescription
impl Debug for SpectrumDescription
source§impl Default for SpectrumDescription
impl Default for SpectrumDescription
source§fn default() -> SpectrumDescription
fn default() -> SpectrumDescription
Returns the “default value” for a type. Read more
source§impl ParamDescribed for SpectrumDescription
impl ParamDescribed for SpectrumDescription
fn params(&self) -> &[Param]
fn params_mut(&mut self) -> &mut ParamList
fn add_param(&mut self, param: Param)
fn remove_param(&mut self, index: usize) -> Param
fn get_param_by_name(&self, name: &str) -> Option<&Param>
fn get_param_by_curie(&self, curie: &CURIE) -> Option<&Param>
fn get_param_by_accession(&self, accession: &str) -> Option<&Param>
source§impl PartialEq for SpectrumDescription
impl PartialEq for SpectrumDescription
source§fn eq(&self, other: &SpectrumDescription) -> bool
fn eq(&self, other: &SpectrumDescription) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for SpectrumDescription
Auto Trait Implementations§
impl Freeze for SpectrumDescription
impl RefUnwindSafe for SpectrumDescription
impl Send for SpectrumDescription
impl Sync for SpectrumDescription
impl Unpin for SpectrumDescription
impl UnwindSafe for SpectrumDescription
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.