lost_in_space/lib.rs
1#![cfg_attr(nightly, feature(doc_cfg))]
2//! A library for detecting and analyzing astronomical sources in images.
3//!
4//! # Examples
5//! ```no_run
6//! use lost_in_space::plate_solve;
7//! use lost_in_space::quad::generate_quads_from_detected_stars;
8//! use lost_in_space::star::detect_stars_from_image;
9//! use image::DynamicImage;
10//!
11//! fn main() -> lost_in_space::Result<()> {
12//! let image = DynamicImage::new_rgb8(1024, 768);
13//! let detected_stars = detect_stars_from_image(&image)?;
14//!
15//! let unresolved_plate = generate_quads_from_detected_stars(detected_stars)?;
16//!
17//! plate_solve(&unresolved_plate)?;
18//!
19//! Ok(())
20//! }
21//! ```
22
23pub mod catalog;
24mod error;
25mod plate_solve;
26pub mod primitives;
27pub mod quad;
28mod result;
29pub mod star;
30
31pub use self::error::Error;
32pub use self::plate_solve::plate_solve;
33#[doc(inline)]
34pub use self::quad::plate_solve_relative;
35pub use self::result::Result;