Caelus3,462 checksGitHubv0.25.0MIT
API Reference / HeliacalOptions · interface

Interface: HeliacalOptions

Options for heliacal.

Properties

PropertyTypeDescription
<a id="altm"></a> altM?numberObserver altitude in metres.
<a id="arcusvisionis"></a> arcusVisionis?numberThe arcus visionis in degrees; required by the arcus method.
<a id="extinction"></a> extinction?numberV-band extinction coefficient, magnitudes per air mass. Default 0.25.
<a id="kind"></a> kind?| "morning_first" | "evening_last" | "evening_first" | "morning_last" | "acronychal_rising" | "cosmical_setting" | "heliacal_rising" | "heliacal_setting"Which event. Defaults to "morning_first", the heliacal rising. "heliacal_rising" and "heliacal_setting" are accepted as names for "morning_first" and "evening_last".
<a id="method"></a> method?HeliacalMethod"visibility" (default) or "arcus".
<a id="span"></a> span?numberShorten the search to this many days past jdStart: a later event is not returned, and the engine is not asked for positions much beyond it. The default search runs about 830 days (45 for the Moon).
<a id="spread"></a> spread?numberHalf-width of the extinction range the event is recomputed over for earliest and latest. Default 0.05.

Start building

Quickstart →