SummarizeMapping: Summarize the mapping obtained by GetMinMap

View source: R/SummarizeMapping.R

SummarizeMappingR Documentation

Summarize the mapping obtained by GetMinMap

Description

Returns a data frame outlining specifically the mapping between two paths, including all the inferred points, identifying the original points, and the distances between corresponding points/segments.

Usage

 SummarizeMapping(mapping)

Arguments

mapping

The output of GetMinMapping()

Details

This provides a detailed analysis of the outcome of a mapping, in the form of a seven-column data frame. An original path is transformed into a multi-segment path by adding intersections and 'opposite' points lying on segments.

Value

The first two columns indicate the index node of these two lengthened paths that correspond to one another. Odd nodes indicate points, and even nodes indicate segments (segments can be skipped). These correspond to rows and columns of the optimization matrix also returned by CreateMap and GetMinMapping.

The next two columns indicate how these rows are mapped back onto the original paths. 0 indicates the row was not an original point, non-zero integers indicate specific elements of the paths.

The next two column indicate the x,y coordinates on path 1 of each point (original or inferred). The following two columns indicate the x,y, coordinates on path 2. The final column indicates the euclidean distance corresponding to the particular mapping indicated.

Author(s)

Shane T. Mueller and Brandon Perelman


stmueller/pathmapping documentation built on Nov. 13, 2023, 12:39 p.m.