EEGdash›OpenNeuro›DS004929
Iss. 4929 · 12 subjects · 36 recordings · CC0
Dataset Brief · BallSqueezingHD

DS004929: fnirs dataset, 12 subjects#

BallSqueezingHD

Citation: Yuanyuan Gao, De’Ja Rogers, Alexander von Lühmann, Antonio Ortega-Martinez, David A. Boas, Meryem A. Yücel (2024). BallSqueezingHD. 10.18112/openneuro.ds004929.v1.0.0

12-participant fNIRS dataset — BallSqueezingHD.

Data & curation Yuanyuan Gao · De’Ja Rogers · Alexander von Lühmann · Antonio Ortega-Martinez · David A. Boas · Meryem A. Yücel
Senior author Meryem A. Yücel
Year 2024 · Distributed via OpenNeuro
Funding NIH BRAIN Initiative (Grant No. 1U01EB029856-01)
fNIRS · 200 ch9 HzBIDS 1.7.1Task · BallSqueezingMotorMotor
Layer 01Study
What was asked
Hypothesis, independent & dependent variables, paradigm, cohort, and the editorial caveats around what the recordings can and cannot answer.
Layer 02Signal · BIDS
What was recorded
Sidecars, channels & electrodes, coordinate system, event semantics, and quality stats from the NEMAR pipeline when available.
Layer 03Training · ML
What you can train on
Recommended access modes — MNE Raw, braindecode windows, PyTorch DataLoader — plus the targets the metadata makes addressable.
§ 01Access · Get started

Quickstart#

Install

pip install eegdash

Access the data

from eegdash.dataset import DS004929

dataset = DS004929(cache_dir="./data")
# Get the raw object of the first recording
raw = dataset.datasets[0].raw
print(raw.info)

Filter by subject

dataset = DS004929(cache_dir="./data", subject="01")

Advanced query

dataset = DS004929(
    cache_dir="./data",
    query={"subject": {"$in": ["01", "02"]}},
)

Iterate recordings

for rec in dataset:
    print(rec.subject, rec.raw.info['sfreq'])

If you use this dataset in your research, please cite the original authors.

BibTeX

