Struct BinaryArrayMap3D

Source
pub struct BinaryArrayMap3D {
    pub ion_mobility_dimension: Vec<f64>,
    pub ion_mobility_type: ArrayType,
    pub ion_mobility_unit: Unit,
    pub arrays: Vec<BinaryArrayMap>,
    pub additional_arrays: BinaryArrayMap,
    /* private fields */
}
Expand description

Represent a set of BinaryArrayMap that has been split across the ion mobility dimension.

Fields§

§ion_mobility_dimension: Vec<f64>§ion_mobility_type: ArrayType§ion_mobility_unit: Unit§arrays: Vec<BinaryArrayMap>§additional_arrays: BinaryArrayMap

Implementations§

Source§

impl BinaryArrayMap3D

Source

pub fn from_ion_mobility_dimension( ion_mobility_dimension: Vec<f64>, ion_mobility_type: ArrayType, ion_mobility_unit: Unit, ) -> BinaryArrayMap3D

Source

pub fn from_ion_mobility_dimension_and_arrays( ion_mobility_dimension: Vec<f64>, ion_mobility_type: ArrayType, ion_mobility_unit: Unit, arrays: Vec<BinaryArrayMap>, ) -> BinaryArrayMap3D

Source

pub fn get_ion_mobility(&self, ion_mobility: f64) -> Option<&BinaryArrayMap>

Get the associated arrays at the requested ion mobility, if they exist

Source

pub fn search_ion_mobility( &self, ion_mobility: f64, error_tolerance: f64, ) -> Option<(&BinaryArrayMap, f64)>

Source

pub fn get_ion_mobility_mut( &mut self, ion_mobility: f64, ) -> Option<&mut BinaryArrayMap>

Get the a mutable reference to the associated arrays at the requested ion mobility, if they exist

Source

pub fn iter(&self) -> impl Iterator<Item = (f64, &BinaryArrayMap)>

Iterate over the ion mobility dimension and associated arrays at each point.

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = (f64, &mut BinaryArrayMap)>

Iterate over the ion mobility dimension and a mutable reference to the associated arrays at each point.

Source

pub fn unstack(&self) -> Result<BinaryArrayMap, ArrayRetrievalError>

Flatten this array into a single BinaryArrayMap.

§Errors

ArrayRetrievalError errors related to array decoding occur if any DataArray cannot be decoded, or if an expected array is absent.

Source

pub fn stack( source: &BinaryArrayMap, ) -> Result<BinaryArrayMap3D, ArrayRetrievalError>

Convert a BinaryArrayMap into a BinaryArrayMap3D if it has an ion mobility dimension.

Any arrays that aren’t the same length as the ion mobility dimension will be in BinaryArrayMap3D::additional_arrays.

§Errors

ArrayRetrievalError errors related to array decoding occur if any DataArray cannot be decoded, or if an expected array is absent.

Trait Implementations§

Source§

impl Clone for BinaryArrayMap3D

Source§

fn clone(&self) -> BinaryArrayMap3D

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BinaryArrayMap3D

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BinaryArrayMap3D

Source§

fn default() -> BinaryArrayMap3D

Returns the “default value” for a type. Read more
Source§

impl TryFrom<&BinaryArrayMap> for BinaryArrayMap3D

Source§

type Error = ArrayRetrievalError

The type returned in the event of a conversion error.
Source§

fn try_from( value: &BinaryArrayMap, ) -> Result<BinaryArrayMap3D, <BinaryArrayMap3D as TryFrom<&BinaryArrayMap>>::Error>

Performs the conversion.
Source§

impl TryFrom<BinaryArrayMap> for BinaryArrayMap3D

Source§

type Error = ArrayRetrievalError

The type returned in the event of a conversion error.
Source§

fn try_from( value: BinaryArrayMap, ) -> Result<BinaryArrayMap3D, <BinaryArrayMap3D as TryFrom<BinaryArrayMap>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.