Skip to content

New "associations" metadata #431

@oesteban

Description

@oesteban

Add a new attribute to BIDSFile with a list of files associated to this particular BIDSFile. Files listed here are, for instance:

  • Events files and physio files corresponding to a particular functional run
  • bvecs/bvals tables corresponding to a dwi image
  • Any valid path with IntendedFor metadata pointing to this hit (e.g. fieldmaps).

The idea would be to minimize subsequent queries to the layout, and having a quick glimpse at the involvement of this hit in the context of the full dataset.

If this feature can be time consuming, then it could be protected by a return_associations argument to get, which would be False by default.

What do you guys think? I could work on this if you see it useful.

Proposed associations

  • BOLD runs:

    • events, stim, physio.
    • fieldmaps/EPIs with IntendedFor pointers
    • SBRefs with matching names (i.e. sub-01_sbref.nii.gz would match all tasks, although this is unclear in the specs at the moment) or IntendedFor field (this IntendedFor is not in the spec at the moment, but I would submit a PR to have it).
    • other echoes of ME-EPI
  • DWI runs:

    • bvecs and bvals
    • Matching B0s
    • Matching SBRefs
    • fieldmaps/EPIs with IntendedFor pointers
  • Multiecho anats:

    • Matching echoes.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions