DS004929#

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
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): 0.0

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

OpenNeuro dataset ds004929. Modality: fnirs; Experiment type: Unknown; Subject type: Unknown. Subjects: 13; recordings: 233; 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

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, overwrite=False)[source]#

Save the dataset to disk.

Parameters:

path (str or Path) – Destination file path.
overwrite (bool, default False) – If True, overwrite existing file.

Return type:

None