Brain¶
-
class
nidmd.Brain(df1, order, coords_2d, df2=None)[source]
Constructor¶
-
Brain.__init__(df1, order, coords_2d, df2=None)[source]¶ Brain Constructor.
- Parameters
df1 (pd.DataFrame) – Pandas DataFrame containing at least
intensityandconjugatecolumns. Theintensitycolumn must contain Array-like values of the length of the cortical atlas.order (int) – Mode order
coords_2d (pd.DataFrame) – Pandas DataFrame containing the 2D corticial parcellation coordinates. These can be fetched from Decomposition.atlas.coords_2d
df2 (pd.DataFrame, optional) – Pandas DataFrame containing at least
intensityandconjugatecolumns Theintensitycolumn must contain Array-like values of the length of the cortical atlas.
Methods¶
|
Returns activity intensities of modes. |
|
Returns Plotly Figure. |
API reference¶
-
class
nidmd.Brain(df1, order, coords_2d, df2=None)[source]¶ -
figure(imag=False, colormap='coolwarm')[source]¶ Returns Plotly Figure.
- Parameters
imag (boolean, optional) – Incorporate brain visualizations for imaginary activity values (default False)
colormap (str) – Colormap supported by matplotlib, which can be found on the official reference
- Returns
fig – Plotly figure of brain visualizations
- Return type
go.Figure
-
static
intensities(modes, imag=False)[source]¶ Returns activity intensities of modes.
- Parameters
modes (pd.DataFrame) – Pandas DataFrame containing at least
intensityandconjugatecolumns. Theintensitycolumn must contain Array-like values of the length of the cortical atlas.imag (boolean, optional) – Retrieve the imaginary values from the activity intensities (default False)
- Returns
rows (list) – list of range from 0 number of figure subplots
intensity (list of Array-like) – Activity intensities for each mode
-