API Reference

This section provides detailed API documentation for all modules.

Core Modules

• Core Module
  • Constants
  • Array Utilities
  • Validation
  • Exceptions
  • Maturity
  • Optional Deps
  • Paths
• Mathematical Functions
  • Basic Matrix Operations
  • Special Functions
  • Statistics
  • Interpolation
  • Numerical Integration
  • Geometry
  • Combinatorics
  • Polynomials
  • Debye
  • Hypergeometric
  • Lambert W
  • Marcum Q
• Coordinate Systems
  • Conversions
  • Rotations
  • Jacobians
  • Projections
• Dynamic Models
  • Discrete-Time Models
  • Process Noise
  • Continuous-Time Dynamics
• Dynamic Estimation
  • Kalman Filters
  • Interacting Multiple Model (IMM) Estimator
  • Particle Filters
  • Gaussian Sum Filter
  • Information Filter
  • H Infinity
  • Matrix Utils
  • Sr Ukf
  • Types
  • Ud Filter
  • Smoothers
• Assignment Algorithms
  • 2D Assignment
  • Gating
  • Data Association
  • Nd Assignment
  • Network Flow
  • Assignment
  • Assignment
  • Kbest

Signal Processing & Transforms

• Signal Processing
  • Filter Design
  • Matched Filtering
  • CFAR Detection
• Transforms
  • Fourier Transforms
  • Short-Time Fourier Transform
  • Wavelet Transforms

Geophysical Models

• Gravity Models
  • Spherical Harmonics
  • EGM Models
  • Gravity Models
  • Clenshaw Summation
  • Tidal Effects
• Magnetism Models
  • World Magnetic Model (WMM)
  • IGRF Model
  • Enhanced Magnetic Model (EMM) and WMMHR2025
  • Package-level Aliases
• Atmosphere
  • Submodules
  • Atmospheric Models
  • Thermosphere Model
  • Humidity and Dew Point
  • Refractivity
  • Ionosphere
• Terrain
  • Submodules
  • DEM Interface
  • Data Loaders
  • Visibility Analysis

Navigation

• Navigation
  • INS Mechanization
  • INS/GNSS Integration
  • Geodesy
  • Great Circle Navigation
  • Rhumb Line Navigation
• Astronomical
  • Orbital Mechanics
  • Lambert Problem
  • Reference Frames
  • Time Systems
  • JPL Ephemerides
  • Relativistic Corrections
  • Sgp4
  • Special Orbits
  • Tle

Estimation & Tracking

• Static Estimation
  • Least Squares
  • Maximum Likelihood
  • Robust Estimation
  • Localization
• Trackers
  • Single Target Tracking
  • Multi-Target Tracking
  • Multiple Hypothesis Tracking (MHT)
  • Hypothesis Management
• Clustering
  • K-Means
  • DBSCAN
  • Hierarchical Clustering
  • Gaussian Mixtures

GPU Acceleration

• GPU Acceleration
  • Installation
  • Quick Start
  • Platform Detection
  • Array Operations
  • Memory Management
  • Batch Kalman Filter
  • Batch Extended Kalman Filter
  • Batch Unscented Kalman Filter
  • GPU Particle Filter
  • GPU Matrix Utilities
  • Example: Batch Track Processing
  • Performance Notes

I/O and Instrumentation

• I/O and Storage
  • Storage Interface
  • SQL Storage
  • HDF5 Storage
  • HDF5 Track Storage
  • Track Database
  • Measurement Readers
  • DataFrame Accessors
  • Serialization
  • ASDF Export
  • Sessions
  • Migration Tools
  • v1.x Compatibility Adapters
• Transponders
  • AIS
• Diagnostics
  • diagnostics_enabled()
  • enable_debug_logging()
  • disable_debug_logging()
  • track_table()
  • progress_bar()
  • log_filter_health()
  • Rendering

Utilities

• Containers
  • Spatial Index Hierarchy
  • K-D Tree
  • R-Tree
  • VP-Tree
  • Cover Tree
  • Base
  • Cluster Set
  • Measurement Set
  • Track List
• Plotting
  • Track Plotting
  • Ellipse Plotting
  • Metrics Plotting
  • Coordinate Plotting
• Performance Evaluation
  • Track Metrics
  • Estimation Metrics