massdash.plotting.InteractiveThreeDimensionPlotter

class massdash.plotting.InteractiveThreeDimensionPlotter(config: PlotConfig)

Bases: object

Class for interactive three-dimensional plotting.

df

The input DataFrame containing the data for plotting.

Type:

pd.DataFrame

config

The configuration for plotting.

Type:

PlotConfig

plot(featureMap: FeatureMap)

Plot the data based on the configuration settings.

Returns:

List of plots generated based on the configuration settings.

Return type:

plots (list)

plot_3d_scatter(featureMap: FeatureMap, num_rows: int = -1, num_cols: int = 2) → Figure

Make a general 3D scatter plot with options for individual or overall plots.

Parameters:

• df (pd.DataFrame) – The DataFrame containing the data.

• num_cols (int, optional) – Number of columns in the subplot grid. Defaults to 2.

• include_ms1 (bool, optional) – Whether to include MS1 data. Defaults to True.

• include_ms2 (bool, optional) – Whether to include MS2 data. Defaults to True.

Returns:

The Plotly Figure object.

Return type:

go.Figure

plot_3d_vline(featureMap: FeatureMap) → Figure

Plot a 3D spectrum-chromatogram vertical line plot.

Returns:

The generated 3D vertical line plot.

Return type:

fig (plotly.graph_objs._figure.Figure)

plot_individual_3d_mesh_cube(featureMap: FeatureMap, num_cols: int = 2) → Figure

Plot individual 3D surface plots for each precursor and each product ion. (EXPERIMENTAL)

Parameters:

• featureMap (FeatureMap) – The FeatureMap object containing the data.

• num_cols (int, optional) – Number of columns in the subplot grid. Defaults to 2.

Returns:

The Plotly Figure object.

Return type:

go.Figure

plot_individual_3d_surface(featureMap: FeatureMap, num_cols: int = 2) → Figure

Plot individual 3D surface plots for each precursor and each product ion.

Parameters:

num_cols (int, optional) – Number of columns in the subplot grid. Defaults to 2.

Returns:

The Plotly Figure object.

Return type:

go.Figure

show()

Show the plot.