net.sourceforge.zmanim.util

Class SunTimesCalculator

java.lang.Object

net.sourceforge.zmanim.util.AstronomicalCalculator

net.sourceforge.zmanim.util.SunTimesCalculator

All Implemented Interfaces:

Cloneable

public class SunTimesCalculator
extends AstronomicalCalculator

Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm written by Kevin Boone that is based on the US Naval Observatory'sAlmanac for Computer algorithm ( Amazon, Barnes & Noble) and is used with his permission. Added to Kevin's code is adjustment of the zenith to account for elevation.

Version:

1.1

Author:

© Eliyahu Hershfeld 2004 - 2011, © Kevin Boone 2000

Constructor Summary

Constructors

Constructor and Description
SunTimesCalculator()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCalculatorName() Returns the name of the algorithm.
double	getUTCSunrise(Calendar calendar, GeoLocation geoLocation, double zenith, boolean adjustForElevation) A method that calculates UTC sunrise as well as any time based on an angle above or below sunrise.
double	getUTCSunset(Calendar calendar, GeoLocation geoLocation, double zenith, boolean adjustForElevation) A method that calculates UTC sunset as well as any time based on an angle above or below sunset.

Methods inherited from class net.sourceforge.zmanim.util.AstronomicalCalculator

adjustZenith, clone, getDefault, getEarthRadius, getElevationAdjustment, getRefraction, getSolarRadius, setEarthRadius, setRefraction, setSolarRadius

Methods inherited from class java.lang.Object

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

Constructor Detail

SunTimesCalculator

public SunTimesCalculator()

Method Detail

getCalculatorName

public String getCalculatorName()

Description copied from class: AstronomicalCalculator

Returns the name of the algorithm.

Specified by:

getCalculatorName in class AstronomicalCalculator

Returns:

the descriptive name of the algorithm.

See Also:

AstronomicalCalculator.getCalculatorName()

getUTCSunrise

public double getUTCSunrise(Calendar calendar,
                   GeoLocation geoLocation,
                   double zenith,
                   boolean adjustForElevation)

Description copied from class: AstronomicalCalculator

A method that calculates UTC sunrise as well as any time based on an angle above or below sunrise. This abstract method is implemented by the classes that extend this class.

Specified by:

getUTCSunrise in class AstronomicalCalculator

Parameters:

calendar - Used to calculate day of year.

geoLocation - The location information used for astronomical calculating sun times.

zenith - the azimuth below the vertical zenith of 90 degrees. for sunrise typically the zenith used for the calculation uses geometric zenith of 90° and adjusts this slightly to account for solar refraction and the sun's radius. Another example would be AstronomicalCalendar.getBeginNauticalTwilight() that passes AstronomicalCalendar.NAUTICAL_ZENITH to this method.

Returns:

The UTC time of sunrise in 24 hour format. 5:45:00 AM will return 5.75.0. If an error was encountered in the calculation (expected behavior for some locations such as near the poles, Double.NaN will be returned.

See Also:

AstronomicalCalculator.getUTCSunrise(Calendar, GeoLocation, double, boolean)

getUTCSunset

public double getUTCSunset(Calendar calendar,
                  GeoLocation geoLocation,
                  double zenith,
                  boolean adjustForElevation)

Description copied from class: AstronomicalCalculator

A method that calculates UTC sunset as well as any time based on an angle above or below sunset. This abstract method is implemented by the classes that extend this class.

Specified by:

getUTCSunset in class AstronomicalCalculator

Parameters:

calendar - Used to calculate day of year.

geoLocation - The location information used for astronomical calculating sun times.

zenith - the azimuth below the vertical zenith of 90°. For sunset typically the zenith used for the calculation uses geometric zenith of 90° and adjusts this slightly to account for solar refraction and the sun's radius. Another example would be AstronomicalCalendar.getEndNauticalTwilight() that passes AstronomicalCalendar.NAUTICAL_ZENITH to this method.

Returns:

The UTC time of sunset in 24 hour format. 5:45:00 AM will return 5.75.0. If an error was encountered in the calculation (expected behavior for some locations such as near the poles, Double.NaN will be returned.

See Also:

AstronomicalCalculator.getUTCSunset(Calendar, GeoLocation, double, boolean)