@dataset{ds004929,
  title = {BallSqueezingHD},
  author = {Yuanyuan Gao and De’Ja Rogers and Alexander von Lühmann and Antonio Ortega-Martinez and David A. Boas and Meryem A. Yücel},
  doi = {10.18112/openneuro.ds004929.v1.0.0},
  url = {https://doi.org/10.18112/openneuro.ds004929.v1.0.0},
}
§ 02Study · The README

About This Dataset#

No README content is available for this dataset.

§ 03Cohort · Participants

Cohort#

Dataset Statistics#

Channel counts: 200 ch (n=36 recordings)

Sampling frequencies: 8.719308035714286 Hz (n=36 recordings)

§ 04Signal · Electrodes & trace

Signal · Electrodes & live trace#

Fig. 01 Signal & montage 200 ch · fNIRS · 9 Hz · 12 subjects, 36 recordings
Electrode layout — fNIRS · 46 sensors — 46 channels

NEMAR Processing Statistics#

The plots below are generated by NEMAR’s automated EEG pipeline. The histogram shows pipeline success for data cleaning and ICA decomposition, the percentage of data frames and EEG channels retained after artefact removal, line noise per channel (RMS, dB), and the age/gender distribution of participants.

NEMAR pipeline statistics — DS004929
HED event descriptors word cloud HED event descriptors word cloud — DS004929
§ 05Manifest · BIDS tree

Manifest#

File Explorer#

Browse the BIDS file structure of this dataset. Records are fetched on demand from the EEGDash catalog the first time you open the explorer.

Recordings—
Files—
Subjects—
Modalities—
Click to load file structure…
Full dataset metadata table

Dataset ID

DS004929

Title

BallSqueezingHD

Author (year)

Gao2024

Canonical

—

Importable as

DS004929, Gao2024

Year

2024

Authors

Yuanyuan Gao, De’Ja Rogers, Alexander von Lühmann, Antonio Ortega-Martinez, David A. Boas, Meryem A. Yücel

License

CC0

Citation / DOI

doi:10.18112/openneuro.ds004929.v1.0.0

Source links

OpenNeuro | NeMAR | Source URL
Copy-paste BibTeX
@dataset{ds004929,
  title = {BallSqueezingHD},
  author = {Yuanyuan Gao and De’Ja Rogers and Alexander von Lühmann and Antonio Ortega-Martinez and David A. Boas and Meryem A. Yücel},
  doi = {10.18112/openneuro.ds004929.v1.0.0},
  url = {https://doi.org/10.18112/openneuro.ds004929.v1.0.0},
}
§ 06API · Programmatic access

API Reference#

Signature
eegdash.dataset
class
eegdash.dataset.DS004929(cache_dir, query=None, s3_bucket=None, **kwargs)
Bases: EEGDashDataset
Author (year)Gao2024
Canonical—
Importable asDS004929 · Gao2024
Sourceeegdash/dataset/registry.py · [source ↗]
class eegdash.dataset.DS004929(cache_dir: str, query: dict | None = None, s3_bucket: str | None = None, **kwargs)[source]#

BallSqueezingHD

Study:

ds004929 (OpenNeuro)

Author (year):

Gao2024

Canonical:

—

Also importable as: DS004929, Gao2024.

Modality: fnirs; Experiment type: Motor; Subject type: Unknown. Subjects: 12; recordings: 36; tasks: 1.

Parameters:

  • cache_dir (str | Path) – Directory where data are cached locally.

  • query (dict | None) – Additional MongoDB-style filters to AND with the dataset selection. Must not contain the key dataset.

  • s3_bucket (str | None) – Base S3 bucket used to locate the data.

  • **kwargs (dict) – Additional keyword arguments forwarded to EEGDashDataset.

data_dir#

Local dataset cache directory (cache_dir / dataset_id).

Type:

Path

query#

Merged query with the dataset filter applied.

Type:

dict

records#

Metadata records used to build the dataset, if pre-fetched.

Type:

list[dict] | None

Notes

Each item is a recording; recording-level metadata are available via dataset.description. query supports MongoDB-style filters on fields in ALLOWED_QUERY_FIELDS and is combined with the dataset filter. Dataset-specific caveats are not provided in the summary metadata.

References

OpenNeuro dataset: https://openneuro.org/datasets/ds004929 NeMAR dataset: https://nemar.org/dataexplorer/detail?dataset_id=ds004929 DOI: https://doi.org/10.18112/openneuro.ds004929.v1.0.0

Examples

>>> from eegdash.dataset import DS004929
>>> dataset = DS004929(cache_dir="./data")
>>> recording = dataset[0]
>>> raw = recording.load()
__init__(cache_dir: str, query: dict | None = None, s3_bucket: str | None = None, **kwargs)[source]#
save(path: str, overwrite: bool = False, offset: int = 0)[source]#

Save datasets to files by creating one subdirectory for each dataset:

path/
    0/
        0-raw.fif | 0-epo.fif
        description.json
        raw_preproc_kwargs.json (if raws were preprocessed)
        window_kwargs.json (if this is a windowed dataset)
        window_preproc_kwargs.json  (if windows were preprocessed)
        target_name.json (if target_name is not None and dataset is raw)
    1/
        1-raw.fif | 1-epo.fif
        description.json
        raw_preproc_kwargs.json (if raws were preprocessed)
        window_kwargs.json (if this is a windowed dataset)
        window_preproc_kwargs.json  (if windows were preprocessed)
        target_name.json (if target_name is not None and dataset is raw)
Parameters:

  • path (str) –

    Directory in which subdirectories are created to store

    -raw.fif | -epo.fif and .json files to.

  • overwrite (bool) – Whether to delete old subdirectories that will be saved to in this call.

  • offset (int) – If provided, the integer is added to the id of the dataset in the concat. This is useful in the setting of very large datasets, where one dataset has to be processed and saved at a time to account for its original position.

Access modesMNE → braindecode → PyTorch → ML
.rawMNE Raw object — standard tools (filter, epoch, ICA, plot_psd).mne
BaseConcatDatasetEach record is a lazy BaseDataset from braindecode — windowed via create_windows_from_events.braindecode
DataLoaderWraps the windowed dataset into a PyTorch DataLoader; supports parallel workers and on-the-fly augmentations.pytorch
Zarr cacheOptional braindecode Zarr mirror for fast resume; persisted to cache_dir.zarr
Hugging FacePre-bundled mirror at EEGDash/ds004929 · pull with datasets.load_dataset("EEGDash/ds004929").huggingface
Croissant 1.0Machine-readable JSON-LD descriptor — DS004929.croissant.json (MLCommons schema, ingestible by PyTorch / TensorFlow / JAX).mlcommons
Examples using EEGDashcurated · start here
Find datasets with the EEGDash APIQuery the catalogue, filter by task or modality, list candidates.Load one EEG recordingResolve a single record to an MNE Raw with channels and events.EEG recording to PyTorch DataLoaderWrap braindecode windows in a DataLoader for model training.Preprocess EEG and create windowsFilter, resample, epoch — and persist the windowed dataset.Save and reload prepared dataCache a windowed dataset to disk and reattach it without recompute.Download a dataset locallyPrefetch BIDS files to a local cache and validate the layout.

Swap any load_dataset(...) call for ds004929 to reproduce the tutorial on this dataset.

Citation

Yuanyuan Gao, De’Ja Rogers, Alexander von Lühmann, Antonio Ortega-Martinez, David A. Boas, … (2024). BallSqueezingHD. 10.18112/openneuro.ds004929.v1.0.0

Provenance

¹Contributed to openneuro in BIDS format.

²Curated & ingested by the EEGDash catalog; see CITATION.cff for canonical reference.

³Persistent identifier: 10.18112/openneuro.ds004929.v1.0.0.

BIDS
BIDS 1.7.1
Sidecars
not yet probed
Machine-readable
schema.org/Dataset · Croissant

See Also#