faintStarsInfunction
The stars of some decoded tiles that lie in a round patch of sky and are as bright as a limit, brightest first. With max, the brightest max of them: the list is then complete only to depth, which is the magnitude the list is cut at.
Import it
import { faintStarsIn } from "@johnmorrisdotca/hoshi-stars/faint";
Definition
function faintStarsIn(tiles: Iterable<FaintTile>, field: FaintField, limit?: number, max?: number): { stars: FaintStar[]; depth: number; }
Parameters
| Name | Type | Description |
|---|---|---|
tiles | Iterable<FaintTile> | Decoded tiles, from |
field | FaintField | The patch. |
limit (optional) | number | The faintest magnitude wanted; 12 where left out. |
max (optional) | number | The most stars to return; all of them where left out. |
Returns
{ stars: FaintStar[]; depth: number; }
The stars, and depth: the faintest magnitude the list holds all the stars of: limit when nothing was cut, else the magnitude of the cut (stars a step fainter are left out).
Examples
import { faintStarsIn, type FaintTile } from "@johnmorrisdotca/hoshi-stars/faint";
const tiles: FaintTile[] = []; // the tiles of faintTilesFor(field), fetched and decoded
const { stars, depth } = faintStarsIn(tiles, { rightAscension: 83.8, declination: -5.4, radius: 1 }, 11, 2000);
console.log(stars.length, depth);0 11What it prints (run when this page was built)