antsImageMutualInformation: mutual information between two images
In stnava/ANTsR: ANTs in R: Quantification Tools for Biomedical Images

View source: R/antsImageMutualInformation.R

antsImageMutualInformation

R Documentation

mutual information between two images

Description

compute mutual information between two images

Usage

antsImageMutualInformation(in_image1, in_image2, sampling.percentage, nBins)

Arguments

`in_image1`	antsImage
`in_image2`	antsImage
`sampling.percentage`	value between zero and one determining ratio of points in image to use for metric estimation
`nBins`	number of bins to use in joint histogram estimate, often set between 8 and 32

Value

mutual information value

Author(s)

Brian B. Avants

Examples


fi <- antsImageRead(getANTsRData("r16"), 2)
mi <- antsImageRead(getANTsRData("r64"), 2)
testthat::expect_error(antsImageMutualInformation(fi, "hey"))
testthat::expect_error(antsImageMutualInformation("hey", fi))
fi3 <- resampleImage(fi, c(2, 2))
fi2 <- antsImageClone(fi)
pixeltype(fi2) <- "unsigned int"
testthat::expect_error(antsImageMutualInformation(fi2, mi))
testthat::expect_error(antsImageMutualInformation(fi3, mi))

stnava/ANTsR documentation built on April 16, 2024, 12:17 a.m.