@@ -87,7 +87,7 @@ cmtk.targetvolume.default <- function(target, ...) {
8787}
8888
8989# ' Reformat an image with a CMTK registration using the reformatx tool
90- # '
90+ # '
9191# ' @details Note that if you are reformatting a mask then you will need to
9292# ' change the interpolation to "nn", since interpolating between e.g. mask
9393# ' levels 72 and 74 with 73 may have unintended consequences. Presently we
@@ -97,37 +97,38 @@ cmtk.targetvolume.default <- function(target, ...) {
9797# ' @param registrations One or more CMTK format registrations on disk
9898# ' @param output The path to the output image (defaults to
9999# ' \code{"<targetstem>_<floatingstem>.nrrd"})
100- # ' @param mask Whether to treat target as a binary mask (only reformatting
100+ # ' @param mask Whether to treat target as a binary mask (only reformatting
101101# ' positive voxels)
102- # ' @param interpolation What interpolation scheme to use for output image
102+ # ' @param interpolation What interpolation scheme to use for output image
103103# ' (defaults to linear - see details)
104104# ' @param dryrun Just print command
105105# ' @param Verbose Whether to show cmtk status messages and be verbose about file
106106# ' update checks. Sets command line \code{--verbose} option.
107- # ' @param MakeLock Whether to use a lock file to allow simple parallelisation
108- # ' (see \code{makelock})
109- # ' @param OverWrite Whether to OverWrite an existing output file. One of
110- # ' c("no","update","yes"). When OverWrite='update'
111- # ' \code{\link{RunCmdForNewerInput}} is used to determine if the output is
112- # ' older than any of the input files.
113- # ' @param filesToIgnoreModTimes Input files whose modification time should not
107+ # ' @param MakeLock Whether to use a lock file to allow simple parallelisation
108+ # ' (see \code{\link[nat.utils]{ makelock} })
109+ # ' @param OverWrite Whether to OverWrite an existing output file. One of
110+ # ' c("no","update","yes"). When OverWrite='update'
111+ # ' \code{\link[nat.utils] {RunCmdForNewerInput}} is used to determine if the
112+ # ' output is older than any of the input files.
113+ # ' @param filesToIgnoreModTimes Input files whose modification time should not
114114# ' be checked when determining if new output is required.
115- # ' @param ... additional arguments passed to CMTK \code{reformatx} after
115+ # ' @param ... additional arguments passed to CMTK \code{reformatx} after
116116# ' processing by \code{\link{cmtk.call}}.
117117# ' @inheritParams cmtk.targetvolume
118118# ' @inheritParams xformimage.cmtkreg
119119# ' @importFrom nat.utils makelock removelock RunCmdForNewerInput
120- # ' @seealso \code{\link{cmtk.bindir}, \link{cmtk.call}, \link{makelock},
121- # ' \link{RunCmdForNewerInput}}
120+ # ' @seealso \code{\link{cmtk.bindir}}, \code{\link{cmtk.call}},
121+ # ' \code{\link[nat.utils]{makelock}},
122+ # ' \code{\link[nat.utils]{RunCmdForNewerInput}}
122123# ' @export
123- # ' @return the path to the output image (whether or not it was re-created afresh)
124- # ' or \code{NA_character_} if no output was possible.
124+ # ' @return the path to the output image (whether or not it was re-created
125+ # ' afresh) or \code{NA_character_} if no output was possible.
125126# ' @examples
126127# ' \dontrun{
127128# ' cmtk.reformatx('myimage.nrrd', target='template.nrrd',
128129# ' registrations='template_myimage.list')
129- # '
130- # ' # get full listing of command line options
130+ # '
131+ # ' # get full listing of command line options
131132# ' system(cmtk.call('reformatx', help=TRUE))
132133# ' }
133134cmtk.reformatx <- function (floating , registrations , output , target , mask = FALSE ,
0 commit comments