ddmra.plotting.plot_analysis

plot_analysis(data_points, distances, smoothing_curve, curve_distances, null_smoothing_curves, n_lines=50, metric_name=None, ylim=(- 0.5, 0.5), fig=None, ax=None)[source]

Generate plot for a DDMRA analysis.

Parameters

  • data_points (numpy.ndarray of shape (n_edges,)) – DDMRA-metric values for all unique ROI-to-ROI edges, not including self-self edges.

  • distances (numpy.ndarray of shape (n_edges,)) – All distances associated with data in data_points, in mm.

  • smoothing_curve (numpy.ndarray of shape (n_unique_edge_distances,)) – Smoothing curve of data points, produced using a moving average.

  • curve_distances (numpy.ndarray of shape (n_unique_edge_distances,)) – Edge distances, in mm, of data points in smoothing curve.

  • null_smoothing_curves (numpy.ndarray of shape (n_iters, n_unique_edge_distances)) – Smoothing curves for all permutations, to be used as a null distribution.

  • n_lines (int, optional) – Number of null smoothing curves to plot in the figure. Default is 50.

  • metric_name (None or str, optional) – Label for the Y-axis of the figure, indicating the analysis’ metric’s name.

  • ylim (tuple, optional) – Y-limits.

  • fig (None or matplotlib.pyplot.Figure, optional) – Figure object.

  • ax (None or matplotlib.pyplot.Axes, optional) – Axes object.

Returns

  • fig (matplotlib.pyplot.Figure) – Updated Figure object.

  • ax (matplotlib.pyplot.Axes) – Updated Axes object.