mirror/astronomy
1
0
Fork 0
mirror of https://github.com/cosinekitty/astronomy.git synced 2026-05-19 06:17:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes for VectorObserver functions.

Browse Source
This commit is contained in:
Don Cross
2021-06-21 20:23:33 -04:00
parent 6060a36b09
commit 8abda4ea30
25 changed files with 3949 additions and 3862 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
source/python/README.md
View File

@@ -31,13 +31,19 @@ To get started quickly, here are some [examples](../../demo/python/).
| -------- | ----------- |
| [HelioVector](#HelioVector) | Calculates body position vector with respect to the center of the Sun. |
| [GeoVector](#GeoVector) | Calculates body position vector with respect to the center of the Earth. |
| [ObserverVector](#ObserverVector) | Calculates vector from the center of the Earth to an observer on the Earth's surface. |
| [Equator](#Equator) | Calculates right ascension and declination. |
| [Ecliptic](#Ecliptic) | Converts J2000 equatorial coordinates to J2000 ecliptic coordinates. |
| [EclipticLongitude](#EclipticLongitude) | Calculates ecliptic longitude of a body in the J2000 system. |
| [Horizon](#Horizon) | Calculates horizontal coordinates (azimuth, altitude) for a given observer on the Earth. |
| [PairLongitude](#PairLongitude) | Calculates the difference in apparent ecliptic longitude between two bodies, as seen from the Earth. |
### Geographic helper functions
| Function | Description |
| -------- | ----------- |
| [ObserverVector](#ObserverVector) | Calculates a vector from the center of the Earth to an observer on the Earth's surface. |
| [VectorObserver](#VectorObserver) | Calculates the geographic coordinates for a geocentric equatorial vector. |
### Rise, set, and culmination times
| Function | Description |
@@ -1625,6 +1631,7 @@ equator at the specified time, or `False` to use the J2000 equator.
The returned vector has components expressed in astronomical units (AU).
To convert to kilometers, multiply the `x`, `y`, and `z` values by
the constant value [`KM_PER_AU`](#KM_PER_AU).
The inverse of this function is also available: [`VectorObserver`](#VectorObserver).
| Type | Parameter | Description |
| --- | --- | --- |
@@ -2574,8 +2581,8 @@ The vector form of the supplied spherical coordinates.
**Calculates the geographic location corresponding to an equatorial vector.**
This is the inverse function of [`ObserverVector`](#ObserverVector).
Instead of converting an [`Observer`](#Observer) to a [`Vector`](#Vector), it converts
a `Vector` to an `Observer`.
Given a geocentric equatorial vector, it returns the geographic
latitude, longitude, and elevation for that vector.
| Type | Parameter | Description |
| --- | --- | --- |

6
source/python/astronomy.py
View File

@@ -4267,6 +4267,8 @@ def ObserverVector(time, observer, ofdate):
To convert to kilometers, multiply the `x`, `y`, and `z` values by
the constant value #KM_PER_AU.
The inverse of this function is also available: #VectorObserver.
Parameters
----------
time : Time
@@ -4298,8 +4300,8 @@ def VectorObserver(vector, ofdate):
"""Calculates the geographic location corresponding to an equatorial vector.
This is the inverse function of #ObserverVector.
Instead of converting an #Observer to a #Vector, it converts
a `Vector` to an `Observer`.
Given a geocentric equatorial vector, it returns the geographic
latitude, longitude, and elevation for that vector.
Parameters
----------