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] BEP001 - RepetitionTimeExcitation and RepetitionTimePreparation #671

Merged
merged 12 commits into from
Dec 1, 2020

Conversation

agahkarakuzu
Copy link
Contributor


Headnote

A while ago we started #508, where you can find information on the overall purpose of BEP001. The PR #508 was closed as discussions called for some major revisions and to split BEP001 pull requests into manageable parts.


Dear BIDS community,

The current definition of the RepetitionTime field was subject to a long discussion, because:

  1. The definition of the term is specific to the task imaging data; therefore, not applicable for other MRI modalities that are not designed to collect volumetric data within a single TR.
  2. If made to the current RepetitionTime field, the change required by (1) would break retro-compatibility for the main user-base of the BIDS.

To have best of both worlds, we came up with a solution by introducing 2 more metadata fields: RepetitionTimeExcitation and RepetitionTimePreparation. These definitions i) do not interfere with the current definition of the RepetitionTime, retaining compatibility with massive amount of fMRI data and ii) cover the basis for simple (e.g. T1w) or more complex MRI acquisitions (e.g. MP2RAGE) with proper definitions.

In this Part-2 of BEP001 pull requests, we propose including these metadata fields to enable new anatomy imaging applications without affecting the existing datasets. In a recent meeting, we also realized that these definitions can be useful for the BEP005 team, hence pinging #669.

Big thanks to @KirstieJane for carefully adjusting the wording in these suggested changes and to @mathieuboudreau for his help with the terms.

On behalf of the BEP001 core team:

Gilles de Hollander (@Gilles86), Alberto Lazari (@lazaral), Christophe Phillips (@ChristophePhillips), Kirstie Whitaker (@KirstieJane), Tibor Auer (@tiborauer).

Best regards.

- Include RepetitionTimePreparation
- Include RepetitionTimeExcitation
- Add explanation on the former RepetitionTime field.
@agahkarakuzu agahkarakuzu changed the title [ENH] BEP001 - RepetitionTimeExcitation and RepetitionTimePreparation [ENH] BEP001 - RepetitionTimeExcitation and RepetitionTimePreparation Nov 16, 2020
@tsalo
Copy link
Member

tsalo commented Nov 16, 2020

I understand why this proposal is necessary for BIDS 1.X, but, to clarify, would this change be adequately superseded in BIDS 2.0 by the proposal in bids-standard/bids-2-devel#18? I think it's important that we have a corresponding proposal for a cleaner, backwards-incompatible definition of RepetitionTime that works for all groups for 2.0, even if 2.0 won't be released any time soon.

@agahkarakuzu
Copy link
Contributor Author

agahkarakuzu commented Nov 16, 2020

@tsalo when backwards compatibility is no longer an issue, replacing RepetitionTime definition with that of RepetitionTimeExcitation (with minor edits to generalize) and declaring RepetitionTimeExcitation as deprecated would solve it.

On the other hand, RepetitionTimePreparation would still be needed. It would only require it to be used together with RepetitionTime instead of RepetitionTimeExcitation.

@tsalo
Copy link
Member

tsalo commented Nov 16, 2020

Thank you for the clarification. Assuming this is merged with minimal changes, we should make sure that plan is reflected in the bids-2-devel issue.

Copy link
Collaborator

@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.

LGTM, just reformatting to specify the requirement level and data type in separate columns. We're also going to need to update the table fences in both tables to satisfy the linter.

…ata.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Copy link
Collaborator

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

Makes sense to me.

Copy link
Collaborator

@patsycle patsycle left a comment

Choose a reason for hiding this comment

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

Nice addition! I noticed that only a 'number' is allowed, why not an array of numbers? For example, that would be prefered for BEP005 (asl), but I assume this might be the case for other extensions?

@agahkarakuzu
Copy link
Contributor Author

agahkarakuzu commented Nov 17, 2020

@patsycle so far we discussed about the metadata fields that will have an associated entity such as flip and echo. Array option will be inserted somewhere in BEP001 PRs, where exactly that information is going to be inserted is also a question for BIDS maintainers.

Should it be under Data Type column in the table, given as number OR array of numbers ?

Wherever that information is going to be, it should be clear that it is a convenience for ASL data, not a generic approach. Because generic approach should call for minimal or no modification to the core definitions/types, I think. Therefore file collections would be the first venue for future applications to look for when adding an application that depends on collecting data with multiple parameters. This was another reason why BEP001 was designed more like a decorator rather than modifying common parameters/types to achieve desired outputs.

