siderust-cpp 0.8.0
Header-only C++ wrapper for siderust
Loading...
Searching...
No Matches
siderust::SkyGrid Class Reference

Typed hemispherical alt/az grid sampler. More...

#include <siderust/sky_grid.hpp>

Public Member Functions

SkyGridwith_alt_range (qtty::Degree lo, qtty::Degree hi)
 Restrict the altitude range (builder, e.g. a 10°..90° horizon mask).
 
std::vector< SkyGridCellcells () const
 Materialise every cell of the grid.
 
std::size_t size () const
 Number of cells the grid materialises.
 

Static Public Member Functions

static SkyGrid uniform (qtty::Degree step)
 Uniform grid with equal altitude and azimuth steps over [0°, 90°).
 
static SkyGrid with_steps (qtty::Degree alt_step, qtty::Degree az_step)
 Uniform grid with independent altitude and azimuth steps over [0°, 90°).
 
static SkyGrid equal_area (qtty::Degree alt_step, qtty::Degree az_step_at_horizon)
 Equal-area grid: azimuth count per altitude ring scales with cos(alt).
 

Detailed Description

Typed hemispherical alt/az grid sampler.

Mirrors siderust::coordinates::SkyGrid. Construct with one of the static factories and call cells to materialise every grid cell.

Definition at line 60 of file sky_grid.hpp.

Member Function Documentation

◆ cells()

std::vector< SkyGridCell > siderust::SkyGrid::cells ( ) const
inline

Materialise every cell of the grid.

Definition at line 95 of file sky_grid.hpp.

References siderust::check_status(), siderust::SkyGridCell::from_c(), and siderust::detail::SkyGridCellsGuard::ptr.

Referenced by size().

◆ equal_area()

static SkyGrid siderust::SkyGrid::equal_area ( qtty::Degree  alt_step,
qtty::Degree  az_step_at_horizon 
)
inlinestatic

Equal-area grid: azimuth count per altitude ring scales with cos(alt).

Definition at line 83 of file sky_grid.hpp.

◆ size()

std::size_t siderust::SkyGrid::size ( ) const
inline

Number of cells the grid materialises.

Definition at line 115 of file sky_grid.hpp.

References cells().

◆ uniform()

static SkyGrid siderust::SkyGrid::uniform ( qtty::Degree  step)
inlinestatic

Uniform grid with equal altitude and azimuth steps over [0°, 90°).

Definition at line 73 of file sky_grid.hpp.

◆ with_alt_range()

SkyGrid & siderust::SkyGrid::with_alt_range ( qtty::Degree  lo,
qtty::Degree  hi 
)
inline

Restrict the altitude range (builder, e.g. a 10°..90° horizon mask).

Definition at line 88 of file sky_grid.hpp.

◆ with_steps()

static SkyGrid siderust::SkyGrid::with_steps ( qtty::Degree  alt_step,
qtty::Degree  az_step 
)
inlinestatic

Uniform grid with independent altitude and azimuth steps over [0°, 90°).

Definition at line 78 of file sky_grid.hpp.


The documentation for this class was generated from the following file: