splitMap: Split a 2D map given 5 reference points

In msxakk89/dat: Data Analyst Toolkit (dat): a library of tools for data analysts and scientists

Description

This function is an application of analytical geometry in order to split the map into "half" given 5 reference points. Given the line passing through points 1 and 2 and traingle vertices 3, 4 and 5 it computes the coefficients of line passing through circumcentre (3-4-5) and parallel to line (1-2).

Usage

splitMap(
  ref_coord_mx,
  applyAveraging = FALSE,
  whichRowsAreRefPoints = list(line = c(1, 2), triangle = c(3, 4, 5)),
  refRowNames = NULL,
  returnRich = FALSE
)

Arguments

ref_coord_mx	A matrix or data frame of reference point coordinates on 2D plan. Ensure that ref_coord_mx[,1] represents coordinates on X-axis while ref_coord_mx[,2] represents coordinates on Y-axis. If applyAveraging is FALSE ensure that ref_coord_mx[1:2,] represent reference points 1 and 2 thus points that are passed by reference line, while ref_coord_mx[3:5,] represents the vertices of traingle for which circumcentre will be computed. Note that other rows may be supplied and will be ignored.
applyAveraging	A boolean indicating whether to average the X-axis and Y-axis coordinates for the reference points if multiples of individual reference points are supplied. If set as TRUE pleasue set whichRowsAreRefPoints accordingly. Defults to FALSE.
whichRowsAreRefPoints	A list of lenght 2 where first elements is named as 'line' and is a numeric vector of reference points 1 and 2 in the order in which they appear at the top of ref_coord_mx, while second element is named 'triangle' and is a numeric vector of reference vertices 3, 4 and 5 in the order in which they appear right after the place holders of 'line'. Ensure 'line' coordinates are right at the top of ref_coord_mx followed strictly by 'triangle' coordinates. If non-reference data is intermixed with reference data at the top than 0 can be supplied for them and the application will be functional. Example usage: list(line=c(1,1,2,2,0,1),triangle=c(3,3,4,4,5)). Defults to list(line=c(1,2),triangle=c(3, 4, 5)).
refRowNames	An optional character vector of reference points names in their ascending order (1 -> 5). Defults to NULL.
returnRich	A boolean. Do you want the coordinates of split line only or other info such as cicumcentre coordinates and parallel line coordinates.

msxakk89/dat documentation built on Aug. 3, 2020, 6:39 p.m.