siderust-cpp
Header-only C++ wrapper for siderust
Loading...
Searching...
No Matches
siderust::sun Namespace Reference

Functions

qtty::Radian altitude_at (const Geodetic &obs, const MJD &mjd)
 Compute the Sun's altitude (radians) at a given MJD instant.
 
std::vector< Periodabove_threshold (const Geodetic &obs, const Period &window, qtty::Degree threshold, const SearchOptions &opts={})
 Find periods when the Sun is above a threshold altitude.
 
std::vector< Periodabove_threshold (const Geodetic &obs, const MJD &start, const MJD &end, qtty::Degree threshold, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 
std::vector< Periodbelow_threshold (const Geodetic &obs, const Period &window, qtty::Degree threshold, const SearchOptions &opts={})
 Find periods when the Sun is below a threshold altitude.
 
std::vector< Periodbelow_threshold (const Geodetic &obs, const MJD &start, const MJD &end, qtty::Degree threshold, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 
std::vector< CrossingEventcrossings (const Geodetic &obs, const Period &window, qtty::Degree threshold, const SearchOptions &opts={})
 Find threshold-crossing events for the Sun.
 
std::vector< CrossingEventcrossings (const Geodetic &obs, const MJD &start, const MJD &end, qtty::Degree threshold, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 
std::vector< CulminationEventculminations (const Geodetic &obs, const Period &window, const SearchOptions &opts={})
 Find culmination events for the Sun.
 
std::vector< CulminationEventculminations (const Geodetic &obs, const MJD &start, const MJD &end, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 
std::vector< Periodaltitude_periods (const Geodetic &obs, const Period &window, qtty::Degree min_alt, qtty::Degree max_alt)
 Find periods when the Sun's altitude is within [min, max].
 
std::vector< Periodaltitude_periods (const Geodetic &obs, const MJD &start, const MJD &end, qtty::Degree min_alt, qtty::Degree max_alt)
 Backward-compatible [start, end] overload.
 

Function Documentation

◆ above_threshold() [1/2]

std::vector< Period > siderust::sun::above_threshold ( const Geodetic obs,
const MJD start,
const MJD end,
qtty::Degree  threshold,
const SearchOptions opts = {} 
)
inline

Backward-compatible [start, end] overload.

Definition at line 151 of file altitude.hpp.

◆ above_threshold() [2/2]

std::vector< Period > siderust::sun::above_threshold ( const Geodetic obs,
const Period window,
qtty::Degree  threshold,
const SearchOptions opts = {} 
)
inline

Find periods when the Sun is above a threshold altitude.

Definition at line 136 of file altitude.hpp.

◆ altitude_at()

qtty::Radian siderust::sun::altitude_at ( const Geodetic obs,
const MJD mjd 
)
inline

Compute the Sun's altitude (radians) at a given MJD instant.

Definition at line 126 of file altitude.hpp.

References siderust::check_status(), and siderust::Geodetic::to_c().

◆ altitude_periods() [1/2]

std::vector< Period > siderust::sun::altitude_periods ( const Geodetic obs,
const MJD start,
const MJD end,
qtty::Degree  min_alt,
qtty::Degree  max_alt 
)
inline

Backward-compatible [start, end] overload.

Definition at line 247 of file altitude.hpp.

References siderust::check_status(), siderust::detail::periods_from_c(), and siderust::Geodetic::to_c().

◆ altitude_periods() [2/2]

std::vector< Period > siderust::sun::altitude_periods ( const Geodetic obs,
const Period window,
qtty::Degree  min_alt,
qtty::Degree  max_alt 
)
inline

Find periods when the Sun's altitude is within [min, max].

Definition at line 232 of file altitude.hpp.

References siderust::check_status(), siderust::detail::periods_from_c(), and siderust::Geodetic::to_c().

◆ below_threshold() [1/2]

std::vector< Period > siderust::sun::below_threshold ( const Geodetic obs,
const MJD start,
const MJD end,
qtty::Degree  threshold,
const SearchOptions opts = {} 
)
inline

Backward-compatible [start, end] overload.

Definition at line 175 of file altitude.hpp.

◆ below_threshold() [2/2]

std::vector< Period > siderust::sun::below_threshold ( const Geodetic obs,
const Period window,
qtty::Degree  threshold,
const SearchOptions opts = {} 
)
inline

Find periods when the Sun is below a threshold altitude.

Definition at line 160 of file altitude.hpp.

Referenced by main().

◆ crossings() [1/2]

std::vector< CrossingEvent > siderust::sun::crossings ( const Geodetic obs,
const MJD start,
const MJD end,
qtty::Degree  threshold,
const SearchOptions opts = {} 
)
inline

Backward-compatible [start, end] overload.

Definition at line 199 of file altitude.hpp.

◆ crossings() [2/2]

std::vector< CrossingEvent > siderust::sun::crossings ( const Geodetic obs,
const Period window,
qtty::Degree  threshold,
const SearchOptions opts = {} 
)
inline

Find threshold-crossing events for the Sun.

Definition at line 184 of file altitude.hpp.

Referenced by main().

◆ culminations() [1/2]

std::vector< CulminationEvent > siderust::sun::culminations ( const Geodetic obs,
const MJD start,
const MJD end,
const SearchOptions opts = {} 
)
inline

Backward-compatible [start, end] overload.

Definition at line 223 of file altitude.hpp.

◆ culminations() [2/2]

std::vector< CulminationEvent > siderust::sun::culminations ( const Geodetic obs,
const Period window,
const SearchOptions opts = {} 
)
inline

Find culmination events for the Sun.

Definition at line 208 of file altitude.hpp.

Referenced by main().