import os
import re
from rainbow._arguments import (reject_removed_arguments,
validate_bin_width,
validate_display_precision)
from rainbow.waters import masslynx
from rainbow.datadirectory import DataDirectory
[docs]
def read(path, display_precision='auto', requested_files=None,
bin_width=None, _labels_only=False, **removed):
"""
Reads a Waters .raw directory.
Args:
path (str): Path of the directory.
display_precision (int or 'auto', optional): Decimals for the displayed
m/z (or wavelength) labels. Cosmetic. ``'auto'`` means whole numbers.
requested_files (list, optional): List of filenames to parse.
bin_width (float, optional): m/z bin width, the lossy binning control.
The default is nominal mass (1 Da). Waters MS m/z is calibrated to
roughly 0.03 Da.
Returns:
DataDirectory representing the Waters .raw directory.
"""
if removed:
reject_removed_arguments("waters.read", removed)
# Held to the same rules as rb.read: this is a documented entry point, and
# an unchecked m/z argument does not raise further down, it returns a grid
# whose labels no longer name its columns one to one.
validate_display_precision(display_precision)
validate_bin_width(bin_width)
if display_precision == 'auto':
display_precision = 0
if bin_width is None:
bin_width = 1.0
datafiles = []
datafiles.extend(masslynx.parse_spectrum(
path, display_precision, bin_width, requested_files, _labels_only))
datafiles.extend(masslynx.parse_analog(path, requested_files))
metadata = masslynx.parse_metadata(path)
return DataDirectory(path, datafiles, metadata)