restrict: restrict a landmark config or mesh to probabilistic bounds...

View source: R/restrict.deform.r

restrictR Documentation

restrict a landmark config or mesh to probabilistic bounds from a sample of landmarks/vertices

Description

restrict a landmark config or mesh to probabilistic bounds from a sample of landmarks/vertices

Usage

restrict(
  x,
  model,
  sd = 3,
  maxVar = 95,
  scale = FALSE,
  nPC = NULL,
  probab = FALSE,
  reference = NULL
)

## S3 method for class 'mesh3d'
restrict(
  x,
  model,
  sd = 3,
  maxVar = 95,
  scale = FALSE,
  nPC = NULL,
  probab = FALSE,
  reference = NULL
)

## S3 method for class 'matrix'
restrict(
  x,
  model,
  sd = 3,
  maxVar = 95,
  scale = FALSE,
  nPC = NULL,
  probab = FALSE,
  reference = NULL
)

Arguments

x

matrix or triangular mesh of class "mesh3d"

model

object of class "nosymproc" (output from procSym run on a set of corresponding landmarks/vertices), serving as a priori knowledge about vertex/landmark distribution.

sd

standard deviation of PCscores defining boundaries

maxVar

percentage to be explained by the PCs used for the restriction. E.g. if you want to include PCs explaining 95% of the variance, set maxVar=95.

scale

logical: if FALSE, configuration will be restricted within a probablistic hypercube, otherwise Chi-Square distribution will be used.

nPC

number of PCs used in restricting (overrides maxVar)

probab

if TRUE only the probability will be returned.

reference

integer vector specifiying those landmarks that should be set to meanshape

Value

restricted landmarks/mesh


zarquon42b/mesheR documentation built on Jan. 28, 2024, 2:17 p.m.