mirror/astronomy
1
0
Fork 0
mirror of https://github.com/cosinekitty/astronomy.git synced 2026-04-04 23:04:36 -04:00
Code Issues Packages Projects Releases Wiki Activity

Python: added documentation for function SearchPeakMagnitude.

Browse Source
This commit is contained in:
Don Cross
2019-07-19 21:05:19 -04:00
parent 972e43e952
commit f7bda9890c
3 changed files with 75 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
source/python/README.md
View File

@@ -868,6 +868,31 @@ followed by calls to #NextMoonQuarter as many times as desired.
---
<a name="SearchPeakMagnitude"></a>
### SearchPeakMagnitude(body, startTime)
**Searches for the date and time Venus will next appear brightest as seen from the Earth.**
This function searches for the date and time Venus appears brightest as seen from the Earth.
Currently only Venus is supported for the `body` parameter, though this could change in the future.
Mercury's peak magnitude occurs at superior conjunction, when it is virtually impossible to see
from the Earth, so peak magnitude events have little practical value for that planet.
Planets other than Venus and Mercury reach peak magnitude at opposition, which can
be found using #SearchRelativeLongitude.
The Moon reaches peak magnitude at full moon, which can be found using
#SearchMoonQuarter or #SearchMoonPhase.
The Sun reaches peak magnitude at perihelion, which occurs each year in January.
However, the difference is minor and has little practical value.
| Type | Parameter | Description |
| --- | --- | --- |
| [`Body`](#Body) | `body` | Currently only `Body.Venus` is allowed. Any other value results in an exception. See remarks above for more details. |
| [`Time`](#Time) | `startTime` | The date and time to start searching for the next peak magnitude event. |
### Returns: #IlluminationInfo
---
<a name="SearchRelativeLongitude"></a>
### SearchRelativeLongitude(body, targetRelLon, startTime)

25
source/python/astronomy.py
View File

@@ -4335,6 +4335,31 @@ def _mag_slope(body, time):
return (y2.mag - y1.mag) / dt
def SearchPeakMagnitude(body, startTime):
"""Searches for the date and time Venus will next appear brightest as seen from the Earth.
This function searches for the date and time Venus appears brightest as seen from the Earth.
Currently only Venus is supported for the `body` parameter, though this could change in the future.
Mercury's peak magnitude occurs at superior conjunction, when it is virtually impossible to see
from the Earth, so peak magnitude events have little practical value for that planet.
Planets other than Venus and Mercury reach peak magnitude at opposition, which can
be found using #SearchRelativeLongitude.
The Moon reaches peak magnitude at full moon, which can be found using
#SearchMoonQuarter or #SearchMoonPhase.
The Sun reaches peak magnitude at perihelion, which occurs each year in January.
However, the difference is minor and has little practical value.
Parameters
----------
body : Body
Currently only `Body.Venus` is allowed. Any other value results in an exception.
See remarks above for more details.
startTime : Time
The date and time to start searching for the next peak magnitude event.
Returns
-------
#IlluminationInfo
"""
# s1 and s2 are relative longitudes within which peak magnitude of Venus can occur.
s1 = 10.0
s2 = 30.0