Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 1.45 KB

search-local-solar-eclipse.md

File metadata and controls

26 lines (15 loc) · 1.45 KB

//astronomy/io.github.cosinekitty.astronomy/searchLocalSolarEclipse

searchLocalSolarEclipse

fun searchLocalSolarEclipse(startTime: Time, observer: Observer): LocalSolarEclipseInfo

Searches for a solar eclipse visible at a specific location on the Earth's surface.

This function finds the first solar eclipse that occurs after startTime. A solar eclipse may be partial, annular, or total. See LocalSolarEclipseInfo for more information.

To find a series of solar eclipses, call this function once, then keep calling nextLocalSolarEclipse as many times as desired, passing in the peak value returned from the previous call.

IMPORTANT: An eclipse reported by this function might be partly or completely invisible to the observer due to the time of day. See LocalSolarEclipseInfo for more information about this topic.

See localSolarEclipsesAfter for convenient iteration of consecutive eclipses.

Return

Information about the first solar eclipse visible at the specified observer location.

Parameters

startTime The date and time for starting the search for a solar eclipse.
observer The geographic location of the observer.