comparison_allTogether {cmcR}

Performs all steps in the cell-based comparison procedure.

Description

Performs all steps in the cell-based comparison procedure.

Usage

comparison_allTogether(
  reference,
  target,
  theta = 0,
  numCells = c(8, 8),
  maxMissingProp = 0.85,
  sideLengthMultiplier = 3,
  returnX3Ps = FALSE
)

Arguments

reference

an x3p object containing a breech face scan to be treated as the "reference scan" partitioned into a grid of cells

target

an x3p object containing a breech face scan to be treated as the "target scan" that the reference scan's cells are compared to

theta

degrees that the target scan is to be rotated prior extracting regions.

numCells

a vector of two numbers representing the number of cells along the row and column dimensions into which the x3p is partitioned

maxMissingProp

maximum proportion of missing values allowed for each cell/region.

sideLengthMultiplier

ratio between the target region and reference cell side lengths. For example, sideLengthMultiplier = 3 implies each region will be 9 times larger than its paired reference cell.

returnX3Ps

boolean to return the cellHeightValues and alignedTargetCells for each cell index. Note that setting this argument to TRUE significantly increases the size of the returned object.

data(fadul1.1_processed,fadul1.2_processed)

comparisonDF <- comparison_allTogether(reference = fadul1.1_processed, target = fadul1.2_processed)

head(comparisonDF)

Value

a tibble object containing cell indices and the x, y, FFT-based CCF, and pairwise-complete correlation associated with the comparison between each cell and its associated target scan region (after rotating the target scan by theta degrees)

Examples

data(fadul1.1_processed,fadul1.2_processed)

cellTibble <- comparison_allTogether(reference = fadul1.1_processed,target = fadul1.2_processed)

head(cellTibble)