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

Functions

qtty::Radian altitude_at (const Star &s, const Geodetic &obs, const MJD &mjd)
 Compute a star's altitude (radians) at a given MJD instant.
 
std::vector< Periodabove_threshold (const Star &s, const Geodetic &obs, const Period &window, qtty::Degree threshold, const SearchOptions &opts={})
 Find periods when a star is above a threshold altitude.
 
std::vector< Periodabove_threshold (const Star &s, 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 Star &s, const Geodetic &obs, const Period &window, qtty::Degree threshold, const SearchOptions &opts={})
 Find periods when a star is below a threshold altitude.
 
std::vector< Periodbelow_threshold (const Star &s, const Geodetic &obs, const MJD &start, const MJD &end, qtty::Degree threshold, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 
std::vector< CrossingEventcrossings (const Star &s, const Geodetic &obs, const Period &window, qtty::Degree threshold, const SearchOptions &opts={})
 Find threshold-crossing events for a star.
 
std::vector< CrossingEventcrossings (const Star &s, const Geodetic &obs, const MJD &start, const MJD &end, qtty::Degree threshold, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 
std::vector< CulminationEventculminations (const Star &s, const Geodetic &obs, const Period &window, const SearchOptions &opts={})
 Find culmination events for a star.
 
std::vector< CulminationEventculminations (const Star &s, const Geodetic &obs, const MJD &start, const MJD &end, const SearchOptions &opts={})
 Backward-compatible [start, end] overload.
 

Function Documentation

◆ above_threshold() [1/2]

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

Backward-compatible [start, end] overload.

Definition at line 440 of file altitude.hpp.

◆ above_threshold() [2/2]

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

Find periods when a star is above a threshold altitude.

Definition at line 425 of file altitude.hpp.

Referenced by main().

◆ altitude_at()

qtty::Radian siderust::star_altitude::altitude_at ( const Star s,
const Geodetic obs,
const MJD mjd 
)
inline

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

Definition at line 414 of file altitude.hpp.

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

◆ below_threshold() [1/2]

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

Backward-compatible [start, end] overload.

Definition at line 464 of file altitude.hpp.

◆ below_threshold() [2/2]

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

Find periods when a star is below a threshold altitude.

Definition at line 449 of file altitude.hpp.

◆ crossings() [1/2]

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

Backward-compatible [start, end] overload.

Definition at line 488 of file altitude.hpp.

◆ crossings() [2/2]

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

Find threshold-crossing events for a star.

Definition at line 473 of file altitude.hpp.

Referenced by main().

◆ culminations() [1/2]

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

Backward-compatible [start, end] overload.

Definition at line 512 of file altitude.hpp.

◆ culminations() [2/2]

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

Find culmination events for a star.

Definition at line 497 of file altitude.hpp.

Referenced by main().