mirror of
https://github.com/cosinekitty/astronomy.git
synced 2026-03-30 20:34:16 -04:00
Python: Type Hints Integration - 5
This commit is contained in:
ris-tlp
@@ -1380,7 +1380,7 @@ Otherwise, returns `Body.Invalid`.
|
||||
---
|
||||
|
||||
<a name="CombineRotation"></a>
|
||||
### CombineRotation(a, b)
|
||||
### CombineRotation(a: astronomy.RotationMatrix, b: astronomy.RotationMatrix) -> astronomy.RotationMatrix
|
||||
|
||||
**Creates a rotation based on applying one rotation followed by another.**
|
||||
|
||||
@@ -1398,7 +1398,7 @@ The combined rotation matrix.
|
||||
---
|
||||
|
||||
<a name="Constellation"></a>
|
||||
### Constellation(ra, dec)
|
||||
### Constellation(ra: float, dec: float) -> astronomy.ConstellationInfo
|
||||
|
||||
**Determines the constellation that contains the given point in the sky.**
|
||||
|
||||
@@ -1617,7 +1617,7 @@ Equatorial coordinates in the specified frame of reference.
|
||||
---
|
||||
|
||||
<a name="EquatorFromVector"></a>
|
||||
### EquatorFromVector(vec)
|
||||
### EquatorFromVector(vec: astronomy.Vector) -> astronomy.Equatorial
|
||||
|
||||
**Given an equatorial vector, calculates equatorial angular coordinates.**
|
||||
|
||||
@@ -1839,7 +1839,7 @@ for more details.
|
||||
---
|
||||
|
||||
<a name="HorizonFromVector"></a>
|
||||
### HorizonFromVector(vector, refraction)
|
||||
### HorizonFromVector(vector: astronomy.Vector, refraction: astronomy.Refraction) -> astronomy.Spherical
|
||||
|
||||
**Converts Cartesian coordinates to horizontal coordinates.**
|
||||
|
||||
@@ -1890,7 +1890,7 @@ The hour angle is a number in the half-open range [0, 24).
|
||||
---
|
||||
|
||||
<a name="IdentityMatrix"></a>
|
||||
### IdentityMatrix()
|
||||
### IdentityMatrix() -> astronomy.RotationMatrix
|
||||
|
||||
**Creates an identity rotation matrix.**
|
||||
|
||||
@@ -1958,7 +1958,7 @@ This will be less than or equal to zero.
|
||||
---
|
||||
|
||||
<a name="InverseRotation"></a>
|
||||
### InverseRotation(rotation)
|
||||
### InverseRotation(rotation: astronomy.RotationMatrix) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates the inverse of a rotation matrix.**
|
||||
|
||||
@@ -2145,7 +2145,7 @@ Certain values of the angle have conventional definitions:
|
||||
---
|
||||
|
||||
<a name="NextGlobalSolarEclipse"></a>
|
||||
### NextGlobalSolarEclipse(prevEclipseTime)
|
||||
### NextGlobalSolarEclipse(prevEclipseTime: astronomy.Time) -> astronomy.GlobalSolarEclipseInfo
|
||||
|
||||
**Searches for the next global solar eclipse in a series.**
|
||||
|
||||
@@ -2164,7 +2164,7 @@ to find the next solar eclipse.
|
||||
---
|
||||
|
||||
<a name="NextLocalSolarEclipse"></a>
|
||||
### NextLocalSolarEclipse(prevEclipseTime, observer)
|
||||
### NextLocalSolarEclipse(prevEclipseTime: astronomy.Time, observer: astronomy.Observer) -> astronomy.LocalSolarEclipseInfo
|
||||
|
||||
**Searches for the next local solar eclipse in a series.**
|
||||
|
||||
@@ -2184,7 +2184,7 @@ to find the next solar eclipse.
|
||||
---
|
||||
|
||||
<a name="NextLunarApsis"></a>
|
||||
### NextLunarApsis(apsis)
|
||||
### NextLunarApsis(apsis: astronomy.Apsis) -> astronomy.Apsis
|
||||
|
||||
**Finds the next lunar perigee or apogee in a series.**
|
||||
|
||||
@@ -2203,7 +2203,7 @@ See [`SearchLunarApsis`](#SearchLunarApsis) for more details.
|
||||
---
|
||||
|
||||
<a name="NextLunarEclipse"></a>
|
||||
### NextLunarEclipse(prevEclipseTime)
|
||||
### NextLunarEclipse(prevEclipseTime: astronomy.Time) -> astronomy.LunarEclipseInfo
|
||||
|
||||
**Searches for the next lunar eclipse in a series.**
|
||||
|
||||
@@ -2256,7 +2256,7 @@ the one passed in as the parameter `mq`.
|
||||
---
|
||||
|
||||
<a name="NextPlanetApsis"></a>
|
||||
### NextPlanetApsis(body, apsis)
|
||||
### NextPlanetApsis(body: astronomy.Body, apsis: astronomy.Apsis) -> astronomy.Apsis
|
||||
|
||||
**Finds the next planetary perihelion or aphelion event in a series.**
|
||||
|
||||
@@ -2402,7 +2402,7 @@ An angle in degrees in the range [0, 360).
|
||||
---
|
||||
|
||||
<a name="Pivot"></a>
|
||||
### Pivot(rotation, axis, angle)
|
||||
### Pivot(rotation: astronomy.RotationMatrix, axis: int, angle: float) -> astronomy.RotationMatrix
|
||||
|
||||
**Re-orients a rotation matrix by pivoting it by an angle around one of its axes.**
|
||||
|
||||
@@ -2463,7 +2463,7 @@ option selected by the `refraction` parameter.
|
||||
---
|
||||
|
||||
<a name="RotateState"></a>
|
||||
### RotateState(rotation, state)
|
||||
### RotateState(rotation: astronomy.RotationMatrix, state: astronomy.StateVector) -> astronomy.StateVector
|
||||
|
||||
**Applies a rotation to a state vector, yielding a rotated state vector.**
|
||||
|
||||
@@ -2482,7 +2482,7 @@ A state vector in the orientation specified by `rotation`.
|
||||
---
|
||||
|
||||
<a name="RotateVector"></a>
|
||||
### RotateVector(rotation, vector)
|
||||
### RotateVector(rotation: astronomy.RotationMatrix, vector: astronomy.Vector) -> astronomy.Vector
|
||||
|
||||
**Applies a rotation to a vector, yielding a rotated vector.**
|
||||
|
||||
@@ -2523,7 +2523,7 @@ The body's north pole direction and angle of its prime meridian.
|
||||
---
|
||||
|
||||
<a name="Rotation_ECL_EQD"></a>
|
||||
### Rotation_ECL_EQD(time)
|
||||
### Rotation_ECL_EQD(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD).**
|
||||
|
||||
@@ -2542,7 +2542,7 @@ A rotation matrix that converts ECL to EQD.
|
||||
---
|
||||
|
||||
<a name="Rotation_ECL_EQJ"></a>
|
||||
### Rotation_ECL_EQJ()
|
||||
### Rotation_ECL_EQJ() -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ).**
|
||||
|
||||
@@ -2557,7 +2557,7 @@ A rotation matrix that converts ECL to EQJ.
|
||||
---
|
||||
|
||||
<a name="Rotation_ECL_HOR"></a>
|
||||
### Rotation_ECL_HOR(time, observer)
|
||||
### Rotation_ECL_HOR(time: astronomy.Time, observer: astronomy.Observer) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR).**
|
||||
|
||||
@@ -2583,7 +2583,7 @@ and so that north represents the direction where azimuth = 0.
|
||||
---
|
||||
|
||||
<a name="Rotation_ECT_EQD"></a>
|
||||
### Rotation_ECT_EQD(time)
|
||||
### Rotation_ECT_EQD(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from true ecliptic of date (ECT) to equator of date (EQD).**
|
||||
|
||||
@@ -2602,7 +2602,7 @@ A rotation matrix that converts ECT to EQD.
|
||||
---
|
||||
|
||||
<a name="Rotation_ECT_EQJ"></a>
|
||||
### Rotation_ECT_EQJ(time)
|
||||
### Rotation_ECT_EQJ(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from true ecliptic of date (ECT) to J2000 mean equator (EQJ).**
|
||||
|
||||
@@ -2621,7 +2621,7 @@ A rotation matrix that converts ECT to EQJ at `time`.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQD_ECL"></a>
|
||||
### Rotation_EQD_ECL(time)
|
||||
### Rotation_EQD_ECL(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL).**
|
||||
|
||||
@@ -2640,7 +2640,7 @@ A rotation matrix that converts EQD to ECL.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQD_ECT"></a>
|
||||
### Rotation_EQD_ECT(time)
|
||||
### Rotation_EQD_ECT(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from equator of date (EQD) to true ecliptic of date (ECT).**
|
||||
|
||||
@@ -2659,7 +2659,7 @@ A rotation matrix that converts EQD to ECT.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQD_EQJ"></a>
|
||||
### Rotation_EQD_EQJ(time)
|
||||
### Rotation_EQD_EQJ(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ).**
|
||||
|
||||
@@ -2678,7 +2678,7 @@ A rotation matrix that converts EQD at `time` to EQJ.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQD_HOR"></a>
|
||||
### Rotation_EQD_HOR(time, observer)
|
||||
### Rotation_EQD_HOR(time: astronomy.Time, observer: astronomy.Observer) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from equatorial of-date (EQD) to horizontal (HOR).**
|
||||
|
||||
@@ -2704,7 +2704,7 @@ and so that north represents the direction where azimuth = 0.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQJ_ECL"></a>
|
||||
### Rotation_EQJ_ECL()
|
||||
### Rotation_EQJ_ECL() -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL).**
|
||||
|
||||
@@ -2719,7 +2719,7 @@ A rotation matrix that converts EQJ to ECL.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQJ_ECT"></a>
|
||||
### Rotation_EQJ_ECT(time)
|
||||
### Rotation_EQJ_ECT(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean equator (EQJ) to true ecliptic of date (ECT).**
|
||||
|
||||
@@ -2738,7 +2738,7 @@ A rotation matrix that converts EQJ to ECT at `time`.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQJ_EQD"></a>
|
||||
### Rotation_EQJ_EQD(time)
|
||||
### Rotation_EQJ_EQD(time: astronomy.Time) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD).**
|
||||
|
||||
@@ -2757,7 +2757,7 @@ A rotation matrix that converts EQJ to EQD at `time`.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQJ_GAL"></a>
|
||||
### Rotation_EQJ_GAL()
|
||||
### Rotation_EQJ_GAL() -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL).**
|
||||
|
||||
@@ -2772,7 +2772,7 @@ A rotation matrix that converts EQJ to GAL.
|
||||
---
|
||||
|
||||
<a name="Rotation_EQJ_HOR"></a>
|
||||
### Rotation_EQJ_HOR(time, observer)
|
||||
### Rotation_EQJ_HOR(time: astronomy.Time, observer: astronomy.Observer) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR).**
|
||||
|
||||
@@ -2798,7 +2798,7 @@ and so that north represents the direction where azimuth = 0.
|
||||
---
|
||||
|
||||
<a name="Rotation_GAL_EQJ"></a>
|
||||
### Rotation_GAL_EQJ()
|
||||
### Rotation_GAL_EQJ() -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ).**
|
||||
|
||||
@@ -2813,7 +2813,7 @@ A rotation matrix that converts GAL to EQJ.
|
||||
---
|
||||
|
||||
<a name="Rotation_HOR_ECL"></a>
|
||||
### Rotation_HOR_ECL(time, observer)
|
||||
### Rotation_HOR_ECL(time: astronomy.Time, observer: astronomy.Observer) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL).**
|
||||
|
||||
@@ -2833,7 +2833,7 @@ A rotation matrix that converts HOR to ECL.
|
||||
---
|
||||
|
||||
<a name="Rotation_HOR_EQD"></a>
|
||||
### Rotation_HOR_EQD(time, observer)
|
||||
### Rotation_HOR_EQD(time: astronomy.Time, observer: astronomy.Observer) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD).**
|
||||
|
||||
@@ -2853,7 +2853,7 @@ A rotation matrix that converts HOR to EQD at `time` and for `observer`.
|
||||
---
|
||||
|
||||
<a name="Rotation_HOR_EQJ"></a>
|
||||
### Rotation_HOR_EQJ(time, observer)
|
||||
### Rotation_HOR_EQJ(time: astronomy.Time, observer: astronomy.Observer) -> astronomy.RotationMatrix
|
||||
|
||||
**Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ).**
|
||||
|
||||
@@ -2973,7 +2973,7 @@ this function returns that time. Otherwise, it returns `None`.
|
||||
---
|
||||
|
||||
<a name="SearchGlobalSolarEclipse"></a>
|
||||
### SearchGlobalSolarEclipse(startTime)
|
||||
### SearchGlobalSolarEclipse(startTime: astronomy.Time) -> astronomy.GlobalSolarEclipseInfo
|
||||
|
||||
**Searches for a solar eclipse visible anywhere on the Earth's surface.**
|
||||
|
||||
@@ -3028,7 +3028,7 @@ of the body at that time, as seen by the given observer.
|
||||
---
|
||||
|
||||
<a name="SearchLocalSolarEclipse"></a>
|
||||
### SearchLocalSolarEclipse(startTime, observer)
|
||||
### SearchLocalSolarEclipse(startTime: astronomy.Time, observer: astronomy.Observer) -> astronomy.LocalSolarEclipseInfo
|
||||
|
||||
Searches for a solar eclipse visible at a specific location on the Earth's surface.
|
||||
This function finds the first solar eclipse that occurs after `startTime`.
|
||||
@@ -3051,7 +3051,7 @@ See [`LocalSolarEclipseInfo`](#LocalSolarEclipseInfo) for more information about
|
||||
---
|
||||
|
||||
<a name="SearchLunarApsis"></a>
|
||||
### SearchLunarApsis(startTime)
|
||||
### SearchLunarApsis(startTime: astronomy.Time) -> astronomy.Apsis
|
||||
|
||||
**Finds the time of the first lunar apogee or perigee after the given time.**
|
||||
|
||||
@@ -3076,7 +3076,7 @@ another call of `NextLunarApsis` as many times as desired.
|
||||
---
|
||||
|
||||
<a name="SearchLunarEclipse"></a>
|
||||
### SearchLunarEclipse(startTime)
|
||||
### SearchLunarEclipse(startTime: astronomy.Time) -> astronomy.LunarEclipseInfo
|
||||
|
||||
**Searches for a lunar eclipse.**
|
||||
|
||||
@@ -3211,7 +3211,7 @@ However, the difference is minor and has little practical value.
|
||||
---
|
||||
|
||||
<a name="SearchPlanetApsis"></a>
|
||||
### SearchPlanetApsis(body, startTime)
|
||||
### SearchPlanetApsis(body: astronomy.Body, startTime: astronomy.Time) -> astronomy.Apsis
|
||||
|
||||
**Finds the next planet perihelion or aphelion, after a given time.**
|
||||
|
||||
@@ -3343,7 +3343,7 @@ It is recommended to keep the window smaller than 10 days when possible.
|
||||
---
|
||||
|
||||
<a name="SearchTransit"></a>
|
||||
### SearchTransit(body, startTime)
|
||||
### SearchTransit(body: astronomy.Body, startTime: astronomy.Time) -> astronomy.TransitInfo
|
||||
|
||||
**Searches for the first transit of Mercury or Venus after a given date.**
|
||||
|
||||
@@ -3363,7 +3363,7 @@ To continue the search, pass the `finish` time in the returned structure to
|
||||
---
|
||||
|
||||
<a name="Seasons"></a>
|
||||
### Seasons(year)
|
||||
### Seasons(year: int) -> astronomy.SeasonInfo
|
||||
|
||||
**Finds both equinoxes and both solstices for a given calendar year.**
|
||||
|
||||
@@ -3423,7 +3423,7 @@ GAST expressed in sidereal hours.
|
||||
---
|
||||
|
||||
<a name="SphereFromVector"></a>
|
||||
### SphereFromVector(vector)
|
||||
### SphereFromVector(vector: astronomy.Vector) -> astronomy.Spherical
|
||||
|
||||
**Converts Cartesian coordinates to spherical coordinates.**
|
||||
|
||||
@@ -3466,7 +3466,7 @@ The ecliptic coordinates of the Sun using the Earth's true equator of date.
|
||||
---
|
||||
|
||||
<a name="VectorFromHorizon"></a>
|
||||
### VectorFromHorizon(sphere, time, refraction)
|
||||
### VectorFromHorizon(sphere: astronomy.Spherical, time: astronomy.Time, refraction: astronomy.Refraction)
|
||||
|
||||
**Given apparent angular horizontal coordinates in `sphere`, calculate horizontal vector.**
|
||||
|
||||
@@ -3482,7 +3482,7 @@ A vector in the horizontal system: `x` = north, `y` = west, and `z` = zenith (up
|
||||
---
|
||||
|
||||
<a name="VectorFromSphere"></a>
|
||||
### VectorFromSphere(sphere, time)
|
||||
### VectorFromSphere(sphere: astronomy.Spherical, time: astronomy.Time) -> astronomy.Vector
|
||||
|
||||
**Converts spherical coordinates to Cartesian coordinates.**
|
||||
|
||||
|
||||
@@ -6509,13 +6509,13 @@ class SeasonInfo:
|
||||
dec_solstice : Time
|
||||
The date and time of the December solstice for the specified year.
|
||||
"""
|
||||
def __init__(self, mar_equinox, jun_solstice, sep_equinox, dec_solstice):
|
||||
def __init__(self, mar_equinox: Time, jun_solstice: Time, sep_equinox: Time, dec_solstice: Time) -> None:
|
||||
self.mar_equinox = mar_equinox
|
||||
self.jun_solstice = jun_solstice
|
||||
self.sep_equinox = sep_equinox
|
||||
self.dec_solstice = dec_solstice
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'SeasonInfo(mar_equinox={}, jun_solstice={}, sep_equinox={}, dec_solstice={})'.format(
|
||||
repr(self.mar_equinox),
|
||||
repr(self.jun_solstice),
|
||||
@@ -6531,7 +6531,7 @@ def _FindSeasonChange(targetLon, year, month, day):
|
||||
raise InternalError()
|
||||
return time
|
||||
|
||||
def Seasons(year):
|
||||
def Seasons(year: int) -> SeasonInfo:
|
||||
"""Finds both equinoxes and both solstices for a given calendar year.
|
||||
|
||||
The changes of seasons are defined by solstices and equinoxes.
|
||||
@@ -6636,20 +6636,20 @@ class Apsis:
|
||||
dist_km : float
|
||||
The distance between the centers of the bodies in kilometers.
|
||||
"""
|
||||
def __init__(self, time, kind, dist_au):
|
||||
def __init__(self, time: Time, kind: ApsisKind, dist_au: float) -> None:
|
||||
self.time = time
|
||||
self.kind = kind
|
||||
self.dist_au = dist_au
|
||||
self.dist_km = dist_au * KM_PER_AU
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'Apsis({}, {}, dist_au={})'.format(
|
||||
repr(self.time),
|
||||
self.kind,
|
||||
self.dist_au
|
||||
)
|
||||
|
||||
def SearchLunarApsis(startTime):
|
||||
def SearchLunarApsis(startTime: Time) -> Apsis:
|
||||
"""Finds the time of the first lunar apogee or perigee after the given time.
|
||||
|
||||
Given a date and time to start the search in `startTime`, this function finds
|
||||
@@ -6716,7 +6716,7 @@ def SearchLunarApsis(startTime):
|
||||
raise InternalError()
|
||||
|
||||
|
||||
def NextLunarApsis(apsis):
|
||||
def NextLunarApsis(apsis: Apsis) -> Apsis:
|
||||
"""Finds the next lunar perigee or apogee in a series.
|
||||
|
||||
This function requires an #Apsis value obtained from a call to
|
||||
@@ -6755,7 +6755,7 @@ def _planet_distance_slope(context, time):
|
||||
return direction * (dist2 - dist1) / dt
|
||||
|
||||
|
||||
def SearchPlanetApsis(body, startTime):
|
||||
def SearchPlanetApsis(body: Body, startTime: Time) -> Apsis:
|
||||
"""Finds the next planet perihelion or aphelion, after a given time.
|
||||
|
||||
Given a date and time to start the search in `startTime`, this function finds the
|
||||
@@ -6822,7 +6822,7 @@ def SearchPlanetApsis(body, startTime):
|
||||
raise InternalError() # should have found planet apsis within 2 planet orbits
|
||||
|
||||
|
||||
def NextPlanetApsis(body, apsis):
|
||||
def NextPlanetApsis(body: Body, apsis: Apsis) -> Apsis:
|
||||
"""Finds the next planetary perihelion or aphelion event in a series.
|
||||
|
||||
This function requires an #Apsis value obtained from a call
|
||||
@@ -6929,7 +6929,7 @@ def _BruteSearchPlanetApsis(body, startTime):
|
||||
raise InternalError() # failed to find Neptune apsis
|
||||
|
||||
|
||||
def VectorFromSphere(sphere, time):
|
||||
def VectorFromSphere(sphere: Spherical, time: Time) -> Vector:
|
||||
"""Converts spherical coordinates to Cartesian coordinates.
|
||||
|
||||
Given spherical coordinates and a time at which they are valid,
|
||||
@@ -6959,7 +6959,7 @@ def VectorFromSphere(sphere, time):
|
||||
)
|
||||
|
||||
|
||||
def EquatorFromVector(vec):
|
||||
def EquatorFromVector(vec: Vector) -> Equatorial:
|
||||
"""Given an equatorial vector, calculates equatorial angular coordinates.
|
||||
|
||||
Parameters
|
||||
@@ -6976,7 +6976,7 @@ def EquatorFromVector(vec):
|
||||
return Equatorial(sphere.lon / 15.0, sphere.lat, sphere.dist, vec)
|
||||
|
||||
|
||||
def SphereFromVector(vector):
|
||||
def SphereFromVector(vector: Vector) -> Spherical:
|
||||
"""Converts Cartesian coordinates to spherical coordinates.
|
||||
|
||||
Given a Cartesian vector, returns latitude, longitude, and distance.
|
||||
@@ -7018,7 +7018,7 @@ def _ToggleAzimuthDirection(az):
|
||||
return az
|
||||
|
||||
|
||||
def VectorFromHorizon(sphere, time, refraction):
|
||||
def VectorFromHorizon(sphere: Spherical, time: Time, refraction: Refraction):
|
||||
"""Given apparent angular horizontal coordinates in `sphere`, calculate horizontal vector.
|
||||
|
||||
Parameters
|
||||
@@ -7045,7 +7045,7 @@ def VectorFromHorizon(sphere, time, refraction):
|
||||
return VectorFromSphere(xsphere, time)
|
||||
|
||||
|
||||
def HorizonFromVector(vector, refraction):
|
||||
def HorizonFromVector(vector: Vector, refraction: Refraction) -> Spherical:
|
||||
"""Converts Cartesian coordinates to horizontal coordinates.
|
||||
|
||||
Given a horizontal Cartesian vector, returns horizontal azimuth and altitude.
|
||||
@@ -7079,7 +7079,7 @@ def HorizonFromVector(vector, refraction):
|
||||
return sphere
|
||||
|
||||
|
||||
def InverseRotation(rotation):
|
||||
def InverseRotation(rotation: RotationMatrix) -> RotationMatrix:
|
||||
"""Calculates the inverse of a rotation matrix.
|
||||
|
||||
Given a rotation matrix that performs some coordinate transform,
|
||||
@@ -7102,7 +7102,7 @@ def InverseRotation(rotation):
|
||||
])
|
||||
|
||||
|
||||
def CombineRotation(a, b):
|
||||
def CombineRotation(a: RotationMatrix, b: RotationMatrix) -> RotationMatrix:
|
||||
"""Creates a rotation based on applying one rotation followed by another.
|
||||
|
||||
Given two rotation matrices, returns a combined rotation matrix that is
|
||||
@@ -7145,7 +7145,7 @@ def CombineRotation(a, b):
|
||||
])
|
||||
|
||||
|
||||
def IdentityMatrix():
|
||||
def IdentityMatrix() -> RotationMatrix:
|
||||
"""Creates an identity rotation matrix.
|
||||
|
||||
Returns a rotation matrix that has no effect on orientation.
|
||||
@@ -7165,7 +7165,7 @@ def IdentityMatrix():
|
||||
])
|
||||
|
||||
|
||||
def Pivot(rotation, axis, angle):
|
||||
def Pivot(rotation: RotationMatrix, axis: int, angle: float) -> RotationMatrix:
|
||||
"""Re-orients a rotation matrix by pivoting it by an angle around one of its axes.
|
||||
|
||||
Given a rotation matrix, a selected coordinate axis, and an angle in degrees,
|
||||
@@ -7213,7 +7213,7 @@ def Pivot(rotation, axis, angle):
|
||||
j = (axis + 2) % 3
|
||||
k = axis
|
||||
|
||||
rot = [[0, 0, 0], [0, 0, 0], [0, 0, 0]]
|
||||
rot: List[List[float]] = [[0, 0, 0], [0, 0, 0], [0, 0, 0]]
|
||||
|
||||
rot[i][i] = c*rotation.rot[i][i] - s*rotation.rot[i][j]
|
||||
rot[i][j] = s*rotation.rot[i][i] + c*rotation.rot[i][j]
|
||||
@@ -7230,7 +7230,7 @@ def Pivot(rotation, axis, angle):
|
||||
return RotationMatrix(rot)
|
||||
|
||||
|
||||
def RotateVector(rotation, vector):
|
||||
def RotateVector(rotation: RotationMatrix, vector: Vector) -> Vector:
|
||||
"""Applies a rotation to a vector, yielding a rotated vector.
|
||||
|
||||
This function transforms a vector in one orientation to a vector
|
||||
@@ -7256,7 +7256,7 @@ def RotateVector(rotation, vector):
|
||||
)
|
||||
|
||||
|
||||
def RotateState(rotation, state):
|
||||
def RotateState(rotation: RotationMatrix, state: StateVector) -> StateVector:
|
||||
"""Applies a rotation to a state vector, yielding a rotated state vector.
|
||||
|
||||
This function transforms a state vector in one orientation to a
|
||||
@@ -7286,7 +7286,7 @@ def RotateState(rotation, state):
|
||||
)
|
||||
|
||||
|
||||
def Rotation_EQJ_ECL():
|
||||
def Rotation_EQJ_ECL() -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7309,7 +7309,7 @@ def Rotation_EQJ_ECL():
|
||||
])
|
||||
|
||||
|
||||
def Rotation_ECL_EQJ():
|
||||
def Rotation_ECL_EQJ() -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7331,7 +7331,7 @@ def Rotation_ECL_EQJ():
|
||||
[ 0, -s, +c]
|
||||
])
|
||||
|
||||
def Rotation_EQJ_EQD(time):
|
||||
def Rotation_EQJ_EQD(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7354,7 +7354,7 @@ def Rotation_EQJ_EQD(time):
|
||||
return CombineRotation(prec, nut)
|
||||
|
||||
|
||||
def Rotation_EQJ_ECT(time):
|
||||
def Rotation_EQJ_ECT(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean equator (EQJ) to true ecliptic of date (ECT).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7377,7 +7377,7 @@ def Rotation_EQJ_ECT(time):
|
||||
return CombineRotation(rot, step)
|
||||
|
||||
|
||||
def Rotation_ECT_EQJ(time):
|
||||
def Rotation_ECT_EQJ(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from true ecliptic of date (ECT) to J2000 mean equator (EQJ).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7400,7 +7400,7 @@ def Rotation_ECT_EQJ(time):
|
||||
return CombineRotation(rot, step)
|
||||
|
||||
|
||||
def Rotation_EQD_EQJ(time):
|
||||
def Rotation_EQD_EQJ(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7423,7 +7423,7 @@ def Rotation_EQD_EQJ(time):
|
||||
return CombineRotation(nut, prec)
|
||||
|
||||
|
||||
def Rotation_EQD_HOR(time, observer):
|
||||
def Rotation_EQD_HOR(time: Time, observer: Observer) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from equatorial of-date (EQD) to horizontal (HOR).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7468,7 +7468,7 @@ def Rotation_EQD_HOR(time, observer):
|
||||
])
|
||||
|
||||
|
||||
def Rotation_HOR_EQD(time, observer):
|
||||
def Rotation_HOR_EQD(time: Time, observer: Observer) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7492,7 +7492,7 @@ def Rotation_HOR_EQD(time, observer):
|
||||
return InverseRotation(rot)
|
||||
|
||||
|
||||
def Rotation_HOR_EQJ(time, observer):
|
||||
def Rotation_HOR_EQJ(time: Time, observer: Observer) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7517,7 +7517,7 @@ def Rotation_HOR_EQJ(time, observer):
|
||||
return CombineRotation(hor_eqd, eqd_eqj)
|
||||
|
||||
|
||||
def Rotation_EQJ_HOR(time, observer):
|
||||
def Rotation_EQJ_HOR(time: Time, observer: Observer) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7548,7 +7548,7 @@ def Rotation_EQJ_HOR(time, observer):
|
||||
return InverseRotation(rot)
|
||||
|
||||
|
||||
def Rotation_EQD_ECL(time):
|
||||
def Rotation_EQD_ECL(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7571,7 +7571,7 @@ def Rotation_EQD_ECL(time):
|
||||
return CombineRotation(eqd_eqj, eqj_ecl)
|
||||
|
||||
|
||||
def Rotation_ECL_EQD(time):
|
||||
def Rotation_ECL_EQD(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7593,7 +7593,7 @@ def Rotation_ECL_EQD(time):
|
||||
return InverseRotation(rot)
|
||||
|
||||
|
||||
def Rotation_ECL_HOR(time, observer):
|
||||
def Rotation_ECL_HOR(time: Time, observer: Observer) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7625,7 +7625,7 @@ def Rotation_ECL_HOR(time, observer):
|
||||
return CombineRotation(ecl_eqd, eqd_hor)
|
||||
|
||||
|
||||
def Rotation_HOR_ECL(time, observer):
|
||||
def Rotation_HOR_ECL(time: Time, observer: Observer) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7648,7 +7648,7 @@ def Rotation_HOR_ECL(time, observer):
|
||||
rot = Rotation_ECL_HOR(time, observer)
|
||||
return InverseRotation(rot)
|
||||
|
||||
def Rotation_EQJ_GAL():
|
||||
def Rotation_EQJ_GAL() -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7670,7 +7670,7 @@ def Rotation_EQJ_GAL():
|
||||
[-0.4838000529948520, +0.7470034631630423, +0.4559861124470794]
|
||||
])
|
||||
|
||||
def Rotation_GAL_EQJ():
|
||||
def Rotation_GAL_EQJ() -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7692,7 +7692,7 @@ def Rotation_GAL_EQJ():
|
||||
[-0.8676668813529025, -0.1980677870294097, +0.4559861124470794]
|
||||
])
|
||||
|
||||
def Rotation_ECT_EQD(time):
|
||||
def Rotation_ECT_EQD(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from true ecliptic of date (ECT) to equator of date (EQD).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7720,7 +7720,7 @@ def Rotation_ECT_EQD(time):
|
||||
[0.0, -s, +c]
|
||||
])
|
||||
|
||||
def Rotation_EQD_ECT(time):
|
||||
def Rotation_EQD_ECT(time: Time) -> RotationMatrix:
|
||||
"""Calculates a rotation matrix from equator of date (EQD) to true ecliptic of date (ECT).
|
||||
|
||||
This is one of the family of functions that returns a rotation matrix
|
||||
@@ -7769,13 +7769,13 @@ class ConstellationInfo:
|
||||
dec1875 : float
|
||||
Declination expressed in B1875 coordinates.
|
||||
"""
|
||||
def __init__(self, symbol, name, ra1875, dec1875):
|
||||
def __init__(self, symbol: str, name: str, ra1875: float, dec1875: float) -> None:
|
||||
self.symbol = symbol
|
||||
self.name = name
|
||||
self.ra1875 = ra1875
|
||||
self.dec1875 = dec1875
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'ConstellationInfo(symbol={}, name={}, ra1875={}, dec1875={})'.format(
|
||||
repr(self.symbol),
|
||||
repr(self.name),
|
||||
@@ -8240,7 +8240,7 @@ _ConstelBounds = (
|
||||
|
||||
|
||||
|
||||
def Constellation(ra, dec):
|
||||
def Constellation(ra: float, dec: float) -> ConstellationInfo:
|
||||
"""Determines the constellation that contains the given point in the sky.
|
||||
|
||||
Given J2000 equatorial (EQJ) coordinates of a point in the sky, determines the
|
||||
@@ -8487,7 +8487,7 @@ class LunarEclipseInfo:
|
||||
sd_total : float
|
||||
The semi-duration of the penumbral phase in minutes, or 0.0 if none.
|
||||
"""
|
||||
def __init__(self, kind, obscuration, peak, sd_penum, sd_partial, sd_total):
|
||||
def __init__(self, kind: EclipseKind, obscuration: float, peak: Time, sd_penum: float, sd_partial: float, sd_total: float) -> None:
|
||||
self.kind = kind
|
||||
self.obscuration = obscuration
|
||||
self.peak = peak
|
||||
@@ -8495,7 +8495,7 @@ class LunarEclipseInfo:
|
||||
self.sd_partial = sd_partial
|
||||
self.sd_total = sd_total
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'LunarEclipseInfo({}, obscuration={}, peak={}, sd_penum={}, sd_partial={}, sd_total={})'.format(
|
||||
self.kind,
|
||||
self.obscuration,
|
||||
@@ -8556,7 +8556,7 @@ class GlobalSolarEclipseInfo:
|
||||
longitude : float
|
||||
The geographic longitude at the center of the peak eclipse shadow.
|
||||
"""
|
||||
def __init__(self, kind, obscuration, peak, distance, latitude, longitude):
|
||||
def __init__(self, kind: EclipseKind, obscuration: float, peak: Time, distance: float, latitude: float, longitude: float) -> None:
|
||||
self.kind = kind
|
||||
self.obscuration = obscuration
|
||||
self.peak = peak
|
||||
@@ -8564,7 +8564,7 @@ class GlobalSolarEclipseInfo:
|
||||
self.latitude = latitude
|
||||
self.longitude = longitude
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'GlobalSolarEclipseInfo({}, obscuration={}, peak={}, distance={}, latitude={}, longitude={})'.format(
|
||||
self.kind,
|
||||
self.obscuration,
|
||||
@@ -8597,11 +8597,11 @@ class EclipseEvent:
|
||||
The angular altitude of the center of the Sun above/below the horizon, at `time`,
|
||||
corrected for atmospheric refraction and expressed in degrees.
|
||||
"""
|
||||
def __init__(self, time, altitude):
|
||||
def __init__(self, time: Time, altitude: float) -> None:
|
||||
self.time = time
|
||||
self.altitude = altitude
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'EclipseEvent({}, altitude={})'.format(
|
||||
repr(self.time),
|
||||
self.altitude
|
||||
@@ -8657,7 +8657,7 @@ class LocalSolarEclipseInfo:
|
||||
partial_end : EclipseEvent
|
||||
The time and Sun altitude at the end of the eclipse.
|
||||
"""
|
||||
def __init__(self, kind, obscuration, partial_begin, total_begin, peak, total_end, partial_end):
|
||||
def __init__(self, kind: EclipseKind, obscuration: float, partial_begin: EclipseEvent, total_begin: EclipseEvent, peak: EclipseEvent, total_end: EclipseEvent, partial_end: EclipseEvent) -> None:
|
||||
self.kind = kind
|
||||
self.obscuration = obscuration
|
||||
self.partial_begin = partial_begin
|
||||
@@ -8666,7 +8666,7 @@ class LocalSolarEclipseInfo:
|
||||
self.total_end = total_end
|
||||
self.partial_end = partial_end
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'LocalSolarEclipseInfo({}, obscuration={}, partial_begin={}, total_begin={}, peak={}, total_end={}, partial_end={})'.format(
|
||||
self.kind,
|
||||
self.obscuration,
|
||||
@@ -8925,7 +8925,7 @@ def _SolarEclipseObscuration(hm, lo):
|
||||
return min(0.9999, obscuration)
|
||||
|
||||
|
||||
def SearchLunarEclipse(startTime):
|
||||
def SearchLunarEclipse(startTime: Time) -> LunarEclipseInfo:
|
||||
"""Searches for a lunar eclipse.
|
||||
|
||||
This function finds the first lunar eclipse that occurs after `startTime`.
|
||||
@@ -8990,7 +8990,7 @@ def SearchLunarEclipse(startTime):
|
||||
raise Error('Failed to find lunar eclipse within 12 full moons.')
|
||||
|
||||
|
||||
def NextLunarEclipse(prevEclipseTime):
|
||||
def NextLunarEclipse(prevEclipseTime: Time) -> LunarEclipseInfo:
|
||||
"""Searches for the next lunar eclipse in a series.
|
||||
|
||||
After using #SearchLunarEclipse to find the first lunar eclipse
|
||||
@@ -9012,7 +9012,7 @@ def NextLunarEclipse(prevEclipseTime):
|
||||
return SearchLunarEclipse(startTime)
|
||||
|
||||
|
||||
def SearchGlobalSolarEclipse(startTime):
|
||||
def SearchGlobalSolarEclipse(startTime: Time) -> GlobalSolarEclipseInfo:
|
||||
"""Searches for a solar eclipse visible anywhere on the Earth's surface.
|
||||
|
||||
This function finds the first solar eclipse that occurs after `startTime`.
|
||||
@@ -9059,7 +9059,7 @@ def SearchGlobalSolarEclipse(startTime):
|
||||
raise Error('Failed to find solar eclipse within 12 full moons.')
|
||||
|
||||
|
||||
def NextGlobalSolarEclipse(prevEclipseTime):
|
||||
def NextGlobalSolarEclipse(prevEclipseTime: Time) -> GlobalSolarEclipseInfo:
|
||||
"""Searches for the next global solar eclipse in a series.
|
||||
|
||||
After using #SearchGlobalSolarEclipse to find the first solar eclipse
|
||||
@@ -9081,7 +9081,7 @@ def NextGlobalSolarEclipse(prevEclipseTime):
|
||||
return SearchGlobalSolarEclipse(startTime)
|
||||
|
||||
|
||||
def SearchLocalSolarEclipse(startTime, observer):
|
||||
def SearchLocalSolarEclipse(startTime: Time, observer: Observer) -> LocalSolarEclipseInfo:
|
||||
"""Searches for a solar eclipse visible at a specific location on the Earth's surface.
|
||||
This function finds the first solar eclipse that occurs after `startTime`.
|
||||
A solar eclipse may be partial, annular, or total.
|
||||
@@ -9136,7 +9136,7 @@ def SearchLocalSolarEclipse(startTime, observer):
|
||||
nmtime = newmoon.AddDays(10.0)
|
||||
|
||||
|
||||
def NextLocalSolarEclipse(prevEclipseTime, observer):
|
||||
def NextLocalSolarEclipse(prevEclipseTime: Time, observer: Observer) -> LocalSolarEclipseInfo:
|
||||
"""Searches for the next local solar eclipse in a series.
|
||||
|
||||
After using #SearchLocalSolarEclipse to find the first solar eclipse
|
||||
@@ -9184,13 +9184,13 @@ class TransitInfo:
|
||||
The minimum angular separation, in arcminutes, between the centers of the Sun and the planet.
|
||||
This angle pertains to the time stored in `peak`.
|
||||
"""
|
||||
def __init__(self, start, peak, finish, separation):
|
||||
def __init__(self, start: Time, peak: Time, finish: Time, separation: float) -> None:
|
||||
self.start = start
|
||||
self.peak = peak
|
||||
self.finish = finish
|
||||
self.separation = separation
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return 'TransitInfo(start={}, peak={}, finish={}, separation={})'.format(
|
||||
repr(self.start),
|
||||
repr(self.peak),
|
||||
@@ -9214,7 +9214,7 @@ def _PlanetTransitBoundary(body, planet_radius_km, t1, t2, direction):
|
||||
return tx
|
||||
|
||||
|
||||
def SearchTransit(body, startTime):
|
||||
def SearchTransit(body: Body, startTime: Time) -> TransitInfo:
|
||||
"""Searches for the first transit of Mercury or Venus after a given date.
|
||||
|
||||
Finds the first transit of Mercury or Venus after a specified date.
|
||||
|
||||
Reference in New Issue
Block a user