hispecdrp.primitives.utils
Stellar radial-velocity and cross-correlation helpers.
Most symbols come from hispecdrp.primitives.utils.ccf; robust chunk-RV combination helpers live in
hispecdrp.primitives.stellar_rv.rv_combine_utils and are re-exported here for a
stable hispecdrp.primitives.utils surface.
This package surface is the public API for template CCF, mask-line CCF, chunk combination, and RVCCF preview helpers. Velocities are m s:sup:`−1` unless a function states otherwise.
Exports
CCFFitConfigGaussian CCF fit configuration.
MaskLines,MaskLineStyle(fromhispecdrp.utils.line_mask_utils)Tabulated line-mask container (delta / tophat geometry) and style literal. Use
load()for disk masks (.masor two-column text).fit_ccf_rv,dv_per_pixel_m_s,continuum_normalizeGaussian fit to a CCF, rough per-pixel Δv, optional continuum division before CCF.
masked_ccf_rv,rv_per_chunks,process_one_order_rvs,process_orders_rvs_numba_parallel,flat_chunk_echelle_ordersLog-λ weighted-covariance CCF paths (single spectrum, chunked, one order, many orders).
combine_rvs_median_mad,weighted_mean_rvMedian/MAD outlier mask and inverse-variance weighted mean on chunk RVs (implemented in
hispecdrp.primitives.stellar_rv.rv_combine_utils).resolve_mask_path,restrict_mask_to_chunk,stellar_rv_ccf_mask_lines,pixel_edges_from_wavelengthPackaged-mask resolution, chunk restriction, StellarRV line-mask inputs, pixel edges (from
hispecdrp.utils.line_mask_utils).DEFAULT_PACKAGED_LINE_MASK_BASENAME,packaged_default_line_mask_pathPackaged default delta line mask for
mask_path=None(seehispecdrp/data/masks/). Optional*.tophat.massegment masks are produced byregenerate_template_masks.pyonly; they are not part of the default RV API.run_ccf_line_mask_for_fiber,build_ccf_preview_dict,doppler_paint_lanczosLine-mask CCF driver for one fiber (
StellarRVPrimitive(algorithm="ccf_line_mask")), Plotly preview payload builder, and science-matching Lanczos Doppler paint.
See hispecdrp.primitives.utils.ccf for full docstrings and references.
Modules
Generic Numba / array / polynomial helpers for HISPEC DRP primitives. |
|
Cross-correlation (CCF) and radial-velocity utilities. |
|
Spectral utilities: template I/O and wavelength / velocity / pixel conversions. |
|
Robust statistics helpers used by HISPEC DRP primitives. |