pybispectra.utils.ResultsCFC#
- class pybispectra.utils.ResultsCFC(data: ndarray, indices: tuple[tuple[int]], f1s: ndarray, f2s: ndarray, name: str = 'CFC')[source]#
Class for storing cross-frequency coupling (CFC) results.
- Parameters:
- data
ndarray
, shape of [nodes, low frequencies, high frequencies] Results to store.
- indices
tuple
oftuple
ofint
, length of 2 Indices of the channels for each connection of the results. Should contain two tuples of equal length for the seed and target indices, respectively.
- f1s
ndarray
, shape of [low frequencies] Low frequencies (in Hz) in the results.
- f2s
ndarray
, shape of [high frequencies] High frequencies (in Hz) in the results.
- name
str
(default"CFC"
) Name of the results being stored.
- data
- Attributes:
- name
str
Name of the results.
- indices
tuple
oftuple
ofint
, length of 2 Indices of the channels for each connection of the results. Should contain two tuples of equal length for the seed and target indices, respectively.
- shape
tuple
ofint
Shape of the results i.e. [nodes, low frequencies, high frequencies].
- n_nodes
int
Number of connections in the the results.
- f1s
ndarray
, shape of [low frequencies] Low frequencies (in Hz) in the results.
- f2s
ndarray
, shape of [high frequencies] High frequencies (in Hz) in the results.
- name
Methods
get_results
([form])Return a copy of the results.
plot
([nodes, f1s, f2s, n_rows, n_cols, ...])Plot the results.
- get_results(form: str = 'raveled') ndarray | tuple[ndarray, tuple[tuple[int]]] [source]#
Return a copy of the results.
- Parameters:
- form
str
(default"raveled"
) How the results should be returned:
"raveled"
- results have shape [nodes, …];"compact"
- results have shape[seeds, targets, ...]
, where...
represents the data dimensions (e.g. frequencies, times).
- form
- Returns:
- plot(nodes: int | tuple[int] | None = None, f1s: tuple[int | float] | None = None, f2s: tuple[int | float] | None = None, n_rows: int = 1, n_cols: int = 1, major_tick_intervals: int | float = 5.0, minor_tick_intervals: int | float = 1.0, cbar_range: tuple[float] | list[tuple[float]] | None = None, show: bool = True) tuple[list[Figure], list[ndarray]] [source]#
Plot the results.
- Parameters:
- nodes
int
|tuple
ofint
|None
(defaultNone
) Indices of connections to plot. If
None
, plot all connections.- f1s
tuple
ofint
orfloat
|None
(defaultNone
) Start and end low frequencies of the results to plot, respectively. If
None
, all low frequencies are plotted.- f2s
tuple
ofint
orfloat
|None
(defaultNone
) Start and end high frequencies of the results to plot, respectively. If
None
, all high frequencies are plotted.- n_rows
int
(default1
) Number of rows of subplots per figure.
- n_cols
int
(default1
) Number of columns of subplots per figure.
- major_tick_intervals
int
|float
(default5.0
) Intervals (in Hz) at which the major ticks of the x- and y-axes should occur.
- minor_tick_intervals
int
|float
(default1.0
) Intervals (in Hz) at which the minor ticks of the x- and y-axes should occur.
- cbar_range
tuple
offloat
|list
oftuple
offloat
|None
(defaultNone
) Range (in units of the data) for the colourbars, consisting of the lower and upper limits, respectively. If
None
, the range is computed automatically. If a tuple of float, this range is used for all plots. If a list of tuple of float, the ranges are used for each individual plot.- show
bool
(defaultTrue
) Whether or not to show the plotted results.
- nodes
- Returns:
- figures
list
of matplotlibFigure
Figures of the results in a list of length
ceil(n_nodes / (n_rows * n_cols))
.- axes
list
ofndarray
of matplotlib pyplotAxes
Subplot axes for the results in a list of length
ceil(n_nodes / (n_rows * n_cols))
where each entry is a 1Dnumpy.ndarray
of length(n_rows * n_cols)
.
- figures
Notes
n_rows
andn_cols
of1
will plot the results for each connection on a new figure.