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.

Sign up for GitHub

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] Define a metadata table for TB1EPI #1912

Merged
merged 2 commits into from
Aug 28, 2024
Merged

[FIX] Define a metadata table for TB1EPI #1912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c83f8ec
[STY] Use wikipedia links, separate URL definitions
effigies Aug 27, 2024
a73c1b0
[FIX] Define a metadata table for TB1EPI
effigies Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/appendices/qmri.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,10 +607,15 @@ The nominal FA value of the SE pulse is twice this value.
Note that the following metadata fields MUST be defined in the accompanying JSON
files:

| **Field name** | **Definition** |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `TotalReadoutTime` | The effective readout length defined as `EffectiveEchoSpacing * PEReconMatrix`, with `EffectiveEchoSpacing = TrueEchoSpacing / PEacceleration` |
| `MixingTime` | Time interval between the SE and STE pulses |
<!-- This block generates a metadata table.
These tables are defined in
src/schema/rules/sidecars
The definitions of the fields specified in these tables may be found in
src/schema/objects/metadata.yaml
A guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_sidecar_table("fmap.TB1EPI") }}

To properly identify constituents of this particular method, values of the `echo`
entity MUST index the images as follows:
Expand Down
69 changes: 45 additions & 24 deletions src/appendices/units.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,30 +83,51 @@ Examples for CMIXF-12 (including the five unicode symbols mentioned above):

### Multiples

| **Prefix name** | **Prefix symbol** | **Factor** |
| ------------------------------------------- | ----------------- | --------------- |
| [deca](https://www.wikiwand.com/en/Deca-) | da | 10<sup>1</sup> |
| [hecto](https://www.wikiwand.com/en/Hecto-) | h | 10<sup>2</sup> |
| [kilo](https://www.wikiwand.com/en/Kilo-) | k | 10<sup>3</sup> |
| [mega](https://www.wikiwand.com/en/Mega-) | M | 10<sup>6</sup> |
| [giga](https://www.wikiwand.com/en/Giga-) | G | 10<sup>9</sup> |
| [tera](https://www.wikiwand.com/en/Tera-) | T | 10<sup>12</sup> |
| [peta](https://www.wikiwand.com/en/Peta-) | P | 10<sup>15</sup> |
| [exa](https://www.wikiwand.com/en/Exa-) | E | 10<sup>18</sup> |
| [zetta](https://www.wikiwand.com/en/Zetta-) | Z | 10<sup>21</sup> |
| [yotta](https://www.wikiwand.com/en/Yotta-) | Y | 10<sup>24</sup> |
| **Prefix name** | **Prefix symbol** | **Factor** |
| --------------- | ----------------- | --------------- |
| [deca][] | da | 10<sup>1</sup> |
| [hecto][] | h | 10<sup>2</sup> |
| [kilo][] | k | 10<sup>3</sup> |
| [mega][] | M | 10<sup>6</sup> |
| [giga][] | G | 10<sup>9</sup> |
| [tera][] | T | 10<sup>12</sup> |
| [peta][] | P | 10<sup>15</sup> |
| [exa][] | E | 10<sup>18</sup> |
| [zetta][] | Z | 10<sup>21</sup> |
| [yotta][] | Y | 10<sup>24</sup> |

### Submultiples

| **Prefix name** | **Prefix symbol** | **Factor** |
| ------------------------------------------- | ----------------- | ---------------- |
| [deci](https://www.wikiwand.com/en/Deci-) | d | 10<sup>-1</sup> |
| [centi](https://www.wikiwand.com/en/Centi-) | c | 10<sup>-2</sup> |
| [milli](https://www.wikiwand.com/en/Milli-) | m | 10<sup>-3</sup> |
| [micro](https://www.wikiwand.com/en/Micro-) | u | 10<sup>-6</sup> |
| [nano](https://www.wikiwand.com/en/Nano-) | n | 10<sup>-9</sup> |
| [pico](https://www.wikiwand.com/en/Pico-) | p | 10<sup>-12</sup> |
| [femto](https://www.wikiwand.com/en/Femto-) | f | 10<sup>-15</sup> |
| [atto](https://www.wikiwand.com/en/Atto-) | a | 10<sup>-18</sup> |
| [zepto](https://www.wikiwand.com/en/Zepto-) | z | 10<sup>-21</sup> |
| [yocto](https://www.wikiwand.com/en/Yocto-) | y | 10<sup>-24</sup> |
| **Prefix name** | **Prefix symbol** | **Factor** |
| --------------- | ----------------- | ---------------- |
| [deci][] | d | 10<sup>-1</sup> |
| [centi][] | c | 10<sup>-2</sup> |
| [milli][] | m | 10<sup>-3</sup> |
| [micro][] | u | 10<sup>-6</sup> |
| [nano][] | n | 10<sup>-9</sup> |
| [pico][] | p | 10<sup>-12</sup> |
| [femto][] | f | 10<sup>-15</sup> |
| [atto][] | a | 10<sup>-18</sup> |
| [zepto][] | z | 10<sup>-21</sup> |
| [yocto][] | y | 10<sup>-24</sup> |

[deca]: https://en.wikipedia.org/wiki/Deca-
[hecto]: https://en.wikipedia.org/wiki/Hecto-
[kilo]: https://en.wikipedia.org/wiki/Kilo-
[mega]: https://en.wikipedia.org/wiki/Mega-
[giga]: https://en.wikipedia.org/wiki/Giga-
[tera]: https://en.wikipedia.org/wiki/Tera-
[peta]: https://en.wikipedia.org/wiki/Peta-
[exa]: https://en.wikipedia.org/wiki/Exa-
[zetta]: https://en.wikipedia.org/wiki/Zetta-
[yotta]: https://en.wikipedia.org/wiki/Yotta-
[deci]: https://en.wikipedia.org/wiki/Deci-
[centi]: https://en.wikipedia.org/wiki/Centi-
[milli]: https://en.wikipedia.org/wiki/Milli-
[micro]: https://en.wikipedia.org/wiki/Micro-
[nano]: https://en.wikipedia.org/wiki/Nano-
[pico]: https://en.wikipedia.org/wiki/Pico-
[femto]: https://en.wikipedia.org/wiki/Femto-
[atto]: https://en.wikipedia.org/wiki/Atto-
[zepto]: https://en.wikipedia.org/wiki/Zepto-
[yocto]: https://en.wikipedia.org/wiki/Yocto-
10 changes: 10 additions & 0 deletions src/schema/rules/sidecars/fmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,13 @@ MRIFieldmapPepolar:
fields:
PhaseEncodingDirection: required
TotalReadoutTime: required

TB1EPI:
selectors:
- datatype == "fmap"
- suffix == "TB1EPI"
fields:
EchoTime: required
FlipAngle: required
TotalReadoutTime: required
MixingTime: required