IMDataArrayUtils Class Reference

Interpret ion-mobility array metadata independently of frame conversion. More...

#include <OpenMS/IONMOBILITY/IMDataArrayUtils.h>

Static Public Member Functions
static void	setIMUnit (DataArrays::FloatDataArray &fda, const DriftTimeUnit unit)
	Set the array name corresponding to a supported ion-mobility unit.
static bool	getIMUnit (const DataArrays::FloatDataArray &fda, DriftTimeUnit &unit)
	Recognize an ion-mobility array and determine its unit.

Detailed Description

Interpret ion-mobility array metadata independently of frame conversion.

Uses the existing PSI-MS vocabulary and vendor-name fallbacks. The shared CV files remain a runtime requirement. IMDataConverter retains compatibility entry points for both operations.

Member Function Documentation

getIMUnit()

static bool getIMUnit ( const DataArrays::FloatDataArray &  fda, DriftTimeUnit &  unit  )

static

Recognize an ion-mobility array and determine its unit.

Parameters

[in]	fda	Array whose name is interpreted.
[out]	unit	Recognized unit, or NONE for a CV term without usable units. Unchanged if the array is not recognized as ion-mobility data.

Returns

True if the array describes ion-mobility data.

setIMUnit()

static void setIMUnit ( DataArrays::FloatDataArray &  fda, const DriftTimeUnit  unit  )

static

Set the array name corresponding to a supported ion-mobility unit.

Parameters

[in,out]	fda	Array whose name is updated.
[in]	unit	MILLISECOND or VSSC.

Exceptions

Exception::InvalidValue

for other units.