moabb.datasets.base.LocalBIDSDataset

class moabb.datasets.base.LocalBIDSDataset(bids_root: Path | str, path_search_params: dict[str, Any] | None = None, read_extra_params: dict[str, Any] | None = None, *, subjects: list[int] | None = None, sessions_per_subject: int | None = None, events, code='LocalBIDSDataset-', interval, paradigm, doi=None, unit_factor=1000000.0)

Generic local/private BIDS datasets.

This class is useful if you have a local/private dataset in BIDS format and you want to use it with MOABB, without having to create a new dataset class.

Parameters:

• bids_root (str | Path) – Local path to the root of the BIDS dataset.

• path_search_params (dict[str, Any] | None) – Additional kwargs for the mne_bids.find_matching_paths() function.

• read_extra_params (dict[str, Any] | None) – Additional kwargs for the mne_bids.read_raw_bids() function.

• subjects (list[int] | None) – Optional list of subjects. If None, the subjects are inferred from the dataset.

• sessions_per_subject (int | None) – Optional number of sessions per subject. If None, the number is inferred from the dataset.

• events (dict[str, str]) – String codes for events matched with labels in the stim channel.

• interval (list with 2 entries) – Imagery interval as defined in the dataset description.

• paradigm (str) – Defines what sort of dataset this is.

• doi (str | None) – Optional DOI for dataset.

• code (str) – Unique identifier for the dataset. for compatibility reasons, it should start with "LocalBIDSDataset"

• unit_factor (float) – Factor to convert units to microvolts (default: 1e6).