Skip to content

sub-millimeter reconstruction flag #3665

Description

@michaelf500

Under https://fmriprep.org/en/stable/usage.html#fmriprep.cli.parser-_build_parser-specific-options-for-freesurfer-preprocessing

The help says:

--submm-recon, --no-submm-recon

Enable or disable sub-millimeter (hi-res) reconstruction.

Default: True

To me, this is ambiguous as to whether sub-mm recon is used by default or not.
Seems to me you only need one of --no-sub-recon needed or --submm-recon

I find the use of the Default: True / False for options like this confusing, because it's not immediately obvious (to me) whether the True refers to the actual thing being turned on or off (ie hi-res reconstruction), or whether it is the default value of
a flag eg no-submm-recon

In other options, the default value is something that can be specified on the command line, eg --skull-strip-t1w force so to give a default value where one is not needed seems inconsistent.

I naturally assume that if there is an option to turn off something, then that something is on by default, so specifying the default is not necessary.

If a default is wanted, I would prefer something like
Default: sub-millimeter reconstruction is enabled.

Thanks

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions