diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a15e53a..6c9fd151 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # Release history ## Version 3.0alpha1 (12/20/24) -* (rapidtide) The ``--fixdelay`` option has been split into two options. ``--initialdelay DELAY`` lets you specify either a float that sets the starting delay for every voxel to that value, or a 3D file specifying the initial delay for each voxel. ``--nodelayfit`` determines whether the delay can be adjusted from its initial value. Closes https://github.com/bbfrederick/rapidtide/issues/171. +* (rapidtide) The ``--fixdelay`` option has been split into two options. ``--initialdelay DELAY`` lets you specify either a float that sets the starting delay for every voxel to that value, or a 3D file specifying the initial delay for each voxel. ``--nodelayfit`` determines whether the delay can be adjusted from its initial value. Closes https://github.com/bbfrederick/rapidtide/issues/171. KNOWN ISSUE: If you supply an initial delay map, instead of using the global mean, you should use the delays to make your first stage regressor. Currently that is not the case. * (rapidtide) Reorganized command line options and adjusted the default values. * (rapidtide) Help output now shows the filter ranges. * (rapidtide, retroglm) Added delay refinement using the ratio of the fit coefficients of the regressor and its time derivative. diff --git a/rapidtide/workflows/rapidtide_parser.py b/rapidtide/workflows/rapidtide_parser.py index 1888b8cd..175108a7 100755 --- a/rapidtide/workflows/rapidtide_parser.py +++ b/rapidtide/workflows/rapidtide_parser.py @@ -1210,6 +1210,46 @@ def _get_parser(): ), default=DEFAULT_GLMDERIVS, ) + glm.add_argument( + "--refinedelay", + dest="refinedelay", + action="store_true", + help=("Refine the delay map using GLM information before the filter step."), + default=False, + ) + glm.add_argument( + "--nofilterwithrefineddelay", + dest="filterwithrefineddelay", + action="store_false", + help=("Do not use the refined delay in GLM filter."), + default=True, + ) + glm.add_argument( + "--delaypatchthresh", + dest="delaypatchthresh", + action="store", + type=float, + metavar="NUMMADs", + help=( + "Maximum number of robust standard deviations to permit in the offset delay refine map. " + f"Default is {DEFAULT_PATCHTHRESH}" + ), + default=DEFAULT_PATCHTHRESH, + ) + glm.add_argument( + "--delayoffsetspatialfilt", + dest="delayoffsetgausssigma", + action="store", + type=float, + metavar="GAUSSSIGMA", + help=( + "Spatially filter fMRI data prior to calculating delay offsets " + "using GAUSSSIGMA in mm. Set GAUSSSIGMA negative " + "to have rapidtide set it to half the mean voxel " + "dimension (a rule of thumb for a good value). Set to 0 to disable." + ), + default=DEFAULT_DELAYOFFSETSPATIALFILT, + ) # Output options output = parser.add_argument_group("Output options") @@ -1330,6 +1370,13 @@ def _get_parser(): help=("Will disable showing progress bars (helpful if stdout is going to a file)."), default=True, ) + misc.add_argument( + "--makepseudofile", + dest="makepseudofile", + action="store_true", + help=("Make a simulated input file from the mean and the movingsignal."), + default=False, + ) misc.add_argument( "--checkpoint", dest="checkpoint", @@ -1423,53 +1470,6 @@ def _get_parser(): ), default=None, ) - experimental.add_argument( - "--refinedelay", - dest="refinedelay", - action="store_true", - help=("Refine the delay map using GLM information before the filter step."), - default=False, - ) - experimental.add_argument( - "--nofilterwithrefineddelay", - dest="filterwithrefineddelay", - action="store_false", - help=("Do not use the refined delay in GLM filter."), - default=True, - ) - experimental.add_argument( - "--delaypatchthresh", - dest="delaypatchthresh", - action="store", - type=float, - metavar="NUMMADs", - help=( - "Maximum number of robust standard deviations to permit in the offset delay refine map. " - f"Default is {DEFAULT_PATCHTHRESH}" - ), - default=DEFAULT_PATCHTHRESH, - ) - experimental.add_argument( - "--delayoffsetspatialfilt", - dest="delayoffsetgausssigma", - action="store", - type=float, - metavar="GAUSSSIGMA", - help=( - "Spatially filter fMRI data prior to calculating delay offsets " - "using GAUSSSIGMA in mm. Set GAUSSSIGMA negative " - "to have rapidtide set it to half the mean voxel " - "dimension (a rule of thumb for a good value). Set to 0 to disable." - ), - default=DEFAULT_DELAYOFFSETSPATIALFILT, - ) - experimental.add_argument( - "--makepseudofile", - dest="makepseudofile", - action="store_true", - help=("Make a simulated input file from the mean and the movingsignal."), - default=False, - ) experimental.add_argument( "--psdfilter", dest="psdfilter",