MSExperimentArrowExport.h File Reference

#include <OpenMS/config.h>
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/KERNEL/MSExperiment.h>
#include <cstdint>
#include <vector>
#include <string>

Include dependency graph for MSExperimentArrowExport.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ArrowSpectraExportConfig
	Configuration for Arrow export of spectra data. More...
struct	ArrowChromatogramExportConfig
	Configuration for Arrow export of chromatogram data. More...
struct	ParquetWriteConfig
	Configuration for Parquet file writing. More...
class	MSExperimentArrowExport
	Export MSExperiment data to Apache Arrow format. More...

Namespaces
namespace	OpenMS
	Main OpenMS namespace.

Enumerations
enum class	ArrowExportFormat { Long , SemiWide }
	Format for Arrow export. More...

---

Class Documentation

OpenMS::ArrowSpectraExportConfig

struct OpenMS::ArrowSpectraExportConfig

Configuration for Arrow export of spectra data.

Allows filtering by MS level, RT range, m/z range, and column selection.

Note

When ms_levels is empty, all MS levels are exported.

When columns is empty, all available columns are exported.

RT and m/z ranges of (0, 0) indicate no filtering.

String columns use standard utf8 with 32-bit offsets. Total string bytes per column are limited to ~2GB. This is sufficient for typical native_id values.

Collaboration diagram for ArrowSpectraExportConfig:

Class Members
vector< string >	columns	Columns to export (empty = all available columns) Available columns depend on format: Long: mz, intensity, rt, ion_mobility, spectrum_index, ms_level, native_id, precursor_mz, precursor_charge, precursor_intensity, isolation_lower, isolation_upper SemiWide: Same but mz/intensity/ion_mobility are list arrays
ArrowExportFormat	format = ArrowExportFormat::Long	Export format (Long or SemiWide)
bool	include_ion_mobility = true	Include ion mobility if present in data (default: true)
bool	include_precursor_info = true	Include precursor information columns (default: true)
double	max_mz = 0	Maximum m/z (0 = no upper bound)
double	max_rt = 0	Maximum RT in seconds (0 = no upper bound)
double	min_mz = 0	Minimum m/z (0 = no lower bound)
double	min_rt = 0	Minimum RT in seconds (0 = no lower bound)
vector< UInt >	ms_levels	MS levels to include (empty = all levels)

OpenMS::ArrowChromatogramExportConfig

struct OpenMS::ArrowChromatogramExportConfig

Configuration for Arrow export of chromatogram data.

Allows filtering by RT range and column selection.

Note

When columns is empty, all available columns are exported.

RT ranges of (0, 0) indicate no filtering.

Collaboration diagram for ArrowChromatogramExportConfig:

Class Members
vector< string >	columns	Columns to export (empty = all available columns)
ArrowExportFormat	format = ArrowExportFormat::Long	Export format (Long or SemiWide)
double	max_rt = 0	Maximum RT in seconds (0 = no upper bound)
double	min_rt = 0	Minimum RT in seconds (0 = no lower bound)