Struct ScanEvent 

pub struct ScanEvent {
    pub start_time: f64,
    pub injection_time: f32,
    pub scan_windows: Vec<ScanWindow>,
    pub instrument_configuration_id: u32,
    pub params: Option<Box<ParamList>>,
    pub spectrum_reference: Option<Box<str>>,
}

Describes a single scan event. Unless additional post-processing is done, there is usually only one event per spectrum.

Fields

start_time: f64

When did the scan start acquisition relative to the run start, in minutes

injection_time: f32

The time spent filling the ion trapping device, in milliseconds

scan_windows: Vec<ScanWindow>

The windows of the primary axis covered by this event

instrument_configuration_id: u32

The identifier of the InstrumentConfiguration associated with the event

params: Option<Box<ParamList>>

Lazily initialized ParamList

spectrum_reference: Option<Box<str>>

The identifier for another spectrum in the current run or another file.

Implementations

impl ScanEvent

pub fn new( start_time: f64, injection_time: f32, scan_windows: Vec<ScanWindow>, instrument_configuration_id: u32, params: Option<Box<ParamList>>, ) -> Self

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

Find a parameter by its CURIE

pub fn resolution(&self) -> Option<ValueRef<'_>>

Find a parameter by its CURIE

pub fn scan_configuration(&self) -> Option<ValueRef<'_>>

Find a parameter by its CURIE

Trait Implementations

impl Clone for ScanEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanEvent

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

Formats the value using the given formatter.

impl Default for ScanEvent

fn default() -> Self

Returns the “default value” for a type.

impl IonMobilityMeasure for ScanEvent

fn ion_mobility(&self) -> Option<f64>

Get the ion mobility coordinate, if one is available.

fn has_ion_mobility(&self) -> bool

Test if an ion mobility value is present

fn ion_mobility_type(&self) -> Option<&Param>

Get the raw Param representation of the ion mobility measure with the unit

impl ParamDescribed for ScanEvent

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

Obtain an immutable slice over the encapsulated Param list

fn params_mut(&mut self) -> &mut ParamList

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 ScanEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScanEvent