Merge pull request #162 from ANTsX/n4maskdoc

DOC: Correct n3/n4 documentation re. mask
ANTsX · Mar 8, 2024 · ebe8d2b · ebe8d2b
2 parents 1c79a80 + 3d34797
commit ebe8d2b
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 35 deletions.
diff --git a/R/n3BiasFieldCorrection.R b/R/n3BiasFieldCorrection.R
@@ -28,7 +28,7 @@ n3BiasFieldCorrection <- function( img, downsampleFactor, ... ) {
 #' Perform N3 bias field correction on the given image
 #'
 #' @param img input antsImage
-#' @param mask input mask, if one is not passed one will be made
+#' @param mask input mask.  If not specified, the entire image will be used.
 #' @param rescaleIntensities At each iteration, a new intensity mapping is
 #' calculated and applied but there is nothing which constrains the new
 #' intensity range to be within certain values. The result is that the

diff --git a/R/n4BiasFieldCorrection.R b/R/n4BiasFieldCorrection.R
@@ -3,7 +3,7 @@
 #' Perform N4 bias field correction on the given image
 #'
 #' @param img input antsImage
-#' @param mask input mask, if one is not passed one will be made
+#' @param mask input mask.  If not specified, the entire image will be used.
 #' @param rescaleIntensities At each iteration, a new intensity mapping is
 #' calculated and applied but there is nothing which constrains the new
 #' intensity range to be within certain values. The result is that the

diff --git a/man/brackets.Rd b/man/brackets.Rd
diff --git a/man/labelClusters.Rd b/man/labelClusters.Rd
diff --git a/man/n3BiasFieldCorrection2.Rd b/man/n3BiasFieldCorrection2.Rd
diff --git a/man/n4BiasFieldCorrection.Rd b/man/n4BiasFieldCorrection.Rd
diff --git a/man/ripmmarcBasisImage.Rd b/man/ripmmarcBasisImage.Rd