compute_total_readout_time

bidsaid.metadata.compute_total_readout_time(effective_echo_spacing=None, recon_matrix_pe=None, use_fallback_trt=False)[source]

Compute the total readout time.

The following formula is used:

total_readout_time = effective_echo_spacing * (recon_matrix_pe - 1)

where: echo_train_length = epi_factor + 1 (Number of echos acquired every radiofrequency pulse (repetition time))

Parameters

effective_echo_spacingfloat

The effective echo spacing in seconds.

recon_matrix_peint

The number of pixels in the phase encoding axis of the reconstruction matrix.

use_fallback_trtbool

If True, a fallback readout time of 0.03125 is used.

Returns

float

The total readout time in seconds.

References

sdcflows.utils.epimanip module - sdcflows 0+unknown documentation. (2022). Nipreps.org. https://www.nipreps.org/sdcflows/master/api/sdcflows.utils.epimanip.html#mjx-eqn%3Aeq%3Arotime-ees