extrapolate.matrix: Extrapolates or shrinks a matrix to according to the...

In arnejohannesholmin/sonR: Library for reading, processing and converting sonar data to the TSD format

Extrapolates or shrinks a matrix to according to the specifications given by 'a', 'b' and 'along'. If 'along' (defaulted to 0) is not in 1:nrow(x), 'a' and 'b' are interpreted as the number of rows to add at the beginning and at the end of the columns of the matrix (negative values imply shrinkage). If along is in in 1:nrow(x), 'a' and 'b' are interpreted as the desired lower and upper value to which the values of x[,along] are to be extrapolated by a simple linear expansion of the two first and the two last rows of 'x'. The column given by 'along' should be sorted.

Description

Extrapolates or shrinks a matrix to according to the specifications given by 'a', 'b' and 'along'. If 'along' (defaulted to 0) is not in 1:nrow(x), 'a' and 'b' are interpreted as the number of rows to add at the beginning and at the end of the columns of the matrix (negative values imply shrinkage). If along is in in 1:nrow(x), 'a' and 'b' are interpreted as the desired lower and upper value to which the values of x[,along] are to be extrapolated by a simple linear expansion of the two first and the two last rows of 'x'. The column given by 'along' should be sorted.

Usage

extrapolate.matrix(
  x,
  a = NULL,
  b = NULL,
  along = 0,
  grid = FALSE,
  byrow = FALSE,
  drop.out = TRUE
)

Arguments

x	is the input vector or matrix/data.frame. If 'x' is a vector, it is interpreted as a matrix/data.frame of one column
a, b	give the range to which the column given by 'along' is extrapolated/shrinked. If along is not in 1:nrow(x), 'a' and 'b' are interpreted as the number of rows to add at the beginning and at the end of the columns (negative values imply shrinkage). If b==NULL and 'a' has length > 1, the second element of 'a' is interpreted as 'b'.
along	is the column along which the extrapolation is specified.
grid	is TRUE if the first and the last row of the output are on the grid defined by the expansion.
byrow	is TRUE if the expansion/shrinkage is to be done on the rows instead of the columns.
drop.out	is TRUE if the output should be stripped of empty dimensions by the drop() function.

arnejohannesholmin/sonR documentation built on April 14, 2024, 11:39 p.m.