PlotDefaults#

class neurocaps.utils.PlotDefaults[source]#

Container class for default plotting customization parameters for multiple functions with plotting capabilities.

Examples

View defaults for a specific method:

>>> from neurocaps.analysis import PlotDefaults
>>> plot_kwargs = PlotDefaults.caps2plot()
>>> print(plot_kwargs["dpi"])  # 300

Modify defaults priot to plotting:

>>> from neurocaps.analysis import CAP
>>> cap_analysis = CAP()
>>> cap_analysis.get_caps(subject_timeseries=subject_timeseries, n_clusters=2)
>>> plot_kwargs = PlotDefaults.caps2plot()
>>> plot_kwargs["cmap"] = "viridis"
>>> plot_kwargs["dpi"] = 600
>>> cap.caps2plot(**plot_kwargs)

See all available plotting methods:

>>> PlotDefaults.available_methods()
['caps2corr', 'caps2plot', 'caps2radar', 'caps2surf', 'get_caps', 'transition_matrix', 'visualize_bold']

Methods

`available_methods`	Returns a list of all available plotting default methods.
`caps2corr`	Plotting defaults for `CAP.caps2corr`.
`caps2plot`	Plotting defaults for `CAP.caps2plot`.
`caps2radar`	Plotting defaults for `CAP.caps2radar`.
`caps2surf`	Plotting defaults for `CAP.caps2surf`.
`get_caps`	Plotting defaults for `CAP.get_caps`.
`transition_matrix`	Plotting defaults for `transition_matrix`.
`visualize_bold`	Plotting defaults for `TimeseriesExtractor.visualize_bold`.