Skip to content

Commit da88471

Browse files
Add note about native OpenMS Mobilogram class
Added documentation note that OpenMS C++ has a native Mobilogram class that may not yet be wrapped in pyopenms, and this wrapper uses MSChromatogram as the underlying representation. Co-authored-by: timosachsenberg <5803621+timosachsenberg@users.noreply.github.com>
1 parent 5e9f88c commit da88471

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,9 @@ print(df)
338338

339339
#### Mobilograms
340340

341-
Mobilograms represent the ion mobility dimension, showing intensity vs. drift time for a specific m/z:
341+
Mobilograms represent the ion mobility dimension, showing intensity vs. drift time for a specific m/z.
342+
343+
**Note:** OpenMS C++ has a native `Mobilogram` class that may not yet be wrapped in pyopenms. This wrapper uses `MSChromatogram` as the underlying representation for mobilogram data.
342344

343345
```python
344346
from openms_python import Py_Mobilogram

openms_python/py_mobilogram.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
44
A mobilogram is a chromatogram in the ion mobility dimension, representing
55
intensity vs. drift time for a specific m/z value.
6+
7+
Note: OpenMS C++ has a native Mobilogram class that may not yet be wrapped
8+
in pyopenms. This wrapper uses MSChromatogram as the underlying representation
9+
for mobilogram data.
610
"""
711

812
from typing import Tuple, Optional
@@ -20,6 +24,10 @@ class Py_Mobilogram(MetaInfoMappingMixin):
2024
A mobilogram represents the ion mobility dimension for a specific m/z,
2125
showing intensity vs. drift time (or other ion mobility values).
2226
27+
Note: OpenMS C++ has a native Mobilogram class that may not yet be wrapped
28+
in pyopenms. This wrapper uses MSChromatogram as the underlying representation
29+
for mobilogram data.
30+
2331
Example:
2432
>>> mob = Py_Mobilogram(native_chromatogram)
2533
>>> print(f"m/z: {mob.mz:.4f}")

0 commit comments

Comments
 (0)