antsrMetricCreate: antsrMetricCreate

View source: R/antsrMetric_class.R

antsrMetricCreateR Documentation

antsrMetricCreate

Description

create object that measures similarity between two images

Usage

antsrMetricCreate(
  fixed,
  moving,
  type = c("MeanSquares", "MattesMutualInformation", "ANTSNeighborhoodCorrelation",
    "Correlation", "Demons", "JointHistogramMutualInformation"),
  fixed.mask = NULL,
  moving.mask = NULL,
  sampling.strategy = "none",
  sampling.percentage = 1,
  nBins = 32,
  radius = 3
)

Arguments

fixed

the fixed antsImage

moving

the moving antsImage

type

image metric to calculate

MeanSquares
Correlation
ANTSNeighborhoodCorrelation
MattesMutualInformation
JointHistogramMutualInformation
Demons
fixed.mask

mask for the fixed image

moving.mask

mask for the moving image

sampling.strategy

sampling strategy, default if full sampling

none

Full sampling

random
regular
sampling.percentage

percentage of data to sample when calculating metric

nBins

number of bins for histogram metrics (default = 32)

radius

radius for neighborhoo metrics (default = 3)

Value

value of image to image metric

Examples

x <- antsImageRead(getANTsRData("r16"))
y <- antsImageRead(getANTsRData("r30"))
metric <- antsrMetricCreate(x, y, type = "MeanSquares")

stnava/ANTsR documentation built on April 13, 2025, 4:10 a.m.