Enum ArrayType 

pub enum ArrayType {
    Unknown,
    MZArray,
    IntensityArray,
    ChargeArray,
    SignalToNoiseArray,
    TimeArray,
    WavelengthArray,
    IonMobilityArray,
    MeanIonMobilityArray,
    MeanDriftTimeArray,
    MeanInverseReducedIonMobilityArray,
    RawIonMobilityArray,
    RawDriftTimeArray,
    RawInverseReducedIonMobilityArray,
    DeconvolutedIonMobilityArray,
    DeconvolutedDriftTimeArray,
    DeconvolutedInverseReducedIonMobilityArray,
    ScanningQuadrupolePositionLowerBoundMZ,
    ScanningQuadrupolePositionUpperBoundMZ,
    IndexArray,
    BaselineArray,
    ResolutionArray,
    PressureArray,
    TemperatureArray,
    FlowRateArray,
    NonStandardDataArray {
        name: Box<String>,
    },
}

The kinds of data arrays found in mass spectrometry data files governed by the PSI-MS controlled vocabulary.

Variants

Unknown

No information is given about this array, not even a name

MZArray

The m/z array, the coordinate values of a mass spectrum. The default unit is Unit::MZ.

IntensityArray

The intensity or abundance of a signal at a given point. The default unit is Unit::DetectorCounts.

ChargeArray

The deconvolved charge state of an ion

SignalToNoiseArray

The estimated signal to noise ratio of a point observation

TimeArray

The time coordinate an observation occured such as for a feature, trace, or chromatgam. The default unit is Unit::Minute

WavelengthArray

The wavelength coordinate of an observation in a photospectrometry measurement. The default unit is Unit::Nanometer.

IonMobilityArray

A basic ion mobility array that contains no additional information about the unit or level of processing or aggregation. Note: It has no implicit unit information!

MeanIonMobilityArray

The mean ion mobility measurement of an observation. This is the centroid of an ion mobility measurement, distinct from a profile array view. Note: It has no implicit unit information!

MeanDriftTimeArray

The mean drift time of an observation. This is the centroid of an ion mobility measurement expressed in terms of drift time. The default unit is Unit::Millisecond.

MeanInverseReducedIonMobilityArray

The mean drift time of an observation. This is the centroid of an ion mobility measurement expressed in terms of $V*s/cm^2$. The default unit is Unit::VoltSecondPerSquareCentimeter.

RawIonMobilityArray

The raw ion mobility measurement of an observation. This is unprocessed and may be profile or centroid ion mobility measurements.

RawDriftTimeArray

The raw drift time of an observation. This is may be a profile or centroid representation of an ion mobility measurement expressed in terms of drift time. The default unit is Unit::Millisecond.

RawInverseReducedIonMobilityArray

The raw drift time of an observation. This is may be a profile or centroid representation of an ion mobility measurement expressed in terms of $V*s/cm^2$. The default unit is Unit::VoltSecondPerSquareCentimeter.

DeconvolutedIonMobilityArray

The mean ion mobility measurement of an observation after deconvolution of cross-cutting properties like charge state, adduct, or some other relevant property. This is the centroid of an ion mobility measurement, distinct from a profile array view. Note: It has no implicit unit information!

DeconvolutedDriftTimeArray

The mean ion mobility drift time measurement of an observation expressed in drift time after deconvolution of cross-cutting properties like charge state, adduct, or some other relevant property. This is the centroid of an ion mobility measurement. The default unit is Unit::Millisecond.

DeconvolutedInverseReducedIonMobilityArray

The mean ion mobility drift time measurement of an observation expressed in $V*s/cm^2$ after deconvolution of cross-cutting properties like charge state, adduct, or some other relevant property. This is the centroid of an ion mobility measurement. The default unit is Unit::Millisecond.

ScanningQuadrupolePositionLowerBoundMZ

Array of m/z values representing the lower bound m/z of the quadrupole position at each point in the spectrum. The default unit is Unit::MZ

ScanningQuadrupolePositionUpperBoundMZ

Array of m/z values representing the upper bound m/z of the quadrupole position at each point in the spectrum. The default unit is Unit::MZ

IndexArray

A data array whose values are index values for another collection or array.

