interdim.vis

Functions

create_scatter_plot(x, y, z, marker_kwargs)	Create a scatter plot figure.
find_free_port()	Find and return a free port number.
interactive_scatterplot(x[, y, z, ...])	Create an interactive scatter plot using Dash.

Classes

Any(*args, **kwargs)	Special type indicating an unconstrained type.
Input(component_id, component_property)	Input of callback: trigger an update when it is updated.
InteractionPlot(data_source[, plot_type, ...])	A class for creating interactive plots based on data points.
Output(component_id, component_property[, ...])	Output of a callback.
Patch([location, parent])	Patch a callback output value
State(component_id, component_property)	Use the value of a State in a callback but don't trigger updates.

interdim.vis.find_free_port()

Find and return a free port number.

interdim.vis.create_scatter_plot(x, y, z, marker_kwargs, scatter_kwargs=None)

Create a scatter plot figure.

Parameters:

• x (array-like) – x-coordinates of the points.

• y (array-like, optional) – y-coordinates of the points.

• z (array-like, optional) – z-coordinates of the points.

• marker_kwargs (dict) – Keyword arguments for marker properties.

• scatter_kwargs (dict, optional) – Additional keyword arguments for the scatter plot.

Returns:

The created scatter plot figure.

Return type:

plotly.graph_objs.Figure

interdim.vis.interactive_scatterplot(x: ndarray, y: ndarray | None = None, z: ndarray | None = None, true_labels: ndarray | None = None, cluster_labels: ndarray | None = None, point_visualization: Callable | str | None = None, marker_kwargs: Dict | None = None, scatter_kwargs: Dict | None = None, interact_mode: Literal['hover', 'click'] = 'hover', port: int | None = None, verbose: bool = False) → Dash

Create an interactive scatter plot using Dash.

Parameters:

• x (np.ndarray) – x-coordinates of the points.

• y (np.ndarray, optional) – y-coordinates of the points.

• z (np.ndarray, optional) – z-coordinates of the points.

• true_labels (np.ndarray, optional) – True labels for the points.

• cluster_labels (np.ndarray, optional) – Cluster labels for the points.

• point_visualization (Callable or str, optional) – Function or string specifying point visualization.

• marker_kwargs (dict, optional) – Keyword arguments for marker properties.

• scatter_kwargs (dict, optional) – Additional keyword arguments for the scatter plot.

• interact_mode (str) – Interaction mode, either “hover” or “click”.

• port (int, optional) – Port number for the Dash server.

• verbose (bool, optional) – Whether to print the address at which the Dash server is running. Defaults to False.

Returns:

A Dash application instance for the interactive plot.

Return type:

dash.Dash

class interdim.vis.InteractionPlot(data_source, plot_type='bar', trace_kwargs=None, layout_kwargs=None, format_data=True)

A class for creating interactive plots based on data points.

data_source

The source of data for plotting.

plot_type

The type of plot to create.

Type:

str

trace_kwargs

Additional keyword arguments for the trace.

Type:

dict

layout_kwargs

Additional keyword arguments for the layout.

Type:

dict

format_data

Whether to format the data before plotting.

Type:

bool

__init__(data_source, plot_type='bar', trace_kwargs=None, layout_kwargs=None, format_data=True)

Initialize the InteractionPlot object.

Parameters:

• data_source – The source of data for plotting.

• plot_type (str, optional) – The type of plot to create. Defaults to “bar”.

• trace_kwargs (dict, optional) – Additional keyword arguments for the trace.

• layout_kwargs (dict, optional) – Additional keyword arguments for the layout.

• format_data (bool, optional) – Whether to format the data before plotting. Defaults to True.

get_sample(index: int) → Any

Get a sample from the data source at the specified index.

Parameters:

index (int) – The index of the sample to retrieve.

Returns:

The retrieved sample.

Return type:

Any

Raises:

ValueError – If the data_source is not callable or indexable.