pint.templates.lcprimitives

Components of a pulsar light curve.

LCPrimitive and its subclasses implement components of a pulsar light curve. Includes primitives (Gaussian, Lorentzian), etc. as well as more sophisticated holistic templates that provide single-parameter (location) representations of the light curve.

author: M. Kerr <matthew.kerr@gmail.com>

Functions

approx_derivative(func, phases[, log10_ens, ...])

Return numerical derivative for LCPrimitive and LCTemplate objects.

approx_gradient(func, phases[, log10_ens, eps])

Return a numerical gradient for LCPrimitive and LCTemplate objects.

approx_hessian(func, phases[, log10_ens, eps])

Return a numerical hessian for LCPrimitive and LCTemplate objects.

check_derivative(func[, n, atol, rtol, ...])

Test derivative function with a set of MC photons.

check_gradient(func[, n, atol, rtol, quiet, ...])

Test gradient function with a set of MC photons.

convert_primitive(p1[, ptype])

Attempt to set the parameters of p2 to give a comparable primitive to p1.

isvector(x)

two_comp_mc(n, w1, w2, loc, func)

Generate MC photons from a two-sided distribution.

Classes

FastBessel([order])

Special class to quickly evaluate modified Bessel function.

LCEmpiricalFourier([phases, input_file])

Calculate a Fourier representation of the light curve.

LCGaussian(**kwargs)

Represent a (wrapped) Gaussian peak.

LCGaussian2(**kwargs)

Represent a (wrapped) two-sided Gaussian peak.

LCHarmonic(**kwargs)

Represent a sinusoidal shape corresponding to a harmonic in a Fourier expansion.

LCKernelDensity([phases, input_file])

Calculate a kernel density estimate of the light curve.

LCKing(**kwargs)

Represent a (wrapped) King function peak.

LCLorentzian(**kwargs)

Represent a (wrapped) Lorentzian peak.

LCLorentzian2(**kwargs)

Represent a (wrapped) two-sided Lorentzian peak.

LCPrimitive(**kwargs)

Base class for various components of a light curve.

LCSkewGaussian(**kwargs)

Represent a (wrapped) skew-normal (Gaussian) peak.

LCTopHat(**kwargs)

Represent a top hat function.

LCVonMises(**kwargs)

Represent a peak from the von Mises distribution.

LCWrappedFunction(**kwargs)

Super-class for profiles derived from wrapped functions.