Skip to content

Commit fa6ba69

Browse files
committed
Prepare the 4.3.1 release
1 parent 84be28f commit fa6ba69

File tree

13 files changed

+40
-33
lines changed

13 files changed

+40
-33
lines changed

COPYRIGHT.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ If not, see `https://www.gnu.org/licenses <https://www.gnu.org/licenses/>`__
1414

1515
SPDX-License-Identifier: GPL-3.0-or-later
1616

17-
Copyright (c): 2018-2023, Marcel Zwiers
17+
Copyright (c): 2018-2024, Marcel Zwiers

bidscoin/cli/_bidscoiner.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ def get_parser():
3434
parser.add_argument('-b','--bidsmap', help='The study bidsmap file with the mapping heuristics. If the bidsmap filename is just the basename (i.e. no "/" in the name) then it is assumed to be located in the current directory or in bidsfolder/code/bidscoin. Default: bidsmap.yaml', default='bidsmap.yaml')
3535
parser.add_argument('-f','--force', help='Process all subjects, regardless of existing subject folders in the bidsfolder. Otherwise these subject folders will be skipped', action='store_true')
3636
parser.add_argument('-c','--cluster', help='Use the DRMAA library to submit the bidscoiner jobs to a high-performance compute (HPC) cluster', action='store_true')
37-
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting bidscoiner jobs to the HPC cluster. NB: Use quotes and include at least one space character to prevent overearly parsing (default: -l walltime=00:30:00,mem=4gb)', default='-l walltime=00:30:00,mem=4gb')
37+
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting bidscoiner jobs to the HPC cluster. NB: Use quotes and include at least one space character to prevent premature parsing (default: -l walltime=00:30:00,mem=4gb)', default='-l walltime=00:30:00,mem=4gb')
3838

3939
return parser

bidscoin/cli/_deface.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescri
3434
parser.add_argument('-p','--participant_label', help='Space separated list of sub-# identifiers to be processed (the sub-prefix can be left out). If not specified then all sub-folders in the bidsfolder will be processed', nargs='+')
3535
parser.add_argument('-o','--output', help=f"A string that determines where the defaced images are saved. It can be the name of a BIDS datatype folder, such as 'anat', or of the derivatives folder, i.e. 'derivatives'. If output is left empty then the original images are replaced by the defaced images")
3636
parser.add_argument('-c','--cluster', help='Use the DRMAA library to submit the deface jobs to a high-performance compute (HPC) cluster', action='store_true')
37-
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting deface jobs to the HPC cluster (NB: Use quotes and include at least one space character to prevent overearly parsing)', default='-l walltime=00:30:00,mem=2gb')
37+
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting deface jobs to the HPC cluster (NB: Use quotes and include at least one space character to prevent premature parsing)', default='-l walltime=00:30:00,mem=2gb')
3838
parser.add_argument('-a','--args', help='Additional arguments (in dict/json-style) that are passed to pydeface (NB: Use quotes). See examples for usage', type=json.loads, default={})
3939
parser.add_argument('-f','--force', help='Deface all images, regardless if they have already been defaced (i.e. if {"Defaced": True} in the json sidecar file)', action='store_true')
4040

bidscoin/cli/_medeface.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescri
3737
parser.add_argument('-p','--participant_label', help='Space separated list of sub-# identifiers to be processed (the sub-prefix can be left out). If not specified then all sub-folders in the bidsfolder will be processed', nargs='+')
3838
parser.add_argument('-o','--output', help=f"A string that determines where the defaced images are saved. It can be the name of a BIDS datatype folder, such as 'anat', or of the derivatives folder, i.e. 'derivatives'. If output is left empty then the original images are replaced by the defaced images")
3939
parser.add_argument('-c','--cluster', help='Use the DRMAA library to submit the deface jobs to a high-performance compute (HPC) cluster', action='store_true')
40-
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting deface jobs to the HPC cluster (NB: Use quotes and include at least one space character to prevent overearly parsing)', default='-l walltime=00:30:00,mem=2gb')
40+
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting deface jobs to the HPC cluster (NB: Use quotes and include at least one space character to prevent premature parsing)', default='-l walltime=00:30:00,mem=2gb')
4141
parser.add_argument('-a','--args', help='Additional arguments (in dict/json-style) that are passed to pydeface (NB: Use quotes). See examples for usage', type=json.loads, default={})
4242
parser.add_argument('-f','--force', help='Process all images, regardless if images have already been defaced (i.e. if {"Defaced": True} in the json sidecar file)', action='store_true')
4343

