API Reference

gadfly Package

Functions

plot_power_spectrum([ax, kernel, obs, freq, ...])

Plot a power spectrum.

Classes

Filter(identifier_or_filter[, download])	Convenience subclass for the tynt API for photometric filter transmittance curves.
GaussianProcess(kernel[, t, mean, light_curve])	The gadfly interface to the celerite2 Gaussian Process (GP) solver.
Hyperparameters(hyperparameters[, name, ...])	Gaussian process hyperparameters for approximating the total stellar irradiance power spectrum.
PowerSpectrum(frequency, power[, error, ...])	An observed power spectrum.
ShotNoiseKernel(*args[, name])	A subclass of SHOTerm which approximates shot noise in Kepler observations, for example.
SolarOscillatorKernel([texp, delta, ...])	Like a StellarOscillatorKernel, but initialized with the default solar SOHO VIRGO/PMO6 kernel hyperparameters.
StellarOscillatorKernel([hyperparameters, ...])	A sum of SHOTerm simple harmonic oscillator kernels generated by gadfly to approximate the total solar irradiance power spectrum.

Class Inheritance Diagram

digraph inheritance0069460b31 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseGaussianProcess" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="The main interface to the celerite2 Gaussian Process (GP) solver"]; "Filter" [URL="../api/gadfly.Filter.html#gadfly.Filter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Convenience subclass for the ``tynt`` API for photometric"]; "Filter" -> "Filter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Filter" [URL="https://tynt.readthedocs.io/en/latest/api/tynt.Filter.html#tynt.Filter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Astronomical filter."]; "GaussianProcess" [URL="https://celerite2.readthedocs.io/en/latest/api/python/#celerite2.GaussianProcess",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseGaussianProcess" -> "GaussianProcess" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GaussianProcess" [URL="../api/gadfly.GaussianProcess.html#gadfly.GaussianProcess",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The ``gadfly`` interface to the celerite2 Gaussian Process (GP) solver."]; "GaussianProcess" -> "GaussianProcess" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Hyperparameters" [URL="../api/gadfly.Hyperparameters.html#gadfly.Hyperparameters",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gaussian process hyperparameters for approximating"]; "PowerSpectrum" [URL="../api/gadfly.PowerSpectrum.html#gadfly.PowerSpectrum",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An observed power spectrum."]; "SHOTerm" [URL="https://celerite2.readthedocs.io/en/latest/api/python/#celerite2.terms.SHOTerm",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A term representing a stochastically-driven, damped harmonic oscillator"]; "Term" -> "SHOTerm" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ShotNoiseKernel" [URL="../api/gadfly.ShotNoiseKernel.html#gadfly.ShotNoiseKernel",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A subclass of :py:class:`~celerite2.terms.SHOTerm` which approximates"]; "SHOTerm" -> "ShotNoiseKernel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SolarOscillatorKernel" [URL="../api/gadfly.SolarOscillatorKernel.html#gadfly.SolarOscillatorKernel",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Like a :py:class:`~gadfly.core.StellarOscillatorKernel`, but initialized"]; "StellarOscillatorKernel" -> "SolarOscillatorKernel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StellarOscillatorKernel" [URL="../api/gadfly.StellarOscillatorKernel.html#gadfly.StellarOscillatorKernel",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A sum of :py:class:`~celerite2.terms.SHOTerm` simple harmonic oscillator"]; "TermConvolution" -> "StellarOscillatorKernel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Term" [URL="https://celerite2.readthedocs.io/en/latest/api/python/#celerite2.terms.Term",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The abstract base \"term\" that is the superclass of all other terms"]; "TermConvolution" [URL="https://celerite2.readthedocs.io/en/latest/api/python/#celerite2.terms.TermConvolution",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A term corresponding to the integral of another term over a boxcar"]; "Term" -> "TermConvolution" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

gadfly.scale Module

Functions

p_mode_amplitudes(mass, temperature, luminosity)	p-mode oscillation power amplitudes.
delta_nu(mass, radius)	Large frequency separation scaling.
nu_max(mass, temperature, radius)	Frequency of maximum power.
tau_eff(nu_max)	Characteristic granulation timescale.
tau_gran(mass, temperature, luminosity)	Granulation timescale scaling.
granulation_amplitude(mass, temperature, ...)	Granulation amplitude scaling.
c_K(temperature)	Bolometric correction factor as a function of effective temperature.
amplitude_with_wavelength(filter, temperature)	Scale power spectral feature amplitudes with wavelength and stellar effective temperature, compared to their amplitudes when observed with SOHO VIRGO/PMO6.