Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 3.09 KB

File metadata and controls

26 lines (18 loc) · 3.09 KB

//astronomy/io.github.cosinekitty.astronomy/IlluminationInfo

IlluminationInfo

class IlluminationInfo(time: Time, mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double)

Information about the brightness and illuminated shape of a celestial body.

Returned by the functions illumination and searchPeakMagnitude to report the visual magnitude and illuminated fraction of a celestial body at a given date and time.

Constructors

IlluminationInfo
fun IlluminationInfo(time: Time, mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double)

Properties

Name Summary
helioDist
val helioDist: Double
The distance between the Sun and the body at the observation time.
mag
val mag: Double
The visual magnitude of the body. Smaller values are brighter.
phaseAngle
val phaseAngle: Double
The angle in degrees between the Sun and the Earth, as seen from the body. Indicates the body's phase as seen from the Earth.
phaseFraction
val phaseFraction: Double
A value in the range 0.0, 1.0 indicating what fraction of the body's apparent disc is illuminated, as seen from the Earth.
ringTilt
val ringTilt: Double
For Saturn, the tilt angle in degrees of its rings as seen from Earth. For all other bodies, 0.0.
time
val time: Time
The date and time of the observation.