Build a CCF-Opt Delta Mask from an Ideal-Spectrum Template
The HISPEC DRP is in active development. Please submit issues and suggestions on the GitHub.
For an arbitrary stellar template (here BT-Settl lte040, 4000 K):
Seed mask — gradient-based line detection on the 1D template (
build_line_mask_from_template/RELAXED_TEMPLATE_MASK_BUILD_KW).Ideal L2 —
build_l2()paints the template onto a native BSPEC L2, then convolves each order with the HDF PSF→1-D LSF (apply_lsf=True) so line shapes match the instrument.Re-zero + reweight — line-by-line
StellarRVPrimitiveon that LSF-matched L2 and the seed mask, then shift each lineλ' = λ × (1 + RV/c)and set weights ∝|Gaussian contrast|(build_ccfopt_line_mask_from_l2_line_by_line_rv).
Output: <template_stem>.lsf.ccfopt.delta.mas. The packaged
lte040...lsf.ccfopt.delta.mas is a two-order smoke product; this example
rebuilds a full-band LSF mask (needs the pyechelle HDF model).
Imports and output directory
from pathlib import Path
import hispecdrp
print(f"hispecdrp {hispecdrp.__version__} @ {hispecdrp.__file__}")
OUT = Path("/path/to/build_ccfopt_mask_ideal_spectrum")
OUT.mkdir(parents=True, exist_ok=True)
print("output:", OUT.resolve())
1. Configure template
TEMPLATE = "lte040.0-4.5-0.0a+0.0.BT-Settl.spec.7.h5"
FIBER = 1
print(f"template: {TEMPLATE}")
2. Build seed mask, ideal L2, and CCF-opt mask
build_ccfopt_mask() with apply_lsf=True
runs the three-step pipeline on an LSF-matched ideal L2 (full BSPEC echelle
range). Equivalent helper: build_ccfopt_mask_lsf_matched().
from hispecdrp.simulations.spectra import build_ccfopt_mask, quiet_pipeline_logging
from hispecdrp.utils.line_mask_utils import read_mask_generation_meta
# This suppresses logging from the pipeline so the output is cleaner
with quiet_pipeline_logging():
seed_path, ccfopt_path, l2_inj0 = build_ccfopt_mask(
TEMPLATE,
OUT,
fiber=FIBER,
apply_lsf=True,
)
meta = read_mask_generation_meta(ccfopt_path) or {}
print(f"seed mask: {seed_path}")
print(f"ccfopt mask: {ccfopt_path}")
print(
f"generator={meta.get('generator')} n_seed={meta.get('n_seed_lines')} "
f"n_drop={meta.get('n_dropped_lines')} n_lines={meta.get('n_lines')}"
)
3. Closed-loop check at injected RV = 0
Run StellarRVPrimitive on the LSF-matched L2 and
ccfopt mask. The RVCCF table has more rows than mask lines because echelle
orders can measure the same line more than once; aggregate RV should still be
near zero. The Ideal-Spectrum RV Recovery example uses the packaged
native *.ccfopt.delta.mas with build_l2(..., apply_lsf=False). Use this
LSF mask with apply_lsf=True for a like-to-like LSF closed loop.
from hispecdrp.primitives import StellarRVPrimitive
with quiet_pipeline_logging():
out = StellarRVPrimitive.call(
l2_inj0,
mask_path=str(ccfopt_path),
ccf_input_velocity=0.0,
)
avg = getattr(out, f"rvccfavg_fib{FIBER}")
rv = float(avg["RV"][0])
rv_err = float(avg["RV_ERR"][0])
print(f"closed-loop RV = {rv:+.6f} +/- {rv_err:.6f} m/s")