GranulationKernel

class vspec_vsm.GranulationKernel(scale, period)

Bases: Kernel

GP Kernel to describe Granulation

Parameters:

  • scale (float) – A scalar coefficient for the kernel function.

  • period (float) – The period of the kernel in hours.

Notes

This kernel is based on [1].

References

[1]

Gordon, T. A., Agol, E., & Foreman-Mackey, D. 2020, AJ, 160, 240

Methods

__call__(X1[, X2])

Call self as a function.

evaluate(X1, X2)

Evaluate the kernel at a pair of input coordinates

evaluate_diag(X)

Evaluate the kernel on its diagonal

matmul

Methods Summary

evaluate(X1, X2)

Evaluate the kernel at a pair of input coordinates

Methods Documentation

evaluate(X1, X2)

Evaluate the kernel at a pair of input coordinates

This should be overridden be subclasses to return the kernel-specific value. Two things to note:

  1. Users shouldn’t generally call Kernel.evaluate(). Instead, always “call” the kernel instance directly; for example, you can evaluate the Matern-3/2 kernel using Matern32(1.5)(x1, x2), for arrays of input coordinates x1 and x2.

  2. When implementing a custom kernel, this method should treat X1 and X2 as single datapoints. In other words, these inputs will typically either be scalars of have shape n_dim, where n_dim is the number of input dimensions, rather than n_data or (n_data, n_dim), and you should let the Kernel vmap magic handle all the broadcasting for you.