@patsycle
Copy link
Collaborator

@agahkarakuzu Indeed, I guess this is under DataType as this is already the case for SliceTiming and VolumeTiming. We will take a look at it already and we can further discuss on Friday.

@Gilles86
Copy link
Contributor

@patsycle, I would like to stress that both SliceTiming and VolumeTiming contain arrays that pertain to parameters that necessarily have to be arrays. By definition, they cannot be a single number. This is very different for the RepetitionTime-fields, as well as all almost other fields in this table. By default, they are defined over all Volumes/Slices. This default easily reaches the 80/20-rule.

I would like to warn against now generalizing all number-fields in this table to array of numbers or even number OR array of numbers, just to accommodate ASL acquisitions. If we choose that road, what do we do with the SliceTiming? Do we put array of numbers OR array of array of numbers there, just in case the timing of the slices changes from volume to volume?

And what about the validator? Does it now have to check every single field in the json-sidecar against the number of volumes in the nifti-file?

We already have a mechanism for iterations over parameters with the echo-<echo>, flip-<flip angle>, etc key-value pairs. By making things so flexible as number OR array-of-numbers, we introduce a lot of ambiguity into the standard and this is exactly what we want to avoid.

I appreciate that the ASL-community would like to stick to their standard practice and put volumes with different acquisition parameters in the same 4D nifti-file and I think we should try to accommodate this within BIDS, to aid broad adoption. However, I don't think practices in ASL should dictate practices in the rest of the field of (q)MRI. Especially not if we just spend 3+ years working out that such a practice leads to problematic edge cases in multiple domains (e.g., when you iterate over more than one parameter like in MPM or MP2RAGE-ME) and hardens the life of BIDS-app developers (if there are multiple ways to store a MP2RAGE in BIDS-format, most of your development time is gonna be invested in very bug-sensitive bookkeeping code).

Can't we make special cases for the fields where this is absolutely necessary for ASL in the table you put under *_asl.json file in your pull request?

@effigies effigies added this to the 1.5.0 milestone Nov 20, 2020
@effigies
Copy link
Collaborator

Created bids-bep001#5 to suggest language for variable RTE/RTP. There was discussion about whether this would be enough to make it clear that qMRI sequences ought to parameterize their volumes by filename rather than metadata, so I would appreciate suggestions for additional language.

@patsycle
Copy link
Collaborator

@agahkarakuzu @effigies Probably stupid question, but what are the next steps for this? I guess Agah has to move the suggestions from bids-bep001#5 to here. And after that? Will this one be merged at the same time as BEP005 or will it first go into BEP005?

@effigies
Copy link
Collaborator

@patsycle I would suggest merging this into master, not into BEP-005, when it's ready. But BEP-005 should proceed as if this is merged, to avoid having to wait on it. (If it's useful to merge into BEP-005 so that the document can be read as a whole, that's fine, too.)

@agahkarakuzu
Copy link
Contributor Author

@patsycle I will move my commits from bids-bep005 pull request to here soon. But I think the changes you can make to the FlipAngle and EchoTime on BEP005 are independent from these changes time- and practice-wise. We are aiming that when both #671 and #652 are merged, there is a coherent language/convention.

@patsycle
Copy link
Collaborator

@effigies @agahkarakuzu Good, thanks for the information. Agah, I added your suggestions for FlipAngle and EchoTime in BEP005.

@agahkarakuzu
Copy link
Contributor Author

Thank you @patsycle! Happy that now we have archetype definitions in the main text to clarify when and which convention applies.

Copy link
Collaborator

@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.

A couple very quick thoughts and a question. I'll look again more thoroughly ASAP.

Copy link
Collaborator

@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.

Since only RTP needs to have an array, I think this looks good as-is. Please consider the rewording suggestions for "interval", but otherwise I think this is very clear.

agahkarakuzu and others added 2 commits December 1, 2020 14:57
…ata.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
…ata.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

