Skip to content

Commit

Permalink
Revert "placeholder for Allen Mouse"
Browse files Browse the repository at this point in the history
This reverts commit f2039f4.
  • Loading branch information
Jordan DeKraker committed Apr 22, 2024
1 parent 42b9f1c commit e063a06
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions hippunfold/config/snakebids.yml
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ parse_args:
action: version
version: "1.4.2-pre.37"


--modality:
help: 'Type of image to run hippunfold on. Modality prefixed with seg will import an existing (manual) hippocampal tissue segmentation from that space, instead of running neural network (default: %(default)s)'
required: True
Expand All @@ -141,36 +142,39 @@ parse_args:
- segT2w
- cropseg


--template:
choices:
- 'CITI168'
- 'dHCP'
- 'MBMv2'
- 'MBMv3'
- 'CIVM'
- 'ABAv3'
default: 'CITI168'
help: 'Set the template to use for registration to coronal oblique (and optionally for template-based segmentation if --use-template-seg is enabled). CITI168 is for adult human data, dHCP is for neonatal human data, MBMv2 is for ex-vivo marmoset data, MBMv3 is for in-vivo marmoset data, CIVM is for in-vivo macaque data, ABAv3 is ex-vivo mouse data. Linear registration errors can sometimes occur due to differences in skull-stripping, which can be ameliorated with the "--rigid_reg_template" flag. (default: %(default)s)'
help: 'Set the template to use for registration to coronal oblique (and optionally for template-based segmentation if --use-template-seg is enabled). CITI168 is for adult human data, dHCP is for neonatal human data, MBMv2 is for ex vivo marmoset data, MBMv3 is for in vivo marmoset data, and CIVM is for in vivo macaque data. (default: %(default)s)'




--inject_template:
choices:
- 'upenn'
- 'MBMv2'
- 'MBMv3'
- 'CIVM'
- 'ABAv3'
default: 'upenn'
help: 'Set the template to use for shape injection. (default: %(default)s)'

--use_template_seg:
help: 'Use template-based segmentation for hippocampal tissue *instead of* nnUnet and shape injection. This is only to be used if nnUnet models are not trained for the data you are using, e.g. for non-human primate data with the MBMv2 (ex-vivo marmoset), MBMv3 (in-vivo marmoset), or CIVM (ex-vivo macaque) template. (default: %(default)s)'
help: 'Use template-based segmentation for hippocampal tissue *instead of* nnUnet and shape injection. This is only to be used if nnUnet models are not trained for the data you are using, e.g. for non-human primate data with the MBMv2 (ex vivo marmoset), MBMv3 (in vivo marmoset), or CIVM (ex vivo macaque) template. (default: %(default)s)'
default: False
action: 'store_true'

--template_seg_smoothing_factor:
help: 'Scales the default smoothing sigma for gradient and warp in greedy registration for template-based segmentation. Using a value higher than 1 will use result in a smoother warp. (default: %(default)s)'
default: 2.0


--derivatives:
help: 'Path to the derivatives folder (e.g. for finding manual segs) (default: %(default)s) '
default: False
Expand All @@ -180,6 +184,7 @@ parse_args:
default: False
action: 'store_true'


--skip_coreg:
help: 'Set this flag if your inputs (e.g. T2w, dwi) are already registered to T1w space (default: %(default)s)'
default: False
Expand All @@ -190,10 +195,12 @@ parse_args:
default: False
action: 'store_true'


--inject_template_smoothing_factor:
help: 'Scales the default smoothing sigma for gradient and warp in template shape injection. Using a value higher than 1 will use result in a smoother warp, and greater capacity to patch larger holes in segmentations. Try setting to 2 if nnunet segmentations have large holes. Note: the better solution is to re-train network on the data you are using (default: %(default)s)'
default: 1.0


