From 5087e4df281f3a31a4b156594bd90ece53bc2542 Mon Sep 17 00:00:00 2001 From: Don Cross Date: Sun, 27 Nov 2022 13:56:51 -0500 Subject: [PATCH] More documentation fixes for rise/set, altitude. --- demo/browser/astronomy.browser.js | 6 +++--- demo/nodejs/astronomy.js | 6 +++--- demo/nodejs/calendar/astronomy.ts | 6 +++--- demo/python/astronomy.py | 4 ++-- generate/template/astronomy.c | 4 ++-- generate/template/astronomy.cs | 4 ++-- generate/template/astronomy.kt | 8 ++++---- generate/template/astronomy.py | 4 ++-- generate/template/astronomy.ts | 6 +++--- source/c/README.md | 4 ++-- source/c/astronomy.c | 4 ++-- source/csharp/README.md | 4 ++-- source/csharp/astronomy.cs | 4 ++-- source/js/README.md | 6 +++--- source/js/astronomy.browser.js | 6 +++--- source/js/astronomy.d.ts | 6 +++--- source/js/astronomy.js | 6 +++--- source/js/astronomy.ts | 6 +++--- source/js/esm/astronomy.js | 6 +++--- source/kotlin/README.md | 4 ++-- source/kotlin/doc/index.md | 4 ++-- source/kotlin/doc/search-altitude.md | 4 ++-- source/kotlin/doc/search-hour-angle.md | 4 ++-- .../kotlin/io/github/cosinekitty/astronomy/astronomy.kt | 8 ++++---- source/python/README.md | 4 ++-- source/python/astronomy/astronomy.py | 4 ++-- 26 files changed, 66 insertions(+), 66 deletions(-) diff --git a/demo/browser/astronomy.browser.js b/demo/browser/astronomy.browser.js index 6e0aa781..d6f3d80d 100644 --- a/demo/browser/astronomy.browser.js +++ b/demo/browser/astronomy.browser.js @@ -4946,7 +4946,7 @@ exports.SearchRiseSet = SearchRiseSet; /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5229,11 +5229,11 @@ class HourAngleEvent { } exports.HourAngleEvent = HourAngleEvent; /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/demo/nodejs/astronomy.js b/demo/nodejs/astronomy.js index 62d9811a..f022eef0 100644 --- a/demo/nodejs/astronomy.js +++ b/demo/nodejs/astronomy.js @@ -4945,7 +4945,7 @@ exports.SearchRiseSet = SearchRiseSet; /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5228,11 +5228,11 @@ class HourAngleEvent { } exports.HourAngleEvent = HourAngleEvent; /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/demo/nodejs/calendar/astronomy.ts b/demo/nodejs/calendar/astronomy.ts index df2a5cb3..dd2216a7 100644 --- a/demo/nodejs/calendar/astronomy.ts +++ b/demo/nodejs/calendar/astronomy.ts @@ -5493,7 +5493,7 @@ export function SearchRiseSet( /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5840,11 +5840,11 @@ export class HourAngleEvent { } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/demo/python/astronomy.py b/demo/python/astronomy.py index c0108ffe..3d374807 100644 --- a/demo/python/astronomy.py +++ b/demo/python/astronomy.py @@ -6505,11 +6505,11 @@ class HourAngleEvent: return 'HourAngleEvent({}, {})'.format(repr(self.time), repr(self.hor)) def SearchHourAngle(body, observer, hourAngle, startTime, direction = +1): - """Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + """Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, diff --git a/generate/template/astronomy.c b/generate/template/astronomy.c index a7f2f945..1b0c3a6f 100644 --- a/generate/template/astronomy.c +++ b/generate/template/astronomy.c @@ -6440,11 +6440,11 @@ astro_search_result_t Astronomy_SearchRelativeLongitude(astro_body_t body, doubl } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/generate/template/astronomy.cs b/generate/template/astronomy.cs index dd6bc5c6..05493753 100644 --- a/generate/template/astronomy.cs +++ b/generate/template/astronomy.cs @@ -6344,13 +6344,13 @@ $ASTRO_IAU_DATA() } /// - /// Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + /// Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. /// /// /// /// The *hour angle* of a celestial body indicates its position in the sky with respect /// to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - /// The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + /// The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. /// The hour angle increases by 1 unit for every sidereal hour that passes after that point, up /// to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates /// the number of hours that have passed since the most recent time that the body has culminated, diff --git a/generate/template/astronomy.kt b/generate/template/astronomy.kt index a1179920..3f3f7933 100644 --- a/generate/template/astronomy.kt +++ b/generate/template/astronomy.kt @@ -6199,11 +6199,11 @@ fun moonQuartersAfter(startTime: Time): Sequence = /** - * Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, @@ -6606,9 +6606,9 @@ fun searchRiseSet( } /** - * Finds the next time a body reaches a given altitude. + * Finds the next time the center of a body reaches a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight diff --git a/generate/template/astronomy.py b/generate/template/astronomy.py index a95ffcef..b9b0569a 100644 --- a/generate/template/astronomy.py +++ b/generate/template/astronomy.py @@ -4463,11 +4463,11 @@ class HourAngleEvent: return 'HourAngleEvent({}, {})'.format(repr(self.time), repr(self.hor)) def SearchHourAngle(body, observer, hourAngle, startTime, direction = +1): - """Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + """Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, diff --git a/generate/template/astronomy.ts b/generate/template/astronomy.ts index a8141a88..595de3c0 100644 --- a/generate/template/astronomy.ts +++ b/generate/template/astronomy.ts @@ -4487,7 +4487,7 @@ export function SearchRiseSet( /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -4834,11 +4834,11 @@ export class HourAngleEvent { } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/c/README.md b/source/c/README.md index e3daf385..5533c349 100644 --- a/source/c/README.md +++ b/source/c/README.md @@ -2446,11 +2446,11 @@ This function finds the first solar eclipse that occurs after `startTime`. A sol ### Astronomy_SearchHourAngleEx(body, observer, hourAngle, startTime, direction) ⇒ [`astro_hour_angle_t`](#astro_hour_angle_t) -**Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth.** +**Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth.** -The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, or reached its highest point. +The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, or reached its highest point. This function searches for the next or previous time a celestial body reaches the given hour angle relative to the date and time specified by `startTime`. To find when a body culminates, pass 0 for `hourAngle`. To find when a body reaches its lowest point in the sky, pass 12 for `hourAngle`. diff --git a/source/c/astronomy.c b/source/c/astronomy.c index 683f2f2d..b46a5154 100644 --- a/source/c/astronomy.c +++ b/source/c/astronomy.c @@ -7679,11 +7679,11 @@ astro_search_result_t Astronomy_SearchRelativeLongitude(astro_body_t body, doubl } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/csharp/README.md b/source/csharp/README.md index 35488077..5911a6f8 100644 --- a/source/csharp/README.md +++ b/source/csharp/README.md @@ -1813,11 +1813,11 @@ See [`Astronomy.GlobalSolarEclipsesAfter`](#Astronomy.GlobalSolarEclipsesAfter) ### Astronomy.SearchHourAngle(body, observer, hourAngle, startTime, direction) ⇒ [`HourAngleInfo`](#HourAngleInfo) -**Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth.** +**Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth.** The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. -The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. +The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/csharp/astronomy.cs b/source/csharp/astronomy.cs index 8b77e76b..2cc22616 100644 --- a/source/csharp/astronomy.cs +++ b/source/csharp/astronomy.cs @@ -7556,13 +7556,13 @@ namespace CosineKitty } /// - /// Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + /// Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. /// /// /// /// The *hour angle* of a celestial body indicates its position in the sky with respect /// to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - /// The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + /// The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. /// The hour angle increases by 1 unit for every sidereal hour that passes after that point, up /// to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates /// the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/js/README.md b/source/js/README.md index 4ce2ea04..e0413e8d 100644 --- a/source/js/README.md +++ b/source/js/README.md @@ -2683,7 +2683,7 @@ or even that the function will return `null`, indicating that no event was found occurs within the specified time window. **Brief**: Finds the next time the center of a body passes through a given altitude. -Finds when the given body ascends or descends through a given +Finds when the center of the given body ascends or descends through a given altitude angle, as seen by an observer at the specified location on the Earth. By using the appropriate combination of `direction` and `altitude` parameters, this function can be used to find when civil, nautical, or astronomical twilight @@ -2749,11 +2749,11 @@ passing in the `peak` value returned from the previous call. ## SearchHourAngle(body, observer, hourAngle, dateStart, direction) ⇒ [HourAngleEvent](#HourAngleEvent) **Kind**: global function -**Brief**: Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. +**Brief**: Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. -The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. +The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/js/astronomy.browser.js b/source/js/astronomy.browser.js index 6e0aa781..d6f3d80d 100644 --- a/source/js/astronomy.browser.js +++ b/source/js/astronomy.browser.js @@ -4946,7 +4946,7 @@ exports.SearchRiseSet = SearchRiseSet; /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5229,11 +5229,11 @@ class HourAngleEvent { } exports.HourAngleEvent = HourAngleEvent; /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/js/astronomy.d.ts b/source/js/astronomy.d.ts index 33f84796..bd24c674 100644 --- a/source/js/astronomy.d.ts +++ b/source/js/astronomy.d.ts @@ -1625,7 +1625,7 @@ export declare function SearchRiseSet(body: Body, observer: Observer, direction: /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -1710,11 +1710,11 @@ export declare class HourAngleEvent { constructor(time: AstroTime, hor: HorizontalCoordinates); } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/js/astronomy.js b/source/js/astronomy.js index 62d9811a..f022eef0 100644 --- a/source/js/astronomy.js +++ b/source/js/astronomy.js @@ -4945,7 +4945,7 @@ exports.SearchRiseSet = SearchRiseSet; /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5228,11 +5228,11 @@ class HourAngleEvent { } exports.HourAngleEvent = HourAngleEvent; /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/js/astronomy.ts b/source/js/astronomy.ts index df2a5cb3..dd2216a7 100644 --- a/source/js/astronomy.ts +++ b/source/js/astronomy.ts @@ -5493,7 +5493,7 @@ export function SearchRiseSet( /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5840,11 +5840,11 @@ export class HourAngleEvent { } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/js/esm/astronomy.js b/source/js/esm/astronomy.js index fdd9f170..7d210e4b 100644 --- a/source/js/esm/astronomy.js +++ b/source/js/esm/astronomy.js @@ -4884,7 +4884,7 @@ export function SearchRiseSet(body, observer, direction, dateStart, limitDays) { /** * @brief Finds the next time the center of a body passes through a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight @@ -5165,11 +5165,11 @@ export class HourAngleEvent { } } /** - * @brief Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * @brief Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/kotlin/README.md b/source/kotlin/README.md index c45489f4..0593c4c6 100644 --- a/source/kotlin/README.md +++ b/source/kotlin/README.md @@ -184,9 +184,9 @@ movement through the Solar System. | [rotationHorEqd](doc/rotation-hor-eqd.md)
fun [rotationHorEqd](doc/rotation-hor-eqd.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD). | | [rotationHorEqj](doc/rotation-hor-eqj.md)
fun [rotationHorEqj](doc/rotation-hor-eqj.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system (x=North, y=West, z=Zenith). Target: EQJ = equatorial system, using equator at the J2000 epoch. | | [search](doc/search.md)
fun [search](doc/search.md)(time1: [Time](doc/-time/index.md), time2: [Time](doc/-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](doc/-search-context/index.md)): [Time](doc/-time/index.md)?
Searches for a time at which a function's value increases through zero. | -| [searchAltitude](doc/search-altitude.md)
fun [searchAltitude](doc/search-altitude.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), direction: [Direction](doc/-direction/index.md), startTime: [Time](doc/-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](doc/-time/index.md)?
Finds the next time a body reaches a given altitude. | +| [searchAltitude](doc/search-altitude.md)
fun [searchAltitude](doc/search-altitude.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), direction: [Direction](doc/-direction/index.md), startTime: [Time](doc/-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](doc/-time/index.md)?
Finds the next time the center of a body reaches a given altitude. | | [searchGlobalSolarEclipse](doc/search-global-solar-eclipse.md)
fun [searchGlobalSolarEclipse](doc/search-global-solar-eclipse.md)(startTime: [Time](doc/-time/index.md)): [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)
Searches for a solar eclipse visible anywhere on the Earth's surface. | -| [searchHourAngle](doc/search-hour-angle.md)
fun [searchHourAngle](doc/search-hour-angle.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](doc/-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](doc/-hour-angle-info/index.md)
Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. | +| [searchHourAngle](doc/search-hour-angle.md)
fun [searchHourAngle](doc/search-hour-angle.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](doc/-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](doc/-hour-angle-info/index.md)
Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. | | [searchLocalSolarEclipse](doc/search-local-solar-eclipse.md)
fun [searchLocalSolarEclipse](doc/search-local-solar-eclipse.md)(startTime: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)
Searches for a solar eclipse visible at a specific location on the Earth's surface. | | [searchLunarApsis](doc/search-lunar-apsis.md)
fun [searchLunarApsis](doc/search-lunar-apsis.md)(startTime: [Time](doc/-time/index.md)): [ApsisInfo](doc/-apsis-info/index.md)
Finds the date and time of the Moon's perigee or apogee. | | [searchLunarEclipse](doc/search-lunar-eclipse.md)
fun [searchLunarEclipse](doc/search-lunar-eclipse.md)(startTime: [Time](doc/-time/index.md)): [LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)
Searches for a lunar eclipse. | diff --git a/source/kotlin/doc/index.md b/source/kotlin/doc/index.md index 0df528ba..da8ac18f 100644 --- a/source/kotlin/doc/index.md +++ b/source/kotlin/doc/index.md @@ -116,9 +116,9 @@ | [rotationHorEqd](rotation-hor-eqd.md)
fun [rotationHorEqd](rotation-hor-eqd.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD). | | [rotationHorEqj](rotation-hor-eqj.md)
fun [rotationHorEqj](rotation-hor-eqj.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system (x=North, y=West, z=Zenith). Target: EQJ = equatorial system, using equator at the J2000 epoch. | | [search](search.md)
fun [search](search.md)(time1: [Time](-time/index.md), time2: [Time](-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](-search-context/index.md)): [Time](-time/index.md)?
Searches for a time at which a function's value increases through zero. | -| [searchAltitude](search-altitude.md)
fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)?
Finds the next time a body reaches a given altitude. | +| [searchAltitude](search-altitude.md)
fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)?
Finds the next time the center of a body reaches a given altitude. | | [searchGlobalSolarEclipse](search-global-solar-eclipse.md)
fun [searchGlobalSolarEclipse](search-global-solar-eclipse.md)(startTime: [Time](-time/index.md)): [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)
Searches for a solar eclipse visible anywhere on the Earth's surface. | -| [searchHourAngle](search-hour-angle.md)
fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](-hour-angle-info/index.md)
Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. | +| [searchHourAngle](search-hour-angle.md)
fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](-hour-angle-info/index.md)
Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. | | [searchLocalSolarEclipse](search-local-solar-eclipse.md)
fun [searchLocalSolarEclipse](search-local-solar-eclipse.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)
Searches for a solar eclipse visible at a specific location on the Earth's surface. | | [searchLunarApsis](search-lunar-apsis.md)
fun [searchLunarApsis](search-lunar-apsis.md)(startTime: [Time](-time/index.md)): [ApsisInfo](-apsis-info/index.md)
Finds the date and time of the Moon's perigee or apogee. | | [searchLunarEclipse](search-lunar-eclipse.md)
fun [searchLunarEclipse](search-lunar-eclipse.md)(startTime: [Time](-time/index.md)): [LunarEclipseInfo](-lunar-eclipse-info/index.md)
Searches for a lunar eclipse. | diff --git a/source/kotlin/doc/search-altitude.md b/source/kotlin/doc/search-altitude.md index 36c41729..fba6a94c 100644 --- a/source/kotlin/doc/search-altitude.md +++ b/source/kotlin/doc/search-altitude.md @@ -4,9 +4,9 @@ fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)? -Finds the next time a body reaches a given altitude. +Finds the next time the center of a body reaches a given altitude. -Finds when the given body ascends or descends through a given altitude angle, as seen by an observer at the specified location on the Earth. By using the appropriate combination of direction and altitude parameters, this function can be used to find when civil, nautical, or astronomical twilight begins (dawn) or ends (dusk). +Finds when the center of the given body ascends or descends through a given altitude angle, as seen by an observer at the specified location on the Earth. By using the appropriate combination of direction and altitude parameters, this function can be used to find when civil, nautical, or astronomical twilight begins (dawn) or ends (dusk). Civil dawn begins before sunrise when the Sun ascends through 6 degrees below the horizon. To find civil dawn, pass Direction.Rise for direction and -6 for altitude. diff --git a/source/kotlin/doc/search-hour-angle.md b/source/kotlin/doc/search-hour-angle.md index 7906971c..473fe635 100644 --- a/source/kotlin/doc/search-hour-angle.md +++ b/source/kotlin/doc/search-hour-angle.md @@ -4,9 +4,9 @@ fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](-hour-angle-info/index.md) -Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. +Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. -The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, or reached its highest point. +The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, or reached its highest point. This function searches for the next time a celestial body reaches the given hour angle after the date and time specified by startTime. To find when a body culminates, pass 0 for hourAngle. To find when a body reaches its lowest point in the sky, pass 12 for hourAngle. diff --git a/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt b/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt index a08e23ed..f3cfa207 100644 --- a/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt +++ b/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt @@ -6199,11 +6199,11 @@ fun moonQuartersAfter(startTime: Time): Sequence = /** - * Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + * Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. * * The *hour angle* of a celestial body indicates its position in the sky with respect * to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - * The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + * The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. * The hour angle increases by 1 unit for every sidereal hour that passes after that point, up * to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates * the number of hours that have passed since the most recent time that the body has culminated, @@ -6606,9 +6606,9 @@ fun searchRiseSet( } /** - * Finds the next time a body reaches a given altitude. + * Finds the next time the center of a body reaches a given altitude. * - * Finds when the given body ascends or descends through a given + * Finds when the center of the given body ascends or descends through a given * altitude angle, as seen by an observer at the specified location on the Earth. * By using the appropriate combination of `direction` and `altitude` parameters, * this function can be used to find when civil, nautical, or astronomical twilight diff --git a/source/python/README.md b/source/python/README.md index eb1e1211..0a23db6c 100644 --- a/source/python/README.md +++ b/source/python/README.md @@ -2886,11 +2886,11 @@ passing in the `peak` value returned from the previous call. ### SearchHourAngle(body, observer, hourAngle, startTime, direction=1) -**Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth.** +**Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth.** The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. -The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. +The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated, diff --git a/source/python/astronomy/astronomy.py b/source/python/astronomy/astronomy.py index c0108ffe..3d374807 100644 --- a/source/python/astronomy/astronomy.py +++ b/source/python/astronomy/astronomy.py @@ -6505,11 +6505,11 @@ class HourAngleEvent: return 'HourAngleEvent({}, {})'.format(repr(self.time), repr(self.hor)) def SearchHourAngle(body, observer, hourAngle, startTime, direction = +1): - """Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. + """Searches for the time when the center of a body reaches a specified hour angle as seen by an observer on the Earth. The *hour angle* of a celestial body indicates its position in the sky with respect to the Earth's rotation. The hour angle depends on the location of the observer on the Earth. - The hour angle is 0 when the body reaches its highest angle above the horizon in a given day. + The hour angle is 0 when the body's center reaches its highest angle above the horizon in a given day. The hour angle increases by 1 unit for every sidereal hour that passes after that point, up to 24 sidereal hours when it reaches the highest point again. So the hour angle indicates the number of hours that have passed since the most recent time that the body has culminated,