Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: More nipype style documentation for easier end use #97

Open
ostanley opened this issue Jan 22, 2021 · 0 comments
Open

ENH: More nipype style documentation for easier end use #97

ostanley opened this issue Jan 22, 2021 · 0 comments

Comments

@ostanley
Copy link
Contributor

Re: our Jan 21 meeting here are two examples of the atlas brex documentation. I think the piece that is missing is a listing of the actual params, and roughly what they do, and a default setting. Everything I added for this I grabbed from either the AtlasBrex class or the bash script itself.

Current:

inputnode:
restore_T1: preprocessed (debiased/denoised) T1 file name
restore_T1: preprocessed (debiased/denoised)T2 file name

arguments:
params_template: dictionary of info about template
params: dictionary of node sub-parameters (from a json file)
name: pipeline name (default = “extract_pipe”)

Outputs:
smooth_mask.out_file: Computed mask (after some smoothing)

Proposed:

inputnode:

  • restore_T1: preprocessed (debiased/denoised) T1 file name
  • restore_T1: preprocessed (debiased/denoised)T2 file name

arguments:

  • params_template: dictionary of info about template
    • template_head: Atlas with skull default: NMT
    • template_brain: Atlas with skull removed, default NMT_SS
  • params: dictionary of node sub-parameters (from a json file)
    • f: initial BET fraction, default 0.5
    • reg: method of template registration, default 1
      0 = FNIRT w/ bending
      1 (default) = FNIRT membrane-energy regularization
      2 = ANTs/SyN w/ N4Bias
      3 = w/o N4Bias
    • w: warp resolution, default 10,10,10
    • msk: mask binarization threshold (in %) for fslmaths default a,0,0
  • name: pipeline name (default = “extract_pipe”)

Outputs:

  • smooth_mask.out_file: Computed mask (after some smoothing)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant