Caelus3,462 checksGitHubv0.25.0MIT
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

ParameterTypeDescription
engineEngineEphemeris engine instance.
jdUtnumberFixed observation instant, Julian Day (UT).
observedObservedConstraintsPhysical observation constraints (at least one required).
optsGeolocateOptionsOptional bounding box, grid step, candidate cap, elevation, terrain slope, and Bortle class.

Returns

GeolocateResult

GeolocateResult with subsolar/sublunar points and ranked candidates.

Start building

Quickstart →