Skip to content

API Reference

Python API documentation for tetra3rs, auto-generated from type stubs.

Core Classes

Class Description
SolverDatabase Star pattern database — generate, save/load, and solve
CameraModel Camera intrinsics — focal length, optical center, parity, distortion
SolveResult Plate-solve result — attitude, WCS, matched stars, pixel↔sky conversions
CalibrateResult Camera calibration result — fitted camera model and statistics

Centroid Extraction

Symbol Description
extract_centroids() Extract star centroids from an image array
ExtractionResult Extraction result with centroids and image statistics
Centroid A single star centroid with position, brightness, and shape

Distortion Models

Class Description
RadialDistortion Radial (k1, k2, k3) distortion model
PolynomialDistortion SIP-like polynomial distortion model
DistortionFitResult Result of distortion fitting

Module-Level Functions

Function Description
earth_barycentric_velocity() Approximate Earth barycentric velocity for aberration correction
undistort_centroids() Apply inverse distortion to a list of centroids
distort_centroids() Apply forward distortion to a list of centroids