siibra.features.tabular.local_field_potential

Attributes

BASE_URL

Classes

`LocalFieldPotential`	Local field potential recording anchored to Waxholm coordinates and potentially a region.
`RegionalLocalFieldPotential`	Local field potential recording anchored to Waxholm region and a preselected spectrum type.

Module Contents

class siibra.features.tabular.local_field_potential.LocalFieldPotential(anchor: siibra.features.anchor.AnatomicalAnchor, db_entry: Dict)

Inheritance diagram of siibra.features.tabular.local_field_potential.LocalFieldPotential

Local field potential recording anchored to Waxholm coordinates and potentially a region.

get_lfp_file()

Fetch the local field potential data file.

Returns:: Open file handle returned by the HTTP request.
Return type:: h5-file-like
Raises:: MissingFileException – If no local field potential file is available for this entry.

get_motion_file()

Fetch the motion data file.

Returns:: Open file handle returned by the HTTP request.
Return type:: h5-file-like
Raises:: MissingFileException – If no motion file is available for this entry.

get_psd_file()

Fetch the power spectral density file.

Returns:: Open file handle returned by the HTTP request.
Return type:: h5-file-like
Raises:: MissingFileException – If no power spectral density file is available for this entry.

classmethod get_spectra(lfps: List[LocalFieldPotential])

Compute an average spectrum from local field potential features.

Parameters:: lfps (list of LocalFieldPotential) – Local field potential features to include in the spectrum.
Returns:: Average spectrum indexed by frequency.
Return type:: pandas.DataFrame

classmethod plot_spectra(lfps: List[LocalFieldPotential], backend='matplotlib', **kwargs)

Plot an average spectrum from local field potential features.

Parameters:

lfps (list of LocalFieldPotential) – Local field potential features to include in the spectrum.
backend (str, optional) – Plotting backend passed to pandas.DataFrame.plot(). The default is "matplotlib".
**kwargs – Additional keyword arguments passed to pandas.DataFrame.plot().

Returns:

Plot object returned by the selected pandas plotting backend.

Return type:

object

ID_TEMPLATE = '41673110-f3eb-43cd-9d9c-c845c6f0573c--{index}'

property coordinates

property name: Returns a short human-readable name of this feature.

property pathology

property pharmacology

property session

property signal_quality

property subject

class siibra.features.tabular.local_field_potential.RegionalLocalFieldPotential(anchor: siibra.features.anchor.AnatomicalAnchor, db_entries: pandas.DataFrame, pathology: str | None = None, pharmacology: str | None = None, signal_quality: str | None = None)

Inheritance diagram of siibra.features.tabular.local_field_potential.RegionalLocalFieldPotential

Local field potential recording anchored to Waxholm region and a preselected spectrum type.

plot(*args, backend='matplotlib', **kwargs)

Plot the average local field potential spectrum.

Parameters:

*args – Positional arguments passed to the parent plotting method.
backend (str, optional) – Plotting backend passed to the parent plotting method. The default is "matplotlib".
**kwargs – Additional keyword arguments passed to the parent plotting method.

Returns:

Plot object returned by the selected backend.

Return type:

object

ID_TEMPLATE = '41673110-f3eb-43cd-9d9c-c845c6f0573c--{indices_as_hex}'

property coordinates

property data

Compute the smoothed median spectra represented by this feature.

Returns:: Average spectra by type and indexed by frequency.
Return type:: pandas.DataFrame

Notes

Accessing this property downloads the required power spectral density files and recomputes the spectrum.

property name: Returns a short human-readable name of this feature.

pathology = None

pharmacology = None

property session

signal_quality = None

property subjects

siibra.features.tabular.local_field_potential.BASE_URL = 'https://data-proxy.ebrains.eu/api/v1/buckets/d-41673110-f3eb-43cd-9d9c-c845c6f0573c/{filepath}'