tedana.io.write_split_ts

write_split_ts(data, mmix, mask, comptable, ref_img, suffix='')[source]

Splits data into denoised / noise / ignored time series and saves 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
  • ref_img (str or img_like) – Reference image to dictate how outputs are saved to disk
  • suffix (str, optional) – Appended to name of saved files (before extension). Default: ‘’
Returns:

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

Return type:

float

Notes

This function writes out several files:

Filename Content
hik_ts_[suffix].nii High-Kappa time series.
midk_ts_[suffix].nii Mid-Kappa time series.
low_ts_[suffix].nii Low-Kappa time series.
dn_ts_[suffix].nii Denoised time series.