org.shredzone.commons.suncalc.SunTimes Maven / Gradle / Ivy
Show all versions of commons-suncalc Show documentation
/*
* Shredzone Commons - suncalc
*
* Copyright (C) 2017 Richard "Shred" Körber
* http://commons.shredzone.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
package org.shredzone.commons.suncalc;
import static java.lang.Math.*;
import static org.shredzone.commons.suncalc.util.ExtendedMath.*;
import java.time.Duration;
import java.time.ZonedDateTime;
import edu.umd.cs.findbugs.annotations.Nullable;
import org.shredzone.commons.suncalc.param.Builder;
import org.shredzone.commons.suncalc.param.GenericParameter;
import org.shredzone.commons.suncalc.param.LocationParameter;
import org.shredzone.commons.suncalc.param.TimeParameter;
import org.shredzone.commons.suncalc.util.BaseBuilder;
import org.shredzone.commons.suncalc.util.JulianDate;
import org.shredzone.commons.suncalc.util.QuadraticInterpolation;
import org.shredzone.commons.suncalc.util.Sun;
import org.shredzone.commons.suncalc.util.Vector;
/**
* Calculates the rise and set times of the sun.
*/
public class SunTimes {
private final @Nullable ZonedDateTime rise;
private final @Nullable ZonedDateTime set;
private final @Nullable ZonedDateTime noon;
private final @Nullable ZonedDateTime nadir;
private final boolean alwaysUp;
private final boolean alwaysDown;
private SunTimes(@Nullable ZonedDateTime rise, @Nullable ZonedDateTime set,
@Nullable ZonedDateTime noon, @Nullable ZonedDateTime nadir,
boolean alwaysUp, boolean alwaysDown) {
this.rise = rise;
this.set = set;
this.noon = noon;
this.nadir = nadir;
this.alwaysUp = alwaysUp;
this.alwaysDown = alwaysDown;
}
/**
* Starts the computation of {@link SunTimes}.
*
* @return {@link Parameters} to set.
*/
public static Parameters compute() {
return new SunTimesBuilder();
}
/**
* Collects all parameters for {@link SunTimes}.
*/
public interface Parameters extends
GenericParameter,
LocationParameter,
TimeParameter,
Builder {
/**
* Sets the {@link Twilight} mode.
*
* Defaults to {@link Twilight#VISUAL}.
*
* @param twilight
* {@link Twilight} mode to be used.
* @return itself
*/
Parameters twilight(Twilight twilight);
/**
* Sets the desired elevation angle of the sun. The sunrise and sunset times are
* referring to the moment when the center of the sun passes this angle.
*
* @param angle
* Geocentric elevation angle, in degrees.
* @return itself
*/
Parameters twilight(double angle);
/**
* Limits the calculation window to the given {@link Duration}.
*
* @param duration
* Duration of the calculation window. Must be positive.
* @return itself
* @since 3.1
*/
Parameters limit(Duration duration);
/**
* Limits the time window to the next 24 hours.
*
* @return itself
*/
default Parameters oneDay() {
return limit(Duration.ofDays(1L));
}
/**
* Computes until all rise, set, noon, and nadir times are found.
*
* This is the default.
*
* @return itself
*/
default Parameters fullCycle() {
return limit(Duration.ofDays(365L));
}
}
/**
* Enumeration of predefined twilights.
*
* The twilight angles use a geocentric reference, by definition. However,
* {@link #VISUAL} and {@link #VISUAL_LOWER} are topocentric, and take the spectator's
* height and the atmospheric refraction into account.
*
* @see Wikipedia: Twilight
*/
public enum Twilight {
/**
* The moment when the visual upper edge of the sun crosses the horizon. This is
* commonly referred to as "sunrise" and "sunset". Atmospheric refraction is taken
* into account.
*
* This is the default.
*/
VISUAL(0.0, 1.0),
/**
* The moment when the visual lower edge of the sun crosses the horizon. This is
* the ending of the sunrise and the starting of the sunset. Atmospheric
* refraction is taken into account.
*/
VISUAL_LOWER(0.0, -1.0),
/**
* The moment when the center of the sun crosses the horizon (0°).
*/
HORIZON(0.0),
/**
* Civil twilight (-6°).
*/
CIVIL(-6.0),
/**
* Nautical twilight (-12°).
*/
NAUTICAL(-12.0),
/**
* Astronomical twilight (-18°).
*/
ASTRONOMICAL(-18.0),
/**
* Golden hour (6°). The Golden hour is between {@link #GOLDEN_HOUR} and
* {@link #BLUE_HOUR}. The Magic hour is between {@link #GOLDEN_HOUR} and
* {@link #CIVIL}.
*
* @see Wikipedia:
* Golden hour
*/
GOLDEN_HOUR(6.0),
/**
* Blue hour (-4°). The Blue hour is between {@link #NIGHT_HOUR} and
* {@link #BLUE_HOUR}.
*
* @see Wikipedia: Blue hour
*/
BLUE_HOUR(-4.0),
/**
* End of Blue hour (-8°).
*
* "Night Hour" is not an official term, but just a name that is marking the
* beginning/end of the Blue hour.
*/
NIGHT_HOUR(-8.0);
private final double angle;
private final double angleRad;
private final @Nullable Double position;
Twilight(double angle) {
this(angle, null);
}
Twilight(double angle, @Nullable Double position) {
this.angle = angle;
this.angleRad = toRadians(angle);
this.position = position;
}
/**
* Returns the sun's angle at the twilight position, in degrees.
*/
public double getAngle() {
return angle;
}
/**
* Returns the sun's angle at the twilight position, in radians.
*/
public double getAngleRad() {
return angleRad;
}
/**
* Returns {@code true} if this twilight position is topocentric. Then the
* parallax and the atmospheric refraction is taken into account.
*/
public boolean isTopocentric() {
return position != null;
}
/**
* Returns the angular position. {@code 0.0} means center of the sun. {@code 1.0}
* means upper edge of the sun. {@code -1.0} means lower edge of the sun.
* {@code null} means the angular position is not topocentric.
*/
@Nullable
private Double getAngularPosition() {
return position;
}
}
/**
* Builder for {@link SunTimes}. Performs the computations based on the parameters,
* and creates a {@link SunTimes} object that holds the result.
*/
private static class SunTimesBuilder extends BaseBuilder implements Parameters {
private double angle = Twilight.VISUAL.getAngleRad();
private @Nullable Double position = Twilight.VISUAL.getAngularPosition();
private Duration limit = Duration.ofDays(365L);
@Override
public Parameters twilight(Twilight twilight) {
this.angle = twilight.getAngleRad();
this.position = twilight.getAngularPosition();
return this;
}
@Override
public Parameters twilight(double angle) {
this.angle = toRadians(angle);
this.position = null;
return this;
}
@Override
public Parameters limit(Duration duration) {
if (duration == null || duration.isNegative()) {
throw new IllegalArgumentException("duration must be positive");
}
limit = duration;
return this;
}
@Override
public SunTimes execute() {
JulianDate jd = getJulianDate();
Double rise = null;
Double set = null;
Double noon = null;
Double nadir = null;
boolean alwaysUp = false;
boolean alwaysDown = false;
double ye;
int hour = 0;
double limitHours = limit.toMillis() / (60 * 60 * 1000.0);
int maxHours = (int) ceil(limitHours);
double y_minus = correctedSunHeight(jd.atHour(hour - 1.0));
double y_0 = correctedSunHeight(jd.atHour(hour));
double y_plus = correctedSunHeight(jd.atHour(hour + 1.0));
if (y_0 > 0.0) {
alwaysUp = true;
} else {
alwaysDown = true;
}
while (hour <= maxHours) {
QuadraticInterpolation qi = new QuadraticInterpolation(y_minus, y_0, y_plus);
ye = qi.getYe();
if (qi.getNumberOfRoots() == 1) {
double rt = qi.getRoot1() + hour;
if (y_minus < 0.0) {
if (rise == null && rt >= 0.0 && rt < limitHours) {
rise = rt;
alwaysDown = false;
}
} else {
if (set == null && rt >= 0.0 && rt < limitHours) {
set = rt;
alwaysUp = false;
}
}
} else if (qi.getNumberOfRoots() == 2) {
if (rise == null) {
double rt = hour + (ye < 0.0 ? qi.getRoot2() : qi.getRoot1());
if (rt >= 0.0 && rt < limitHours) {
rise = rt;
alwaysDown = false;
}
}
if (set == null) {
double rt = hour + (ye < 0.0 ? qi.getRoot1() : qi.getRoot2());
if (rt >= 0.0 && rt < limitHours) {
set = rt;
alwaysUp = false;
}
}
}
double xeAbs = abs(qi.getXe());
if (xeAbs <= 1.0) {
double xeHour = qi.getXe() + hour;
if (xeHour >= 0.0) {
if (qi.isMaximum()) {
if (noon == null) {
noon = xeHour;
}
} else {
if (nadir == null) {
nadir = xeHour;
}
}
}
}
if (rise != null && set != null && noon != null && nadir != null) {
break;
}
hour++;
y_minus = y_0;
y_0 = y_plus;
y_plus = correctedSunHeight(jd.atHour(hour + 1.0));
}
if (noon != null) {
noon = readjustMax(noon, 2.0, 14, t -> correctedSunHeight(jd.atHour(t)));
if (noon < 0.0 || noon >= limitHours) {
noon = null;
}
}
if (nadir != null) {
nadir = readjustMin(nadir, 2.0, 14, t -> correctedSunHeight(jd.atHour(t)));
if (nadir < 0.0 || nadir >= limitHours) {
nadir = null;
}
}
return new SunTimes(
rise != null ? jd.atHour(rise).getDateTime() : null,
set != null ? jd.atHour(set).getDateTime() : null,
noon != null ? jd.atHour(noon).getDateTime() : null,
nadir != null ? jd.atHour(nadir).getDateTime() : null,
alwaysUp,
alwaysDown
);
}
/**
* Computes the sun height at the given date and position.
*
* @param jd {@link JulianDate} to use
* @return height, in radians
*/
private double correctedSunHeight(JulianDate jd) {
Vector pos = Sun.positionHorizontal(jd, getLatitudeRad(), getLongitudeRad());
double hc = angle;
if (position != null) {
hc -= apparentRefraction(hc);
hc += parallax(getHeight(), pos.getR());
hc -= position * Sun.angularRadius(pos.getR());
}
return pos.getTheta() - hc;
}
}
/**
* Sunrise time. {@code null} if the sun does not rise that day.
*
* Always returns a sunrise time if {@link Parameters#fullCycle()} was set.
*/
@Nullable
public ZonedDateTime getRise() {
return rise;
}
/**
* Sunset time. {@code null} if the sun does not set that day.
*
* Always returns a sunset time if {@link Parameters#fullCycle()} was set.
*/
@Nullable
public ZonedDateTime getSet() {
return set;
}
/**
* The time when the sun reaches its highest point.
*
* Use {@link #isAlwaysDown()} to find out if the highest point is still below the
* twilight angle.
*/
@Nullable
public ZonedDateTime getNoon() {
return noon;
}
/**
* The time when the sun reaches its lowest point.
*
* Use {@link #isAlwaysUp()} to find out if the lowest point is still above the
* twilight angle.
*/
@Nullable
public ZonedDateTime getNadir() {
return nadir;
}
/**
* {@code true} if the sun never rises/sets, but is always above the twilight angle.
*/
public boolean isAlwaysUp() {
return alwaysUp;
}
/**
* {@code true} if the sun never rises/sets, but is always below the twilight angle.
*/
public boolean isAlwaysDown() {
return alwaysDown;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("SunTimes[rise=").append(rise);
sb.append(", set=").append(set);
sb.append(", noon=").append(noon);
sb.append(", nadir=").append(nadir);
sb.append(", alwaysUp=").append(alwaysUp);
sb.append(", alwaysDown=").append(alwaysDown);
sb.append(']');
return sb.toString();
}
}