tedana.io.write_split_ts

write_split_ts(data, mmix, mask, comptable, io_generator, echo=0)[source]

Split data into denoised / noise / ignored time series and save to disk.

Parameters:

  • data ((S x T) array_like) – Input time series

  • mmix ((C x T) array_like) – Mixing matrix for converting input data to component space, where C is components and T is the same as in data

  • mask ((S,) array_like) – Boolean mask array

  • io_generator (tedana.io.OutputGenerator) – Reference image to dictate how outputs are saved to disk

  • out_dir (str, optional) – Output directory.

  • echo (:obj: int, optional) – Echo number to generate filenames, used by some verbose functions. Currently this is only not 0 when io_generator.verbose==True. Default 0.

Returns:

varexpl (float) – Percent variance of data explained by extracted + retained components

Generated Files

Filename

Content

desc-denoised_bold.nii.gz

Denoised time series.

if io_generator.verbose==True

desc-optcomAccepted_bold.nii.gz

High-Kappa time series.

desc-optcomRejected_bold.nii.gz

Low-Kappa time series.

if echo>0

echo-[echo]_desc-Accepted_bold.nii.gz

High-Kappa timeseries for echo number echo.

echo-[echo]_desc-Rejected_bold.nii.gz

Low-Kappa timeseries for echo number echo.

echo-[echo]_desc-Denoised_bold.nii.gz

Denoised timeseries for echo number echo.