siibra.features.tabular.regional_timeseries_activity

Classes

RegionalBOLD	Blood-oxygen-level-dependent (BOLD) signals per region.
RegionalTimeseriesActivity	Datasets that provide regional activity over time.

Module Contents

class siibra.features.tabular.regional_timeseries_activity.RegionalBOLD(cohort: str, modality: str, regions: list, connector: siibra.retrieval.repositories.RepositoryConnector, decode_func: Callable, files: Dict[str, str], anchor: siibra.features.anchor.AnatomicalAnchor, timestep: str, description: str = '', datasets: list = [], paradigm: str = '', prerelease: bool = False, id: str = None)

Blood-oxygen-level-dependent (BOLD) signals per region.

class siibra.features.tabular.regional_timeseries_activity.RegionalTimeseriesActivity(cohort: str, modality: str, regions: list, connector: siibra.retrieval.repositories.RepositoryConnector, decode_func: Callable, files: Dict[str, str], anchor: siibra.features.anchor.AnatomicalAnchor, timestep: str, description: str = '', datasets: list = [], paradigm: str = '', prerelease: bool = False, id: str = None)

Datasets that provide regional activity over time.

compute_centroids(space)

Computes the list of centroid coordinates corresponding to dataframe columns, in the given reference space.

Parameters:

space (Space, str) –

Return type:

list[tuple(float, float, float)]

get_table(subject: str = None)

Returns a pandas dataframe where the column headers are regions and the indcies indicate disctrete timesteps.

Parameters:

subject (str, default: None) – Name of the subject (see RegionalTimeseriesActivity.subjects for available names). If None, the mean is taken in case of multiple available data tables.

Returns:

A table with region names as the column and timesteps as indices.

Return type:

pd.DataFrame

plot(subject: str = None, regions: List[str] = None, *args, backend='matplotlib', **kwargs)

Create a bar plot of averaged timeseries data per region.

Parameters:

• regions (str, Region) –

• subject (str, default: None) – If None, returns the subject averaged table.

• kwargs (args and) – takes arguments and keyword arguments for the desired plotting backend.

plot_carpet(subject: str = None, regions: List[str] = None, *args, backend='plotly', **kwargs)

Create a carpet plot ofthe timeseries data per region.

Parameters:

• regions (str, Region) –

• subject (str, default: None) – If None, returns the subject averaged table.

• kwargs (args and) – takes arguments and keyword arguments for plotly.express.imshow

DESCRIPTION = ''

cohort

property name

Returns a short human-readable name of this feature.

paradigm = ''

regions

property subjects

Returns the subject identifiers for which signal tables are available.

timestep