The link check failure is due to the as of yet missing ASL link: [ASL](#arterial-spin-labeling-perfusion-data)

I'd be fine merging this, given that we are planning to merge ASL very soon and that apart from qMRI and ASL, not many other PRs are expected to be worked on these days.

@effigies effigies merged commit ad73668 into bids-standard:master Dec 1, 2020
@sappelhoff sappelhoff deleted the TR-enhancement branch December 1, 2020 20:24
sappelhoff added a commit that referenced this pull request Dec 2, 2020
* [DOC] Auto-generate changelog entry for PR #677

* [ENH] BEP001 - New entities: inv & mt (#681)

* add entity inv

* add mt:

* add MT specific metadata

* Generate entity.md

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* Update src/schema/entities.yaml

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* table fix by @sappelhoff

* Conditional requirement

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* [ENH] BEP001 - Entity-linked file collections (#688)

* Squashed commit of the following:

commit 8e1ac5f
Author: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Date:   Fri Nov 27 11:09:24 2020 +0100

    fix links and latin

commit 27c9b41
Author: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Date:   Fri Nov 27 10:03:51 2020 +0100

    remove latin

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit 7d87070
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:46:47 2020 -0500

    Update src/99-appendices/10-file-collections.md

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit b137a9e
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:45:19 2020 -0500

    Update src/02-common-principles.md

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit d7897b8
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:44:40 2020 -0500

    Update src/02-common-principles.md

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit 09e9d32
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:44:15 2020 -0500

    Commit suggestion

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit 009a9ab
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:43:00 2020 -0500

    Add file-collecitons appendix to the TOC

commit 8f6c4df
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:41:13 2020 -0500

    Address suggestion by @tsalo

commit 45210a9
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Wed Nov 11 14:32:20 2020 -0500

    Wording

commit 66ba5a5
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Wed Nov 11 14:31:40 2020 -0500

    RECOMMENDED --> MUST for adding an application def to the appdx

commit 5611fac
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Wed Nov 11 14:29:21 2020 -0500

    Improve the appendix

commit 6d3bbea
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Mon Nov 2 16:12:04 2020 -0500

    Address suggestions by @tsalo

commit bcb0223
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Tue Oct 27 21:37:26 2020 -0400

    [ADD] Link to the appendix

commit 44e760f
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Tue Oct 27 21:28:38 2020 -0400

    [ADD] Appendix - File collections

    - For parametrically linked file collections

commit 523b1c1
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Tue Oct 27 21:27:52 2020 -0400

    [ADD] Parametrically linked file collections

    - Description

* ENH: Link to all BEP-001 entities

* STY: Escape asterisk, adjust table widths

* Add suggestions by @sappelhoff

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/99-appendices/10-file-collections.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Thank you @effigies!

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

Co-authored-by: Agah Karakuzu <agahkarakuzu@gmail.com>

* [ENH] BEP001 - RepetitionTimeExcitation and RepetitionTimePreparation (#671)

* [ENH] Improve TR definitions

- Include RepetitionTimePreparation
- Include RepetitionTimeExcitation
- Add explanation on the former RepetitionTime field.

* Typo

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* ENH: Allow for variable RTE/P

* STY: Update table widths

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

* Change ref to DOI @Remi-Gau

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update config.yml

* Update readthedocs.yml

Co-authored-by: bids-maintenance <bids.maintenance@gmail.com>
Co-authored-by: Agah <agahkarakuzu@gmail.com>
Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
sappelhoff added a commit that referenced this pull request Jan 15, 2021
* [ENH] Bep 005: Arterial Spin Labeling (#652)



Co-authored-by: Patricia Clement <41481345+patsycle@users.noreply.github.com>
Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Co-authored-by: Julia Guiomar Niso Galán <guiomar.niso@ctb.upm.es>
Co-authored-by: Remi Gau <remi_gau@hotmail.com>

* Update table errors

* correction for table issues 'common metadata for PCASL/PASL'

* correction latin phrases

* Corrections tables

* correction tables Cases

* added link pepolar

* deleted 'don't discriminate between types of labeling

based on comment Thijs Van Osch

* Moved MagneticFieldStrenght asl requirement to common

* removed scaling factor info based on comment gllmflndn

Removed:
all ancillary scaling factors should be taken into account in the conversion to BIDS, which is why BIDS does not provide a separate scaling factor field other than the NIfTI header.

* added MRAcquisitionType

added in the common - sequence specifics table
Reason: for ASL, defining 2D and 3D is required. This used to be added in the PulseSequenceType field, but this should stay a free text field. Therefore, the MRAcquisitionType field is added (based on DicomTag).

* removed PulseSequenceType from the ASL part

The 2D/3D information needed for ASL, is now moved to the new MRAcquisitionType field.

* added required common fields sentence

Some Common fields are required for ASL. To stress this out, we added a sentence for the *_as.json and the *_m0scan.json.

* adaptation requirements for m0scan.json

* adapted requirement level common fields for m0scan

* update sentence required common fields for asl.json

* Update common field EchoTime

* Removed EchoTime from ASL-table

* update FlipAngle in common RF and Contrasts

* remove FlipAngle from ASL fields

* update Dependency table ASL for MRAcquisitionType

* update SliceTiming in common fields

* remove SliceTiming from ASL tables

* added (FA) for FlipAngle

* update common RF and Contrast for table check

* LabelingPulseDuration and LabelingPulseInterval in ms instead of s

* required common metadatafields update

RepetitionTime or VolumeTiming to RepetitionTimePreparation

* update flipangle for timeseries versus file collections

* update echotime for timeseries

* update timing table (fence)

* update definition BackgroundSuppressionPulseTime

* removed common metadata fields from asl table

MagneticFieldStrenght, EchoTime, SliceTiming, VolumeTiming, RepetitionTime, FlipAngle, PulseSequenceType

* update scaling of asl and m0 files

- update scaling description for nifti files
- created separate scaling section (to highlight this important quantification factor), and M0 section
- moved scaling section and M0 section after aslcontext section

* update broken link in EchoTime (Timing Parameters)

* update broken link (2) EchoTime

* Update broken links FlipAngle

* LabelingType changed to ArterialSpinLabelingType

- changed in fields
- Changed in dependency table
- Dependency table: additionally removed repetitiontime/volumetiming parts

* Update dependency table based on new M0Type and M0Estimate fields

* Update new M0 field strategy

M0 field becomes M0Type, with addition field M0Estimate.
Also corrected IntendedFor description in m0 specific fields

* TEMPORARY: disable 'strict' docs build

this allows the build to proceed despite broken links

* changed fail_on_warning to true 

Intermediate solution to get BEP005 build untill the missing link is available

* see previous commit

* update bep005 with latest master + resolve conflict (#689)

* [DOC] Auto-generate changelog entry for PR #677

* [ENH] BEP001 - New entities: inv & mt (#681)

* add entity inv

* add mt:

* add MT specific metadata

* Generate entity.md

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* Update src/schema/entities.yaml

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* table fix by @sappelhoff

* Conditional requirement

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* [ENH] BEP001 - Entity-linked file collections (#688)

* Squashed commit of the following:

commit 8e1ac5f
Author: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Date:   Fri Nov 27 11:09:24 2020 +0100

    fix links and latin

commit 27c9b41
Author: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Date:   Fri Nov 27 10:03:51 2020 +0100

    remove latin

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit 7d87070
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:46:47 2020 -0500

    Update src/99-appendices/10-file-collections.md

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit b137a9e
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:45:19 2020 -0500

    Update src/02-common-principles.md

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit d7897b8
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:44:40 2020 -0500

    Update src/02-common-principles.md

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit 09e9d32
Author: Agah <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:44:15 2020 -0500

    Commit suggestion

    Co-authored-by: Chris Markiewicz <effigies@gmail.com>

commit 009a9ab
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:43:00 2020 -0500

    Add file-collecitons appendix to the TOC

commit 8f6c4df
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Mon Nov 23 08:41:13 2020 -0500

    Address suggestion by @tsalo

commit 45210a9
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Wed Nov 11 14:32:20 2020 -0500

    Wording

commit 66ba5a5
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Wed Nov 11 14:31:40 2020 -0500

    RECOMMENDED --> MUST for adding an application def to the appdx

commit 5611fac
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Wed Nov 11 14:29:21 2020 -0500

    Improve the appendix

commit 6d3bbea
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Mon Nov 2 16:12:04 2020 -0500

    Address suggestions by @tsalo

commit bcb0223
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Tue Oct 27 21:37:26 2020 -0400

    [ADD] Link to the appendix

commit 44e760f
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Tue Oct 27 21:28:38 2020 -0400

    [ADD] Appendix - File collections

    - For parametrically linked file collections

commit 523b1c1
Author: Agah Karakuzu <agahkarakuzu@gmail.com>
Date:   Tue Oct 27 21:27:52 2020 -0400

    [ADD] Parametrically linked file collections

    - Description

* ENH: Link to all BEP-001 entities

* STY: Escape asterisk, adjust table widths

* Add suggestions by @sappelhoff

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/99-appendices/10-file-collections.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Thank you @effigies!

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/02-common-principles.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

Co-authored-by: Agah Karakuzu <agahkarakuzu@gmail.com>

* [ENH] BEP001 - RepetitionTimeExcitation and RepetitionTimePreparation (#671)

* [ENH] Improve TR definitions

- Include RepetitionTimePreparation
- Include RepetitionTimeExcitation
- Add explanation on the former RepetitionTime field.

* Typo

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* ENH: Allow for variable RTE/P

* STY: Update table widths

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

* Change ref to DOI @Remi-Gau

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update config.yml

* Update readthedocs.yml

Co-authored-by: bids-maintenance <bids.maintenance@gmail.com>
Co-authored-by: Agah <agahkarakuzu@gmail.com>
Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>
Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* update required common fields for m0scan.json

added EchoTime and FlipAngle in case LookLocker is true

* update dependency table

if PCASL : LabelingDuration is required
if PCASL: LabelingDuration should not be filled in

* update depedency table

removed 'PASL' LAbelingDuration should not be filled in

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* update description aslcontext

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* update PCASLType and CASLType

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* updated required into REQUIRED

for asl.json and m0scan.json (common fields

* Added SummaryImages

Added images:
asl_pasl_boluscutoff_false.png
asl_pasl_boluscutoff_true_q2tips.png
asl_pasl_boluscutoff_true_quipssII.png
asl_pcasl_labeling_pulses.png
asl_pcasl_sequence.png

* create Appendix 11 for ASL

* Added asl_flowchart.png

* added subtitles for linking from main specification

* Added appendix link for control and label

* added appendix for asl sequences in general

* added appendix for (P)CASL

* added appendix for PASL

* added appendix for dependency table (flowcharts)

* MNT: Add ASL appendix to TOC

* TYPO: correct ASL appendix entry in tocwq

* fix md style

* Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>

* update table RF and Contrast

* update link Appendix XI to Appendix XI - ASL

* corrected link to appendix for PASL

* Update aslcontext cases

Case 1:
changed asl.json to asl.nii[.gz`]
Removed:  The optional deltam or cbf volumes should be stored and specified as derivative.

Case 2:
Removed: The optional cbf volumes should be stored and specified as derivative.

* Added aslcontext.tsv cases

this is moved from main spec bep005 to appendix XI - ASL

* Update aslcontext cases

- moved three cases to appendix XI - ASL
- added link to appendix XI
- added: Note that the raw images, including the m0scan, may also be used for quality control.

* corrected subtitles cases

* improve linebreaks in ASL appendix

* fix VascularCrushingVENC link

Based on comment of Stefan Appelhof, the Data Type for VascularChrushingVENC was fixed:
[number][] or \[array][] of [numbers][] 
to
[number][] or [array][] of [numbers][]

* added single column requirement for aslcontext.tsv

based on comment of Stefan Appelhof, the need for a single column was added in the introductory text for aslcontext.tsv, before the 3 cases.

* Changed VascularCrushingVENC to VascularCrushingVenc

* [SCHEMA] Add ASL to schema (#703)

* Add ASL to schema files and regenerate entity table.

* Fix style issue.

* Add fmap-format m0scan to schema.

* update M0Estimate fields

Added 'Referring to the M0 of blood'

* update LabelingDuration

Added additional information for LabelingDuration

* update labeling.jpg into *_asllabeling.jpg

* Change labeling to asllabeling. (#709)

* RF: Renumber ASL appendix to XII

Co-authored-by: Henk Mutsaerts <henkjanmutsaerts@gmail.com>
Co-authored-by: Patricia Clement <41481345+patsycle@users.noreply.github.com>
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Co-authored-by: Julia Guiomar Niso Galán <guiomar.niso@ctb.upm.es>
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
Co-authored-by: bids-maintenance <bids.maintenance@gmail.com>
Co-authored-by: Agah <agahkarakuzu@gmail.com>
Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>
Co-authored-by: Taylor Salo <tsalo006@fiu.edu>
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.

7 participants