Caelus3,462 checksGitHubv0.25.0MIT
API Reference / heliacal · function

Function: heliacal()

function heliacal(
   engine, 
   target, 
   jdStart, 
   latDeg, 
   lonDeg, 
   opts?): HeliacalEvent | null;

The next first or last visibility of a planet, a catalog star, or the Moon at or after jdStart from one place: the heliacal rising and setting, the evening and morning apparitions of Mercury and Venus, the new and old crescent, and (by the arcus method) the acronychal rising and cosmical setting.

Parameters

ParameterTypeDescription
engineEngineThe engine used to evaluate positions.
targetstringA planet id, "moon", or a catalog star name.
jdStartnumberSearch start, Julian Day (UT).
latDegnumberObserver latitude in degrees, north positive.
lonDegnumberObserver longitude in degrees, east positive.
optsHeliacalOptionsSee HeliacalOptions.

Returns

HeliacalEvent | null

The event, or null when none is found within the search span (about 830 days; 45 for the Moon).

Throws

Error for an unknown target, an event the target does not have, or the arcus method without an arcus visionis.

Example

// The heliacal rising of Sirius at Memphis in 139 CE
const ev = heliacal(engine, "Sirius", julianDay(139, 1, 1, 0, 0, 0, "julian"), 29.85, 31.25);
calendarDate(ev!.jd, "julian"); // the morning it is first seen
ev!.earliest; ev!.latest;       // under a clearer and a hazier sky

Start building

Quickstart →