% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/shape.R
\name{get_torsion}
\alias{get_torsion}
\title{Torsion of a streamline}
\usage{
get_torsion(x)
}
\arguments{
\item{x}{A \link{streamline} object.}
}
\value{
A numeric vector of length \code{x@n_points} giving the torsion
\eqn{\tau(s)} at each sampled point along the streamline. Positive values
indicate right-handed twisting; negative values indicate left-handed
twisting; zero indicates a planar curve at that location.
}
\description{
\code{get_torsion()} is function that computes the torsion of a
\link{streamline} object. The torsion \eqn{\tau(s)} at each point
along the arc-length abscissa is computed using cubic smoothing
splines (4 degrees of freedom per component).
}
\examples{
pts <- matrix(runif(30), ncol = 3)
colnames(pts) <- c("X", "Y", "Z")
sl <- streamline(points = pts)
get_torsion(sl)
}
