Package org.shredzone.commons.suncalc

Class MoonIllumination

java.lang.Object

org.shredzone.commons.suncalc.MoonIllumination

public class MoonIllumination
extends Object

Calculates the illumination of the moon.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MoonIllumination.Parameters	Collects all parameters for MoonIllumination.

Method Summary

Modifier and Type	Method	Description
static MoonIllumination.Parameters	compute()	Starts the computation of MoonIllumination.
double	getAngle()	The angle of the moon illumination relative to earth.
MoonPhase.Phase	getClosestPhase()	The closest MoonPhase.Phase that is matching the moon's angle.
double	getFraction()	Illuminated fraction.
double	getPhase()	Moon phase.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

compute

public static MoonIllumination.Parameters compute()

Starts the computation of MoonIllumination.

Returns:

MoonIllumination.Parameters to set.

getFraction

public double getFraction()

Illuminated fraction. 0.0 indicates new moon, 1.0 indicates full moon.

getPhase

public double getPhase()

Moon phase. Starts at -180.0 (new moon, waxing), passes 0.0 (full moon) and moves toward 180.0 (waning, new moon).

Note that for historical reasons, the range of this phase is different to the moon phase angle used in MoonPhase.

getAngle

public double getAngle()

The angle of the moon illumination relative to earth. The moon is waxing if the angle is negative, and waning if positive.

By subtracting MoonPosition.getParallacticAngle() from getAngle(), one can get the zenith angle of the moons bright limb (anticlockwise). The zenith angle can be used do draw the moon shape from the observer's perspective (e.g. the moon lying on its back).

getClosestPhase

public MoonPhase.Phase getClosestPhase()

The closest MoonPhase.Phase that is matching the moon's angle.

Returns:

Closest MoonPhase.Phase

Since:

2.12

toString

public String toString()

Overrides:

toString in class Object