man-roxygen/section-circlefit.R

In tiagodc/TreeLS: Terrestrial Point Cloud Processing of Forest Data

#' @section Least Squares Circle Fit:
#'
#' The circle fit methods applied in \emph{TreeLS} estimate the circle parameters (its center's XY coordinates and radius)
#' from a pre-selected (denoised) set of points in a least squares fashion
#' by applying either \href{https://en.wikipedia.org/wiki/QR_decomposition}{QR decompostion}, used in combination
#' with the RANSAC algorithm, or \href{https://en.wikipedia.org/wiki/Nelder-Mead_method}{Nelder-Mead simplex}
#' optimization combined the IRLS approach.
#'
#' The parameters returned by the circle fit methods are:
#' \itemize{
#'    \item \code{X,Y}: 2D circle center coordinates
#'    \item \code{Radius}: 2D circle radius, in point cloud units
#'    \item \code{Error}: model circle error from the least squares fit
#'    \item \code{AvgHeight}: average height of the stem segment's points
#'    \item \code{N}: number of points belonging to the stem segment
#'  }