--rigid_reg_template:
help: 'Use rigid instead of affine for registration to template. Try this if your images are reduced FOV (default: %(default)s)'
default: False
Expand All @@ -204,6 +211,7 @@ parse_args:
default: False
action: 'store_true'


--t1_reg_template:
help: 'Use T1w to register to template space, instead of the segmentation modality. Note: this was the default behavior prior to v1.0.0. (default: %(default)s)'
default: false
Expand Down Expand Up @@ -320,6 +328,7 @@ autotop_labels:
- 'hipp'
- 'dentate'


surf_types:
hipp:
- midthickness
Expand All @@ -336,7 +345,7 @@ gifti_metric_types:
dentate:
- gyrification.shape
- curvature.shape

cifti_metric_types:
hipp:
- gyrification.dscalar
Expand All @@ -349,6 +358,7 @@ cifti_metric_types:




#--- workflow specific configuration --

singularity:
Expand All @@ -368,10 +378,6 @@ template_based_segmentation:
hemi:
- R
- L
ABAv3:
hemi:
- R
- L
MBMv2:
hemi:
- R
Expand Down Expand Up @@ -411,7 +417,7 @@ template_files:
xfm_corobl: tpl-MBMv3_from-native_to-corobl_type-itk_affine.txt
crop_ref: tpl-MBMv3_hemi-{hemi}_space-corobl_T1w.nii.gz
Mask_crop: tpl-MBMv3_hemi-{hemi}_space-corobl_desc-hipp_mask.nii.gz
dseg: tpl-MBMv3_hemi-{hemi}_space-corobl_desc-tissue_dseg.nii.gz
dseg: tpl-MBMv3_hemi-{hemi}_space-corobl_desc-tissuemanual_dseg.nii.gz
coords: tpl-MBMv3_dir-{dir}_hemi-{hemi}_space-corobl_label-{autotop}_desc-laplace_coords.nii.gz
CIVM:
T1w: tpl-CIVM_T1w.nii.gz
Expand All @@ -420,13 +426,6 @@ template_files:
Mask_crop: tpl-CIVM_hemi-{hemi}_space-corobl_desc-hipp_mask.nii.gz
dseg: tpl-CIVM_hemi-{hemi}_space-corobl_desc-tissuemanual_dseg.nii.gz
coords: tpl-CIVM_dir-{dir}_hemi-{hemi}_space-corobl_label-{autotop}_desc-laplace_coords.nii.gz
ABAv3:
T1w: tpl-ABAv3_T1w.nii.gz
xfm_corobl: tpl-ABAv3_from-native_to-corobl_type-itk_affine.txt
crop_ref: tpl-ABAv3_hemi-{hemi}_space-corobl_{modality}.nii.gz
Mask_crop: tpl-ABAv3_hemi-{hemi}_space-corobl_desc-hipp_mask.nii.gz
dseg: tpl-ABAv3_hemi-{hemi}_space-corobl_desc-tissuemanual_dseg.nii.gz
coords: tpl-ABAv3_dir-{dir}_hemi-{hemi}_space-corobl_label-{autotop}_desc-laplace_coords.nii.gz
upenn:
T1w: tpl-upenn_desc-hipptissue_dseg.nii.gz
dseg: tpl-upenn_desc-hipptissue_dseg.nii.gz
Expand Down Expand Up @@ -513,7 +512,6 @@ resource_urls:
MBMv3: 'files.ca-1.osf.io/v1/resources/v8acf/providers/osfstorage/65395c0e8a28b11240ffc6e9/?zip='
upenn: 'files.ca-1.osf.io/v1/resources/v8acf/providers/osfstorage/65395c1613d27b122a94ca09/?zip='
CIVM: 'files.ca-1.osf.io/v1/resources/v8acf/providers/osfstorage/65395bf62827451220b86e24/?zip='
ABAv3: ''
#to get hash, see https://github.com/CenterForOpenScience/osf.io/issues/8256#issuecomment-379833911


Expand Down

0 comments on commit e063a06

Please sign in to comment.