bidscoin/cli/_skullstrip.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescri
3131
parser.add_argument('-m','--masked', help="Globlike search pattern (relative to the subject/session folder) to select additional (3D/4D) images from the same space that need to be masked with the same mask, e.g. 'fmap/*_phasediff'. NB: This option can only be used if pattern yields a single file per session", type=str)
3232
parser.add_argument('-o','--output', help="One or two output strings that determine where the skullstripped + additional masked images are saved. Each output string can be the name of a BIDS datatype folder, such as 'anat', or of the derivatives folder, i.e. 'derivatives' (default). If the output string is the same as the datatype then the original images are replaced by the skullstripped images", nargs='+')
3333
parser.add_argument('-f','--force', help="Process images, regardless whether images have already been skullstripped (i.e. if {'SkullStripped': True} in the json sidecar file)", action='store_true')
34-
parser.add_argument('-a','--args', help="Additional arguments that are passed to synthstrip (NB: Use quotes and include at least one space character to prevent overearly parsing)", type=str, default='')
34+
parser.add_argument('-a','--args', help="Additional arguments that are passed to synthstrip (NB: Use quotes and include at least one space character to prevent premature parsing)", type=str, default='')
3535
parser.add_argument('-c','--cluster', help='Use the DRMAA library to submit the skullstrip jobs to a high-performance compute (HPC) cluster', action='store_true')
36-
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting skullstrip jobs to the HPC cluster (NB: Use quotes and include at least one space character to prevent overearly parsing)', default='-l walltime=0:05:00,mem=8gb')
36+
parser.add_argument('-n','--nativespec', help='Opaque DRMAA argument with native specifications for submitting skullstrip jobs to the HPC cluster (NB: Use quotes and include at least one space character to prevent premature parsing)', default='-l walltime=0:05:00,mem=8gb')
3737

3838
return parser

bidscoin/cli/_slicereport.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def get_parser():
6262
parser.add_argument('-q','--qcscores', help="Column names for creating an accompanying tsv-file to store QC-rating scores (default: rating_overall)", default=['rating_overall'], nargs='+')
6363
parser.add_argument('-c','--cluster', help='Use `torque` or `slurm` to submit the slicereport jobs to a high-performance compute (HPC) cluster', choices=['torque','slurm'])
6464
parser.add_argument('-m','--mem', help='The amount of requested memory in GB for the cluster jobs', default='')
65-
parser.add_argument('--operations', help='One or more fslmaths operations that are performed on the input image (before slicing it for the report). OPERATIONS is opaquely passed as is: `fslmaths inputimage OPERATIONS reportimage`. NB: Use quotes and include at least one space character to prevent overearly parsing, e.g. " -Tmean" or "-Tstd -s 3" (default: -Tmean)', default='-Tmean')
65+
parser.add_argument('--operations', help='One or more fslmaths operations that are performed on the input image (before slicing it for the report). OPERATIONS is opaquely passed as is: `fslmaths inputimage OPERATIONS reportimage`. NB: Use quotes and include at least one space character to prevent premature parsing, e.g. " -Tmean" or "-Tstd -s 3" (default: -Tmean)', default='-Tmean')
6666
parser.add_argument('--suboperations', help='The same as OPERATIONS but then for the sub-report instead of the main report: `fslmaths inputimage SUBOPERATIONS subreportimage` (default: -Tmean)', default='-Tmean')
6767
parser.add_argument('--options', help='Main options of slicer (see below). (default: "s 1")', default=['s','1'], nargs='+')
6868
parser.add_argument('--outputs', help='Output options of slicer (see below). (default: "x 0.4 x 0.5 x 0.6 y 0.4 y 0.5 y 0.6 z 0.4 z 0.5 z 0.6")', default=['x','0.4','x','0.5','x','0.6','y','0.4','y','0.5','y','0.6','z','0.4','z','0.5','z','0.6'], nargs='+')

docs/CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## [dev]
66

