Skip to content

Commit fd9a88e

Browse files
committed
📝 Document phasediff DwellTime correction
1 parent c5f97f0 commit fd9a88e

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. warning::
2+
Prior to v1.8.5, C-PAC erroneously used the ``DwellTime`` value from the fieldmap metadata instead of the appropriate ``EffectiveEchoSpacing`` value from the BOLD metadata.

docs/_sources/user/func.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,15 @@ The C-PAC pipeline configuration builder provides options for configuring the Di
173173

174174
#. **DeltaTE, in ms - [float]:** The time difference between the first magnitude image and the second magnitude image. The default value is 2.46 ms, which is widely used for SIEMENS, but it may differ with different datasets acquired by other MRI scanner brands, so it is important to ascertain this value specific to your data.
175175

176-
#. **Dwell Time, in s - [float]:** The dwell time is also known as echo spacing, and it is the time between the start of the readout of two successive lines in k-space during the EPI acquisition. This is a value obtained from the functional EPI (NOT the fieldmap). Here, the default value is 0.0005s.
176+
#. **EffectiveEchoSpacing, in s - [float]:** The effective echo spacing is the time between the start of the readout of two successive lines in k-space during the EPI acquisition. This is a value obtained from the functional EPI (NOT the fieldmap). Here, the default value is 0.0005s.
177+
178+
.. versionadded: v.1.0.3
177179
178-
#. **Dwell to asymmetric ratio - [float]:** This is the ratio between the Dwell time, as referenced above, and the asymmetric time. Here, the default value is 0.93902439.
180+
.. versionchanged: v1.8.5
181+
182+
.. include:: /admonitions/DwellTime.rst
183+
184+
#. **EffectiveEchoSpacing to asymmetric ratio - [float]:** This is the ratio between the effective echo spacing, as referenced above, and the asymmetric time. Here, the default value is 0.93902439.
179185

180186
#. **Phase encoding direction - [string]:** This is the position of the voxels in the input image, and can have values of x/y/z or -x/-y/-z.
181187

0 commit comments

Comments
 (0)