pint.utils.ELL1_check
- pint.utils.ELL1_check(A1: Unit('cm'), E: Unit(dimensionless), TRES: Unit('us'), NTOA: int, outstring=True)[source]
Check for validity of assumptions in ELL1 binary model
Checks whether the assumptions that allow ELL1 to be safely used are satisfied. To work properly, we should have: \(asini/c e^4 \ll {\rm timing precision} / \sqrt N_{\rm TOA}\) or \(A1 E^4 \ll TRES / \sqrt N_{\rm TOA}\)
since the ELL1 model now includes terms up to O(E^3)
- Parameters:
A1 (astropy.units.Quantity) – Projected semi-major axis (aka ASINI) in pint.ls
E (astropy.units.Quantity (dimensionless)) – Eccentricity
TRES (astropy.units.Quantity) – RMS TOA uncertainty
NTOA (int) – Number of TOAs in the fit
outstring (bool, optional) –
- Returns:
Returns True if ELL1 is safe to use, otherwise False. If outstring is True then returns a string summary instead.
- Return type: