Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] Rename "Unit" metadata to "Units" for consistency with existing fields #773

Merged
merged 2 commits into from
Apr 13, 2021

Conversation

effigies
Copy link
Collaborator

As noted in #622 (comment), we previously had in anatomy imaging data:

Phase images MAY be in radians or in arbitrary units.
The sidecar JSON file MUST include the units of the `phase` image.
The possible options are `rad` or `arbitrary`.
For example:
sub-01_part-phase_T1w.json
```Text
{
"Units": "rad"
}
```

Given that this metadata field has the same intent, to describe the interpretation of voxel values in an imaging file, we should be consistent.

@mnoergaard @melanieganz I do not know if this means we should also change, e.g., InjectedMassUnit.

@tsalo I notice that we don't seem to have this field in a metadata table anywhere. Do you have a suggestion of where to add it?

@tsalo
Copy link
Member

tsalo commented Apr 12, 2021

@tsalo I notice that we don't seem to have this field in a metadata table anywhere. Do you have a suggestion of where to add it?

In many cases, suffixes are restricted to one specific unit (usually "arbitrary"). I'll need to dig around to see which suffixes (or entity-value combinations) allow "Units".

@sappelhoff
Copy link
Member

@mnoergaard @melanieganz I do not know if this means we should also change, e.g., InjectedMassUnit.

that'd sound better (more consistent) to me.

@mnoergaard
Copy link
Collaborator

mnoergaard commented Apr 13, 2021

I am also fine with this (for all names including units). I will go ahead and update the example data sets and the validator.

validator (using code suggestions): bids-standard/bids-validator@866049d (and following commits)
examples : bids-standard/bids-examples#269

Copy link
Collaborator Author

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Full list of changed fields:

  • Units
  • InjectedRadioactivityUnits
  • InjectedMassUnits
  • SpecificRadioactivityUnits
  • TracerMolecularWeightUnits
  • InjectedMassPerWeightUnits
  • MolarActivityUnits
  • InfusionSpeedUnits
  • PharmaceuticalDoseUnits
  • ReconMethodParameterUnits

sappelhoff added a commit to bids-standard/bids-validator that referenced this pull request Apr 13, 2021
…cation#773

Co-authored-by: Martin Norgaard <martin.noergaard@nru.dk>
@effigies
Copy link
Collaborator Author

Can we get a second review?

@mnoergaard mnoergaard merged commit acedf22 into bids-standard:master Apr 13, 2021
@effigies effigies deleted the fix/unit branch April 13, 2021 14:06
@effigies effigies added this to the 1.6.0 milestone Apr 29, 2021
@sappelhoff sappelhoff changed the title FIX: Rename "Unit" metadata to "Units" for consistency with existing fields [FIX] Rename "Unit" metadata to "Units" for consistency with existing fields May 7, 2021
rob-luke pushed a commit to rob-luke/bids-validator that referenced this pull request Jan 31, 2022
…cation#773

Co-authored-by: Martin Norgaard <martin.noergaard@nru.dk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants