filttc

Description:

Inputs:

Outputs:

Usage:

Filter timecourse data in text files

usage: filttc [-h] [--samplerate FREQ | --sampletstep TSTEP]
              [--filterband {None,vlf,lfo,resp,cardiac,hrv_ulf,hrv_vlf,hrv_lf,hrv_hf,hrv_vhf,lfo_legacy,lfo_tight}]
              [--filterfreqs LOWERPASS UPPERPASS]
              [--filterstopfreqs LOWERSTOP UPPERSTOP]
              [--normmethod {None,percent,variance,stddev,z,p2p,mad}]
              [--normfirst] [--demean] [--debug]
              inputfile outputfile

Positional Arguments

inputfile

Text file containing one or more timeseries columns. Use [:COLSPEC] to select which column(s) to use, where COLSPEC is an integer, a column separated list of ranges, or a comma separated set of column names (if input file is BIDS). Default is to use all columns

outputfile

Name of the output text file.

Named Arguments

--samplerate

Timecourses in file have sample frequency FREQ (default is 1.0Hz) NB: –samplerate and –sampletstep) are two ways to specify the same thing.

Default: auto

--sampletstep

Timecourses in file have sample timestep TSTEP (default is 1.0s) NB: –samplerate and –sampletstep) are two ways to specify the same thing.

Default: auto

--normfirst

Normalize before filtering, rather than after.

Default: False

--demean

Demean before filtering.

Default: False

--debug

Enable additional debugging output.

Default: False

Filtering options

--filterband

Possible choices: None, vlf, lfo, resp, cardiac, hrv_ulf, hrv_vlf, hrv_lf, hrv_hf, hrv_vhf, lfo_legacy, lfo_tight

Filter timecourses to specific band. Use “None” to disable filtering. Default is “lfo”. Ranges are: vlf: 0.0-0.009Hz, lfo: 0.01-0.15Hz, cardiac: 0.66-3.0Hz, hrv_ulf: 0.0-0.0033Hz, hrv_vlf: 0.0033-0.04Hz, hrv_lf: 0.04-0.15Hz, hrv_hf: 0.15-0.4Hz, hrv_vhf: 0.4-0.5Hz, lfo_legacy: 0.01-0.15Hz, lfo_tight: 0.01-0.1Hz

Default: 'lfo'

--filterfreqs

Filter timecourses to retain LOWERPASS to UPPERPASS. If –filterstopfreqs is not also specified, LOWERSTOP and UPPERSTOP will be calculated automatically.

--filterstopfreqs

Filter timecourses to with stop frequencies LOWERSTOP and UPPERSTOP. LOWERSTOP must be <= LOWERPASS, UPPERSTOP must be >= UPPERPASS. Using this argument requires the use of –filterfreqs.

Normalization options

--normmethod

Possible choices: None, percent, variance, stddev, z, p2p, mad

Demean and normalize timecourses using one of the following methods: “None” - demean only; “percent” - divide by mean; “variance” - divide by variance; “stddev” or “z” - divide by standard deviation; “p2p” - divide by range; “mad” - divide by median absolute deviation. Default is “None”.

Default: 'None'