API Reference / solarEclipseLocal · function
Function: solarEclipseLocal()
function solarEclipseLocal(
engine,
jd,
latDeg,
lonEastDeg,
altM?): SolarLocal;
Local circumstances of a solar eclipse as seen from one place: contact times, magnitude, and obscuration. Topocentric Sun and Moon disks, so it accounts for lunar parallax (which is what makes the same eclipse total in one town and partial in the next).
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
engine | Engine | undefined | The engine used to evaluate positions. |
jd | number | undefined | A time near the eclipse, JD (UT) -- typically a SolarEclipse.tMax; the local maximum is found within a few hours. |
latDeg | number | undefined | Observer geodetic latitude in degrees (north positive). |
lonEastDeg | number | undefined | Observer longitude in degrees (east positive). |
altM | number | 0 | Observer height above the ellipsoid in metres (default 0). |
Returns
SolarLocal. type is "none" when the Sun is not eclipsed
from this place at all; c2/c3 are null outside totality/annularity.