rsatoolbox.vis.scatter_plot module

rsatoolbox.vis.scatter_plot.show_2d(rdms: RDMs, method: str, weights: NDArray | None = None, rdm_descriptor: str | None = None, pattern_descriptor: str | None = None, icon_size: float = 0.1) → Figure

Draw a scatter plot of the RDMs reduced to two dimensions

Parameters:

• rdms (RDMs) – The RDMs object to display

• method (str) – One of ‘MDS’, ‘t-SNE’, ‘Isomap’.

• weights – Optional array of weights (vector per RDM)

• rdm_descriptor – (Optional[str]): If provided, this will be used as title for each individual RDM.

• pattern_descriptor (Optional[str]) – If provided, the chosen pattern descriptor will be printed adjacent to each point in the plot

• icon_size – relative size of icons if the pattern descriptor chosen is of type Icon

Returns:

A matplotlib figure in which the plot is drawn

Return type:

Figure

rsatoolbox.vis.scatter_plot.show_MDS(rdms: RDMs, weights: NDArray | None = None, rdm_descriptor: str | None = None, pattern_descriptor: str | None = None, icon_size: float = 0.1) → Figure

Draw a scatter plot based on Multidimensional Scaling dimensionality reduction

Parameters:

• rdms (RDMs) – The RDMs object to display

• weights – Optional array of weights (vector per RDM)

• rdm_descriptor – (Optional[str]): If provided, this will be used as title for each individual RDM.

• pattern_descriptor (Optional[str]) – If provided, the chosen pattern descriptor will be printed adjacent to each point in the plot

• icon_size – relative size of icons if the pattern descriptor chosen is of type Icon

Returns:

A matplotlib figure in which the plot is drawn

Return type:

Figure

rsatoolbox.vis.scatter_plot.show_iso(rdms: RDMs, rdm_descriptor: str | None = None, pattern_descriptor: str | None = None, icon_size: float = 0.1) → Figure

Draw a scatter plot based on Isomap dimensionality reduction

Parameters:

• rdms (RDMs) – The RDMs object to display

• rdm_descriptor – (Optional[str]): If provided, this will be used as title for each individual RDM.

• pattern_descriptor (Optional[str]) – If provided, the chosen pattern descriptor will be printed adjacent to each point in the plot

• icon_size – relative size of icons if the pattern descriptor chosen is of type Icon

Returns:

A matplotlib figure in which the plot is drawn

Return type:

Figure

rsatoolbox.vis.scatter_plot.show_scatter(rdms: RDMs, coords: NDArray, rdm_descriptor: str | None = None, pattern_descriptor: str | None = None, icon_size: float = 0.1) → Figure

Draw a 2-dimensional scatter plot based on the provided coordinates

Parameters:

• rdms (RDMs) – The RDMs object to display

• coords (NDArray) – Array of x and y coordinates for each pattern (patterns x 2)

• rdm_descriptor – (Optional[str]): If provided, this will be used as title for each individual RDM.

• pattern_descriptor (Optional[str]) – If provided, the chosen pattern descriptor will be printed adjacent to each point in the plot

• icon_size – relative size of icons if the pattern descriptor chosen is of type Icon

Returns:

A matplotlib figure in which the plot is drawn

Return type:

Figure

rsatoolbox.vis.scatter_plot.show_tSNE(rdms: RDMs, rdm_descriptor: str | None = None, pattern_descriptor: str | None = None, icon_size: float = 0.1) → Figure

Draw a scatter plot based on t-SNE dimensionality reduction

Parameters:

• rdms (RDMs) – The RDMs object to display

• rdm_descriptor – (Optional[str]): If provided, this will be used as title for each individual RDM.

• pattern_descriptor (Optional[str]) – If provided, the chosen pattern descriptor will be printed adjacent to each point in the plot

• icon_size – relative size of icons if the pattern descriptor chosen is of type Icon

Returns:

A matplotlib figure in which the plot is drawn

Return type:

Figure