sheap.Core.CoreTypeAliases module
Core Type Aliases
Defines reusable typing primitives and callable signatures used across sheap for consistency and type safety.
Contents
ArrayLike : Generic type alias for arrays (NumPy or JAX).
ProfileFunc : Callable signature for spectral profile functions.
SpectralLineList : Shorthand for a list of SpectralLine.
Notes
Ensures consistent typing across profiles, regions, and fitting routines.
Profile functions follow the convention:
\[f(x) = \mathrm{model}(x, \theta)\]where x is the wavelength grid and θ the parameter vector.
- ArrayLike
Generic type alias for arrays that may be either NumPy or JAX ndarrays.
alias of
ndarray|ndarray
- ProfileFunc
(x, params) → model(x).
- Type:
Callable signature for profile functions
alias of
Callable[[ndarray,ndarray],ndarray]
- SpectralLineList
Convenient alias for a list of SpectralLine instances.
alias of
List[SpectralLine]