tedana.gscontrol
.gscontrol_raw
- gscontrol_raw(*, data_cat: ndarray, data_optcom: ndarray, n_echos: int, io_generator: OutputGenerator, dtrank: int = 4)[source]
Remove global signal from individual echo
data_cat
anddata_optcom
time series.This function uses the spatial global signal estimation approach to to removal global signal out of individual echo time series datasets. The spatial global signal is estimated from the optimally combined data after detrending with a Legendre polynomial basis of
order = 0
anddegree = dtrank
.- Parameters:
data_cat ((S x E x T) array_like) – Input functional data
data_optcom ((S x T) array_like) – Optimally combined functional data (i.e., the output of make_optcom)
n_echos (
int
) – Number of echos in data. Should be the same asE
dimension ofdata_cat
io_generator (
tedana.io.OutputGenerator
) – The output generator for this workflowdtrank (
int
, optional) – Specifies degree of Legendre polynomial basis function for estimating spatial global signal. Default: 4
- Returns:
data_cat_nogs ((S x E x T) array_like) – Input
data_cat
with global signal removed from time series.data_optcom_nogs ((S x T) array_like) – Input
data_optcom
with global signal removed from time series.
Notes
This function writes out several files:
IOGenerator Label
Content
“has gs combined img”
Optimally combined data before global signal removal
“gs img”
Spatial global signal map
“confounds tsv”
A “global_signal” column with the time course of the global signal is added to this TSV.
“removed gs combined img”
Optimally combined data after global signal removal