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

ENH: add HeudiconvVersion to sidecar .json files #529

Merged
merged 1 commit into from
Oct 28, 2021

Commits on Oct 11, 2021

  1. ENH: add HeudiconvVersion to sidecar .json files

    Unfortunately there is no convention yet in BIDS on storing such information in
    a standardized way.
    
    bids-standard/bids-specification#440
     proposes to add GeneratedBy (within dataset_description.json)
     which could provide detailed high level information which should then be
     consistent through out dataset (so we would need to add safeguards)
    
    bids-standard/bids-specification#487
     is WiP to introduce PROV into BIDS standard, which would allow to establish
     _prov.json with all needed gory details.
    
    For now, since fields in side car .json files are not strictly regulated,
    I think it would be benefitial to user to have heudiconv version stored there
    along with other "Version" fields, such as
    
    	$> grep -e Version -e dcm2ni fmap/sub-phantom1sid1_ses-localizer_acq-3mm_phasediff.json
    	  "ConversionSoftware": "dcm2niix",
    	  "ConversionSoftwareVersion": "v1.0.20211006",
    	  "SoftwareVersions": "syngo MR E11",
    
    and although strictly speaking Heudiconv is a "conversion software", since
    dcm2niix decided to use that pair, I have decided to leave it alone and just
    come up with yet another descriptive key
    
      "HeudiconvVersion": "0.10.0",
    yarikoptic committed Oct 11, 2021
    Configuration menu
    Copy the full SHA
    ee0dcb0 View commit details
    Browse the repository at this point in the history