cc.offset: Function to calculate the distance at which the...

View source: R/Sncf2D.R

cc.offsetR Documentation

Function to calculate the distance at which the cross-correlation peaks for Sncf objects

Description

Alternative summary method for class "Sncf2D".

Usage

cc.offset(object, xmax = NULL)

Arguments

object

an object of class "Sncf2D", usually, as a result of a call to Sncf2D or spline.correlog2D.

xmax

the maximum distance to consider (default is no upper limit).

Value

An matrix of class "cc.offset" is returned with columns:

angle

the cardinal angle (in degrees).

distance

the distances (in the positive direction) to the mode of the (cross-) correlation function (with 95% confidence bounds).

correlation

the correlation at the mode (with CI) for each of the cardinal angles.

See Also

Sncf2D, summary.Sncf2D, plot.cc.offset


bjornsta/ncf documentation built on June 3, 2022, 11:43 a.m.