Zmanim.Calculator.JSuntimeCalculator Class Reference

Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm written by Jonathan Stott that is based on the implementation by NOAA - National Oceanic and Atmospheric Administration's Surface Radiation Research Branch. NOAA's implementation is based on equations from Astronomical Algorithms by Jean Meeus. Jonathan's implementation was released under the GPL. Added to the algorithm is an adjustment of the zenith to account for elevation. More...

Inheritance diagram for Zmanim.Calculator.JSuntimeCalculator:
Zmanim.Calculator.AstronomicalCalculator Zmanim.Calculator.IAstronomicalCalculator

List of all members.

Public Member Functions

override double GetUtcSunrise (IAstronomicalCalendar astronomicalCalendar, double zenith, bool adjustForElevation)
 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.
override double GetUtcSunset (IAstronomicalCalendar astronomicalCalendar, double zenith, bool adjustForElevation)
 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.

Properties

override string CalculatorName [get]

Detailed Description

Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm written by Jonathan Stott that is based on the implementation by NOAA - National Oceanic and Atmospheric Administration's Surface Radiation Research Branch. NOAA's implementation is based on equations from Astronomical Algorithms by Jean Meeus. Jonathan's implementation was released under the GPL. Added to the algorithm is an adjustment of the zenith to account for elevation.

See also:
NOAACalculator

<author>Jonathan Stott</author> <author>Eliyahu Hershfeld</author>


Member Function Documentation

override double Zmanim.Calculator.JSuntimeCalculator.GetUtcSunrise ( IAstronomicalCalendar  astronomicalCalendar,
double  zenith,
bool  adjustForElevation 
) [virtual]

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.

Parameters:
astronomicalCalendar Used to calculate day of year.
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.
adjustForElevation if set to true [adjust for elevation].
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:
NOAACalculator.GetUtcSunrise, AstronomicalCalculator.GetUtcSunrise

Implements Zmanim.Calculator.AstronomicalCalculator.

override double Zmanim.Calculator.JSuntimeCalculator.GetUtcSunset ( IAstronomicalCalendar  astronomicalCalendar,
double  zenith,
bool  adjustForElevation 
) [virtual]

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.

Parameters:
astronomicalCalendar Used to calculate day of year.
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.
adjustForElevation if set to true [adjust for elevation].
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,
See also:
Double.NaN
will be returned.
See also:
NOAACalculator.GetUtcSunset, AstronomicalCalculator.GetUtcSunset

summary> Calculate the UTC of a morning phenomenon for the given day at the given latitude and longitude on Earth /summary> param name = "julian"> Julian day

param name = "latitude"> latitude of observer in degrees

param name = "longitude"> longitude of observer in degrees

param name = "zenithDistance"> one of Sun.SUNRISE_SUNSET_ZENITH_DISTANCE, Sun.CIVIL_TWILIGHT_ZENITH_DISTANCE, Sun.NAUTICAL_TWILIGHT_ZENITH_DISTANCE, Sun.ASTRONOMICAL_TWILIGHT_ZENITH_DISTANCE.

returns> time in minutes from zero Z

Implements Zmanim.Calculator.AstronomicalCalculator.


Property Documentation

override string Zmanim.Calculator.JSuntimeCalculator.CalculatorName [get]

the descriptive name of the algorithm.

See also:
NOAACalculator.CalculatorName

Reimplemented from Zmanim.Calculator.AstronomicalCalculator.


The documentation for this class was generated from the following file:
Generated on Mon May 31 12:33:42 2010 for Zmanim Project by  doxygen 1.6.3