BaselineArray

A data array of signal baseline values (the signal in the absence of analytes).

ResolutionArray

A data array of resolution values, which influence the accuracy of measurements.

PressureArray

A data array of pressure measurements.

TemperatureArray

A data array of temperature measurements.

FlowRateArray

A data array of flow rate measurements.

NonStandardDataArray

A data array that is not covered by any of the existing types, but given a distinct name. This is used for user- or application-defined arrays.

Fields

name: Box<String>

Implementations

impl ArrayType

pub const fn preferred_dtype(&self) -> BinaryDataArrayType

Get the data type that the array is compatible with in the mzdata type expectations.

By default, the m/z array is encoded using Float64, the charge state array is encoded using Int32, and all other arrays are encoded using Float32.

Examples

use mzdata_bindata::{ArrayType, BinaryDataArrayType};

assert_eq!(ArrayType::MZArray.preferred_dtype(), BinaryDataArrayType::Float64);
assert_eq!(ArrayType::IntensityArray.preferred_dtype(), BinaryDataArrayType::Float32);
assert_eq!(ArrayType::ChargeArray.preferred_dtype(), BinaryDataArrayType::Int32);

pub const fn as_mean_ion_mobility(&self) -> Option<ArrayType>

Convert an ion mobility array to its mean variant

Examples

use mzdata_bindata::ArrayType;

assert_eq!(
    ArrayType::RawDriftTimeArray.as_mean_ion_mobility(),
    Some(ArrayType::MeanDriftTimeArray)
);
assert_eq!(ArrayType::MZArray.as_mean_ion_mobility(), None);

pub const fn as_raw_ion_mobility(&self) -> Option<ArrayType>

Convert an ion mobility array to its raw variant

pub const fn as_deconvoluted_ion_mobility(&self) -> Option<ArrayType>

Convert an ion mobility array to its deconvoluted variant

pub fn nonstandard<S>(name: S) -> ArrayType

where S: ToString,

Create a ArrayType::NonStandardDataArray with the provided name.

pub const fn preferred_unit(&self) -> Option<Unit>

The preferred unit for this array type.

pub const fn is_ion_mobility(&self) -> bool

Test if the the array describes an ion mobility quantity.

Examples

use mzdata_bindata::ArrayType;

assert!(!ArrayType::MZArray.is_ion_mobility());
assert!(ArrayType::MeanInverseReducedIonMobilityArray.is_ion_mobility());

pub fn as_param(&self, unit: Option<Unit>) -> Param

Create a Param for this array type.

If a unit is provided, that unit will be specified, otherwise a default unit may be used instead.

Prefer this to Self::as_param_const when you do not need to worry about const-ness and the

pub const fn as_param_const(&self) -> ParamCow<'static>

Create a ParamCow for this array type in a const context using the default unit.

NOTE: If this is a Self::NonStandardDataArray, this function will panic as this variant requires allocation.

Prefer this method over Self::as_param_with_unit_const when the default unit is acceptable, and you are confident you are not dealing with a non-standard array.

Panics

When self is either Self::NonStandardDataArray or an unimplemented variant.

pub const fn as_param_with_unit_const(&self, unit: Unit) -> ParamCow<'static>

Create a ParamCow for this array type in a const context using the provided unit.

NOTE: If this is a Self::NonStandardDataArray, this function will panic as this variant requires allocation.

Prefer this method over Self::as_param_const when you want to control the unit directly rather than accepting the default unit and possibly updating it in the calling code.

Panics

When self is either Self::NonStandardDataArray or an unimplemented variant.

pub fn from_accession(x: CURIE) -> Option<ArrayType>

Translate from CURIE to an ArrayType

Trait Implementations

impl Clone for ArrayType

fn clone(&self) -> ArrayType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayType

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

Formats the value using the given formatter.

impl Default for ArrayType

fn default() -> ArrayType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArrayType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ArrayType

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

Formats the value using the given formatter.

impl Eq for ArrayType

impl Hash for ArrayType

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ArrayType

fn cmp(&self, other: &ArrayType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ArrayType

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ArrayType

fn partial_cmp(&self, other: &ArrayType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ArrayType

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ArrayType