pyPDAF.PDAF.correlation_function

pyPDAF.PDAF.correlation_function()

The value of the chosen correlation function according to the specified length scale.

Parameters:

  • ctype (int) – Type of correlation function * ctype=1: Gaussian with f(0)=1.0 * ctype=2: 5th-order polynomial (Gaspace/Cohn, 1999)

  • length (double) – Length scale of function * ctype=1: standard deviation * ctype=2: support length f=0 for distance>length

  • distance (double) – Distance at which the function is evaluated

Returns:

value – Value of the function

Return type:

double