Mobilogram#

Mobilograms are a type of plot used to visualize ion mobility data. In this plot, ion mobility is represented on the x-axis, while intensity is shown on the y-axis. The by parameter can be utilized to separate different mass traces. Functionally, mobilograms are similar to chromatograms.

Parameters#

Parameter

Type

Description

Default

x*

str

The column name for the X-axis data. Required.

y*

str

The column name for the Y-axis data. Required.

by*

str

The column name for the grouping variable.

canvas*

Any

Canvas for the plot. For Bokeh, this is a bokeh.plotting.Figure object. For Matplotlib, this is an Axes object, and for Plotly, this is a plotly.graph_objects.Figure object. If none, axis will be created Defaults to None.

show_plot

bool

Whether to display the plot. Defaults to True.

True

annotation_data

pd.DataFrame | None

Data for annotations. Defaults to None.

None

annotation_colormap

str

Colormap for annotations. Defaults to “Dark2”.

“Dark2”

annotation_line_width

float

Width of the annotation lines. Defaults to 3.

3

annotation_line_type

str

Type of the annotation lines (e.g., “solid”, “dashed”). Defaults to “solid”.

“solid”

annotation_legend_config

Dict | LegendConfig

Configuration for the annotation legend. Defaults to a LegendConfig instance with title “Features”.

a LegendConfig instance with title “Features”

xlabel

str

Label for the X-axis. Defaults to “Ion Mobility”.

“Ion Mobility”

ylabel

str

Label for the Y-axis. Defaults to “Intensity”.

“Intensity”

title

str

Title of the plot. Defaults to “Mobilogram”.

“Mobilogram”

Example Usage#

Mobilogram ms_bokeh

Mobilogram ms_bokeh

Mobilogram ms_matplotlib

Mobilogram ms_matplotlib

Mobilogram ms_plotly

Mobilogram ms_plotly