Crate mzdata_spectra

mzdata provides basic access to raw and processed mass spectrometry data formats in Rust.

mzdata requires a lot of parsing machinery which can make it a weighty dependency to to add to a project.

Modules

io

Reading and writing mass spectrometry data file formats and abstractions over them.

meta

Metadata describing mass spectrometry data files and their contents.

mzpeaks

mzpeaks implements the building blocks and machinery for representing peaks in a mass spectrum.

params

Elements of controlled vocabularies used to describe mass spectra and their components.

prelude

A set of foundational traits used throughout the library.

spectrum

The data structures and components that represent a mass spectrum and how to access their data.

utils

Macros

curie

cvmap

delegate_impl_metadata_trait

Delegates the implementation of MSDataFileMetadata to a member. Passing an extra level extended token implements the optional methods.

find_param_method

impl_metadata_trait

Assumes a field for the non-Option facets of the MSDataFileMetadata implementation are present. Passing an extra level extended token implements the optional methods.

impl_param_described

Implement the ParamDescribed trait for type $t, referencing a params member of type Vec<Param>.

impl_param_described_deferred

Implement the ParamDescribed trait for type $t, referencing a params member that is an Option<Vec<Param>> that will lazily be initialized automatically when it is accessed mutably.

mz_read

A macro that dynamically works out how to get a SpectrumSource-derived object from a path or io::Read + io::Seek boxed object. This is meant to be a convenience for working with a scoped file reader without penalty.

mz_write

A macro that dynamically works out how to get a SpectrumWriter from a path or io::Write boxed object.

Structs

MZReaderBuilder

A builder type for MZReaderType.

Param

A controlled vocabulary or user parameter

RawSpectrum

Represents a spectrum that hasn’t been processed yet, with only data arrays, potentially no discrete peaks. A raw spectrum may still be centroided, but the peaks still need to be decoded.

Type Aliases

CentroidSpectrum

MZReader

A specialization of MZReaderType for the default peak types, for common use. The preferred means of creating an instance is using the MZReader::open_path function.

ParamList

Spectrum

A ready-to-use parameterized type for representing a spectrum in multiple overlapping layers.