DS004929: fnirs dataset, 12 subjects#

BallSqueezingHD

Access recordings and metadata through EEGDash.

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

Modality: fnirs Subjects: 12 Recordings: 36 License: CC0 Source: openneuro

Metadata: Complete (90%)

Quickstart#

Get Started

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)

Query & Filter

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'])

Cite This Dataset

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},
}

About This Dataset#

No README content is available for this dataset.

Dataset Information#

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

Found an issue with this dataset?

If you encounter any problems with this dataset (missing files, incorrect metadata, loading errors, etc.), please let us know!

Report an Issue on GitHub

Technical Details#

Subjects & recordings

Subjects: 12
Recordings: 36
Tasks: 1

Channels & sampling rate

Channels: 200
Sampling rate (Hz): 8.719308035714286
Duration (hours): Not calculated

Electrode Layout#

Electrode layout — fNIRS · 46 sensors — 46 channels

Dataset Statistics#

Channel counts: 200 ch (n=36 recordings)

Sampling frequencies: 8.719308035714286 Hz (n=36 recordings)

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.

HED event descriptors word cloud

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.

Files: —

Size: —

Subjects: —

Click to load file structure…

API Reference#

Use the DS004929 class to access this dataset programmatically.

class eegdash.dataset.DS004929(cache_dir: str, query: dict | None = None, s3_bucket: str | None = None, **kwargs)[source]#

Bases: EEGDashDataset

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)