mzsignal is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install mzsignal

It will make the mzsignal command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall mzsignal uninstalls.

Adding `mzsignal` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add mzsignal

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

mzsignal = "1.1.11"

The mzsignal library will be automatically available globally. Read the mzsignal library documentation.

Back to the crate overview.

Readme

mzsignal - Low Level Signal Processing For Mass Spectra

mzsignal is a library for performing low-level signal processing on mass spectra en-route to converting a continuous profile-mode spectrum into a centroided peak list.

The peak picking facility can be used directly with PeakPicker which implements a simple gaussian peak shape fitter. There are a some threshold criteria that can be manipulated to control which fits are reported, see its documentation for more details.

When one spectrum is insufficient, averaging the signal from multiple spectra together can be better. The average sub-module includes components for merging together multiple profile spectra.

Usage

use std::fs;
use std::io;
use std::io::prelude::*;

use mzsignal;

// Read in signal arrays from a text file
let mut mz_array: Vec<f64> = Vec::new();
let mut intensity_array: Vec<f32> = Vec::new();
let reader = io::BufReader::new(fs::File::open("./test/data/test.txt").unwrap());
for line in reader.lines() {
    let line = line.unwrap();
    let pref = line.trim();
    let chunks: Vec<&str> = pref.split("\t").collect();
    mz_array.push(chunks[0].parse::<f64>().expect("Expected number for m/z"));
    intensity_array.push(chunks[1].parse::<f32>().expect("Expected number for intensity"));
}

// Create a peak picker
let picker = mzsignal::PeakPicker::default();

// Create an accumulator
let mut acc = Vec::new();

// Pick peaks
let peak_count = picker.discover_peaks(&mz_array, &intensity_array, &mut acc).unwrap();
assert_eq!(peak_count , 4);

for peak in acc.iter() {
    println!("{}", peak);
}

Building

This library needs a small amount of linear algebra, so it depends on either nalgebra or ndarray+ndarray-linalg.

If the you wish to use ndarray-linalg, it needs a LAPACK implementation, controlled by the following features:

intel-mkl
openblas
netlib

otherwise, the default nalgebra backend will be used.

Installing the command-line executable

Adding mzsignal library as a dependency

Adding `mzsignal` library as a dependency