Enum TimsDataLoader 

pub enum TimsDataLoader {
    InMemory(TimsInMemoryLoader),
    Lazy(TimsLazyLoder),
}

Variants

InMemory(TimsInMemoryLoader)

Lazy(TimsLazyLoder)

Implementations

impl TimsDataLoader

pub fn new_lazy( bruker_lib_path: &str, data_path: &str, use_bruker_sdk: bool, scan_max_index: u32, im_lower: f64, im_upper: f64, tof_max_index: u32, mz_lower: f64, mz_upper: f64, ) -> Self

pub fn new_in_memory( bruker_lib_path: &str, data_path: &str, use_bruker_sdk: bool, scan_max_index: u32, im_lower: f64, im_upper: f64, tof_max_index: u32, mz_lower: f64, mz_upper: f64, ) -> Self

pub fn new_lazy_with_calibration( data_path: &str, bruker_lib_path: &str, tof_max_index: u32, mz_lower: f64, mz_upper: f64, im_lookup: Vec<f64>, ) -> Self

Create a lazy loader with pre-computed ion mobility calibration lookup table.

This method enables accurate ion mobility calibration with fast parallel extraction. The im_lookup table should be pre-computed using the Bruker SDK.

Arguments

• data_path - Path to the .d folder
• bruker_lib_path - Path to the Bruker SDK shared library; used to derive an accurate m/z calibration. Pass “NO_SDK” (or an empty string) to skip and use the 2-point boundary m/z model.
• tof_max_index - Maximum TOF index (from GlobalMetaData)
• mz_lower - Minimum m/z value (from GlobalMetaData)
• mz_upper - Maximum m/z value (from GlobalMetaData)
• im_lookup - Pre-computed scan→1/K0 lookup table

Returns

A new TimsDataLoader with LookupIndexConverter

pub fn new_in_memory_with_calibration( data_path: &str, bruker_lib_path: &str, tof_max_index: u32, mz_lower: f64, mz_upper: f64, im_lookup: Vec<f64>, ) -> Self

Create an in-memory loader with pre-computed ion mobility calibration lookup table.

This method enables accurate ion mobility calibration with fast parallel extraction. The im_lookup table should be pre-computed using the Bruker SDK.

Arguments

• data_path - Path to the .d folder
• bruker_lib_path - Path to the Bruker SDK shared library; used to derive an accurate m/z calibration. Pass “NO_SDK” (or an empty string) to skip and use the 2-point boundary m/z model.
• tof_max_index - Maximum TOF index (from GlobalMetaData)
• mz_lower - Minimum m/z value (from GlobalMetaData)
• mz_upper - Maximum m/z value (from GlobalMetaData)
• im_lookup - Pre-computed scan→1/K0 lookup table

Returns

A new TimsDataLoader with LookupIndexConverter

pub fn new_lazy_with_bruker_formula( data_path: &str, calibration_frame_id: u32, ) -> Self

Create a lazy loader using the exact SDK-free Bruker calibration formulas.

Builds a BrukerFormulaConverter from the MzCalibration / TimsCalibration tables (frame calibration_frame_id, default 1 — the coefficients are near-constant per run). Needs no Bruker SDK at build or runtime; 1/K0 is machine-exact and m/z is bit-exact for MzCalibration ModelType 1 (~1 ppm for ModelType 2).

pub fn new_in_memory_with_bruker_formula( data_path: &str, calibration_frame_id: u32, ) -> Self

In-memory counterpart of Self::new_lazy_with_bruker_formula.

pub fn new_lazy_with_mz_calibration( data_path: &str, tof_intercept: f64, tof_slope: f64, im_min: f64, im_max: f64, scan_max_index: u32, ) -> Self

Create a lazy loader with full calibration (both m/z and IM).

This method uses regression-derived m/z calibration coefficients instead of the simple boundary model, providing more accurate m/z conversion.

Arguments

• data_path - Path to the .d folder
• tof_intercept - Intercept for sqrt(mz) = intercept + slope * tof
• tof_slope - Slope for sqrt(mz) = intercept + slope * tof
• im_min - Minimum 1/K0 value
• im_max - Maximum 1/K0 value
• scan_max_index - Maximum scan index

pub fn new_in_memory_with_mz_calibration( data_path: &str, tof_intercept: f64, tof_slope: f64, im_min: f64, im_max: f64, scan_max_index: u32, ) -> Self

Create an in-memory loader with full calibration (both m/z and IM).

This method uses regression-derived m/z calibration coefficients instead of the simple boundary model, providing more accurate m/z conversion.

pub fn get_index_converter(&self) -> &dyn IndexConverter

pub fn get_frame_with_converter( &self, frame_id: u32, conv: &dyn IndexConverter, ) -> TimsFrame

get_frame with an explicit index converter (see TimsLazyLoder::get_frame_with_converter).

pub fn raw_data_path(&self) -> &str

Path of the .d folder this loader reads from.

pub fn sync_index_converter(&self) -> Option<&(dyn IndexConverter + Sync)>

The loader’s own index converter, if it is safe to use from several threads — i.e. everything except the Bruker SDK wrapper, whose tims_index_to_mz must not be called concurrently on one handle.

pub fn sdk_free_converter(&self) -> Option<TimsIndexConverter>

A converter that is safe to use from many threads at once, for readers that want to run in parallel while the dataset itself was opened with the Bruker SDK.

Returns None when the loader’s own converter is already thread-safe (anything but BrukerLib), or when the file carries no calibration tables the SDK-free BrukerFormulaConverter could evaluate — callers must then serialise their reads.

pub fn uses_bruker_sdk(&self) -> bool

Check if the Bruker SDK is being used for index conversion. The Bruker SDK is NOT thread-safe, so parallel operations that call the index converter must be disabled when using the SDK.

Trait Implementations

impl TimsData for TimsDataLoader

fn get_frame(&self, frame_id: u32) -> TimsFrame

fn get_raw_frame(&self, frame_id: u32) -> RawTimsFrame

fn get_slice(&self, frame_ids: Vec<u32>, num_threads: usize) -> TimsSlice

fn get_acquisition_mode(&self) -> AcquisitionMode

fn get_frame_count(&self) -> i32

fn get_data_path(&self) -> &str