API Reference / geolocate · function
Function: geolocate()
function geolocate(
engine,
jdUt,
observed,
opts?): GeolocateResult;
Estimate Earth locations compatible with physical observations at a fixed
UT Julian Day jdUt.
Uses Path A (method: "analytical", closed-form spherical celestial
navigation plus damped Gauss-Newton refinement) on flat ground whenever both
solar direction and solar elevation are observed, and Path B (method: "grid",
precomputed pure-trig global spherical grid with antimeridian-safe clustering
and local refinement) otherwise.
Parameters
| Parameter | Type | Description |
|---|---|---|
engine | Engine | Ephemeris engine instance. |
jdUt | number | Fixed observation instant, Julian Day (UT). |
observed | ObservedConstraints | Physical observation constraints (at least one required). |
opts | GeolocateOptions | Optional bounding box, grid step, candidate cap, elevation, terrain slope, and Bortle class. |
Returns
GeolocateResult with subsolar/sublunar points and ranked candidates.