7+
## [4.3.1] - 2024-03-27
8+
79
### Added
810
- Update B0FieldIdentifier/Source when having multiple fieldmap runs (Github issue [#198](https://github.com/Donders-Institute/bidscoin/issues/198))
911
- Slicereport support for all nibabel file-formats
@@ -436,7 +438,8 @@ A first stable release of BIDScoin :-)
436438
### To do
437439
- Add support for non-imaging data
438440

439-
[dev]: https://github.com/Donders-Institute/bidscoin/compare/4.3.0...HEAD
441+
[dev]: https://github.com/Donders-Institute/bidscoin/compare/4.3.1...HEAD
442+
[4.3.1]: https://github.com/Donders-Institute/bidscoin/compare/4.3.0...4.3.1
440443
[4.3.0]: https://github.com/Donders-Institute/bidscoin/compare/4.2.1...4.3.0
441444
[4.2.1]: https://github.com/Donders-Institute/bidscoin/compare/4.2.0...4.2.1
442445
[4.2.0]: https://github.com/Donders-Institute/bidscoin/compare/4.1.1...4.2.0

docs/_static/dictionary-custom.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ AcquisitionTime
1111
Apptainer
1212
B0
1313
B0FieldIdentifier
14+
B0FieldIdentifiers
1415
B0FieldSource
1516
BEP024
1617
BIDSCOIN
@@ -237,7 +238,6 @@ nibabel
237238
nibabel2bids
238239
nr
239240
optimizations
240-
overearly
241241
p2
242242
parsable
243243
parsers
@@ -303,6 +303,7 @@ task2
303303
tempdir
304304
tooltip
305305
tooltips
306+
trackusage
306307
tsv
307308
underspecified
308309
unhandled

docs/bidsapps.rst

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ Before sharing or pre-processing their images, users may want to deface their an
6262
[-a ARGS] [-f]
6363
bidsfolder pattern
6464

65-
A wrapper around the 'pydeface' defacing tool (https://github.com/poldracklab/pydeface).
65+
A wrapper around the 'pydeface' defacing tool (https://github.com/poldracklab/pydeface). Pydeface
66+
requires an existing installation of FSL flirt
6667

6768
Except for BIDS inheritances and IntendedFor usage, this wrapper is BIDS-aware (a 'bidsapp')
6869
and writes BIDS compliant output
@@ -93,7 +94,7 @@ Before sharing or pre-processing their images, users may want to deface their an
9394
-n NATIVESPEC, --nativespec NATIVESPEC
9495
Opaque DRMAA argument with native specifications for submitting deface jobs
9596
to the HPC cluster (NB: Use quotes and include at least one space character
96-
to prevent overearly parsing) (default: -l walltime=00:30:00,mem=2gb)
97+
to prevent premature parsing) (default: -l walltime=00:30:00,mem=2gb)
9798
-a ARGS, --args ARGS Additional arguments (in dict/json-style) that are passed to pydeface (NB:
9899
Use quotes). See examples for usage (default: {})
99100
-f, --force Deface all images, regardless if they have already been defaced (i.e. if
@@ -118,7 +119,7 @@ This utility is very similar to the `deface <#defacing>`__ utility above, except
118119

119120
A wrapper around the 'pydeface' defacing tool (https://github.com/poldracklab/pydeface) that
120121
computes a defacing mask on a (temporary) echo-combined image and then applies it to each
121-
individual echo-image.
122+
individual echo-image. Pydeface requires an existing installation of FSL flirt
122123

123124
Except for BIDS inheritances and IntendedFor usage, this wrapper is BIDS-aware (a 'bidsapp')
124125
and writes BIDS compliant output
@@ -153,7 +154,7 @@ This utility is very similar to the `deface <#defacing>`__ utility above, except
153154
-n NATIVESPEC, --nativespec NATIVESPEC
154155
Opaque DRMAA argument with native specifications for submitting deface jobs
155156
to the HPC cluster (NB: Use quotes and include at least one space character
156-
to prevent overearly parsing) (default: -l walltime=00:30:00,mem=2gb)
157+
to prevent premature parsing) (default: -l walltime=00:30:00,mem=2gb)
157158
-a ARGS, --args ARGS Additional arguments (in dict/json-style) that are passed to pydeface (NB:
158159
Use quotes). See examples for usage (default: {})
159160
-f, --force Process all images, regardless if images have already been defaced (i.e. if
@@ -211,13 +212,13 @@ The ``skullstrip``-tool is a wrapper around the synthstrip tool that writes BIDS
211212
-f, --force Process images, regardless whether images have already been skullstripped
212213
(i.e. if {'SkullStripped': True} in the json sidecar file) (default: False)
213214
-a ARGS, --args ARGS Additional arguments that are passed to synthstrip (NB: Use quotes and
214-
include at least one space character to prevent overearly parsing) (default:)
215+
include at least one space character to prevent premature parsing) (default:)
215216
-c, --cluster Use the DRMAA library to submit the skullstrip jobs to a high-performance
216217
compute (HPC) cluster (default: False)
217218
-n NATIVESPEC, --nativespec NATIVESPEC
218219
Opaque DRMAA argument with native specifications for submitting skullstrip
219220
jobs to the HPC cluster (NB: Use quotes and include at least one space
220-
character to prevent overearly parsing) (default: -l walltime=0:05:00,mem=8gb)
221+
character to prevent premature parsing) (default: -l walltime=0:05:00,mem=8gb)
221222

222223
examples:
223224
skullstrip myproject/bids anat/*_T1w*
@@ -235,20 +236,21 @@ Quality control
235236
usage: slicereport [-h] [-o OUTLINEPATTERN] [-i OUTLINEIMAGE]
236237
[-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-r REPORTFOLDER]
237238
[-x XLINKFOLDER [XLINKFOLDER ...]] [-q QCSCORES [QCSCORES ...]]
238-
[-c {torque,slurm}] [--operations OPERATIONS] [--suboperations SUBOPERATIONS]
239-
[--options OPTIONS [OPTIONS ...]] [--outputs OUTPUTS [OUTPUTS ...]]
240-
[--suboptions SUBOPTIONS [SUBOPTIONS ...]]
239+
[-c {torque,slurm}] [-m MEM] [--operations OPERATIONS]
240+
[--suboperations SUBOPERATIONS] [--options OPTIONS [OPTIONS ...]]
241+
[--outputs OUTPUTS [OUTPUTS ...]] [--suboptions SUBOPTIONS [SUBOPTIONS ...]]
241242
[--suboutputs SUBOUTPUTS [SUBOUTPUTS ...]]
242243
bidsfolder pattern
243244

244-
A wrapper around the 'slicer' imaging tool (https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Miscvis)
245-
to generate a web page with a row of image slices for each subject in the BIDS repository, as
246-
well as individual sub-pages displaying more detailed information. The input images are
247-
selectable using wildcards, and the output images are configurable via various user options,
248-
allowing you to quickly create a custom 'slicer' report to do visual quality control on any
249-
3D/4D imagetype in your repository.
245+
A wrapper around the 'fslmaths' (https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Fslutils) and 'slicer'
246+
imaging tools (https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Miscvis) to generate a web page with a
247+
row of image slices for each subject in the BIDS repository, as well as individual sub-pages
248+
displaying more detailed information. The input images are selectable using wildcards (all
249+
nibabel image formats are supported), and the output images are configurable via various user
250+
options, allowing you to quickly create a custom 'slicer' report to do visual quality control
251+
on any 3D/4D imagetype in your repository.
250252

251-
Requires an existing installation of FSL
253+
Requires an existing installation of FSL tools (i.e. fsl-libvis, fsl-avwutils and fsl-flirt)
252254

253255
Set the environment variable BIDSCOIN_DEBUG=TRUE to save intermediate data
254256

@@ -282,11 +284,12 @@ Quality control
282284
-c {torque,slurm}, --cluster {torque,slurm}
283285
Use `torque` or `slurm` to submit the slicereport jobs to a high-performance
284286
compute (HPC) cluster
287+
-m MEM, --mem MEM The amount of requested memory in GB for the cluster jobs
285288
--operations OPERATIONS
286289
One or more fslmaths operations that are performed on the input image (before
287290
slicing it for the report). OPERATIONS is opaquely passed as is: `fslmaths
288291
inputimage OPERATIONS reportimage`. NB: Use quotes and include at least one
289-
space character to prevent overearly parsing, e.g. " -Tmean" or "-Tstd -s 3"
292+
space character to prevent premature parsing, e.g. " -Tmean" or "-Tstd -s 3"
290293
(default: -Tmean)
291294
--suboperations SUBOPERATIONS
292295
The same as OPERATIONS but then for the sub-report instead of the main
@@ -305,7 +308,7 @@ Quality control
305308

306309
OPTIONS:
307310
L : Label slices with slice number.
308-
l [LUT] : Use a different colour map from that specified in the header.
311+
l [LUT] : Use a different colour map from that specified in the header (see $FSLDIR/etc/luts)
309312
i [MIN] [MAX] : Specify intensity min and max for display range.
310313
e [THR] : Use the specified threshold for edges (if > 0 use this proportion of max-min,
311314
if < 0, use the absolute value)

0 commit comments

Comments
 (0)