ENTERPRISE (Enhanced Numerical Toolbox Enabling a Robust PulsaR Inference SuitE) is a pulsar timing analysis code, aimed at noise analysis, gravitational-wave searches, and timing model analysis.
There has some confusion over the keyword argument components in gp_priors.powerlaw.
In gp_signals.FourierBasisGP, the keyword argument components refers to the number of frequency bins in the GP model. In the GP basis functions like gp_bases.createfourierdesignmatrix_red, this same number of frequency bins is called nmodes.
The name components is used extensively in enterprise_extensions to refer to the number of frequency bins, too.
In gp_priors.powerlaw the keyword components=2 refers to the number of sinusoidal components at each frequency bin. This should always be two, for a sine and a cosine. Other powerlaw-like prior functions, turnover and broken_powerlaw, don't take this keyword argument at all. These functions hard code to 2 in the appropriate places. In practice the default is never changed, as far as I know.
Thanks to @danielreardon for pointing this out!
Should we remove the components=2 keyword from all powerlaw-like gp_priors? This would assume two sinusoidal components in all cases.
Should we rename nmodes to components in gp_bases? This would keep the same naming convention for the prior and basis functions.
Whoever makes changes related to this should add docstrings to the gp_priors functions, to explain what they do and when to use them!
There has some confusion over the keyword argument
componentsingp_priors.powerlaw.In
gp_signals.FourierBasisGP, the keyword argumentcomponentsrefers to the number of frequency bins in the GP model. In the GP basis functions likegp_bases.createfourierdesignmatrix_red, this same number of frequency bins is callednmodes.The name
componentsis used extensively inenterprise_extensionsto refer to the number of frequency bins, too.In
gp_priors.powerlawthe keywordcomponents=2refers to the number of sinusoidal components at each frequency bin. This should always be two, for a sine and a cosine. Other powerlaw-like prior functions,turnoverandbroken_powerlaw, don't take this keyword argument at all. These functions hard code to2in the appropriate places. In practice the default is never changed, as far as I know.Thanks to @danielreardon for pointing this out!
components=2keyword from all powerlaw-likegp_priors? This would assume two sinusoidal components in all cases.nmodestocomponentsingp_bases? This would keep the same naming convention for the prior and basis functions.Whoever makes changes related to this should add docstrings to the
gp_priorsfunctions, to explain what they do and when to use them!