dcf: Run Discrete Correlation Function

In Starkiller4011/AstroR: Statsistical methods for X-ray astronomy with R

Description

Runs a discrete correlation function on the input light curves following Edelson & Krolik 1988, using https://github.com/svdataman/sour

Usage

dcf(base, compare, beta, bin.width = 1, nsims = 10)

Arguments

base	required data frame: Light curve data frame to use as base for DCF. Expects structure: TIME, TIMED, RATE, ERROR, BACKV, BACKE
compare	required data frame: Light curve data frame to compare to base for DCF. Expects structure: TIME, TIMED, RATE, ERROR, BACKV, BACKE
beta	required numeric: PSD slope to use when simmulating light curves, should be the PSD slope of compare
bin.width	optional numeric: DCF bin widths for binning of the final DCF
nsims	optional numeric: number of simulations to run for DCF confidence contours

Value

DCF data frame with strcture: tau, dcf, p90, p95, p99, n90, n95, n99

Author(s)

Derek Blue

Examples

## Not run: 
xmm.lc <- xmm.pn.lc(xmm.pn.file.path)
xmm.uv.lc <- xmm.uvw1.lc(xmm.uvw1.file.path)
dcf <- run.dcf(xmm.uv.lc, xmm.lc, beta, bin.width = 1, nsims = 10)

## End(Not run)

Starkiller4011/AstroR documentation built on Aug. 24, 2020, 12:41 p.m.