ccf_s1d · SPIRou / NIRPS s1d spectra ccf_s1d · spectres s1d SPIRou / NIRPS

A cross-correlation toolkit for near-infrared s1d spectra Une boîte à outils de corrélation croisée pour les spectres s1d infrarouges

Correlate spectrally-merged SPIRou/NIRPS spectra against a line mask across the Y, J, H and K bands, fit each profile for a radial velocity, and plot the result, from a one-line install.

Corrélez des spectres SPIRou/NIRPS fusionnés spectralement avec un masque de raies sur les bandes Y, J, H et K, ajustez chaque profil pour obtenir une vitesse radiale, et tracez le résultat, à partir d'une seule ligne d'installation.

$ git clone https://github.com/eartigau/ccf_s1d.git \ && cd ccf_s1d \ && pip install -e .

Just want the library for your own data, no sample data needed? pip install git+https://github.com/eartigau/ccf_s1d.git works too.

Vous voulez juste la librairie pour vos propres données, sans les données d'exemple ? pip install git+https://github.com/eartigau/ccf_s1d.git fonctionne aussi.

GitHub FiguresFigures Package layoutStructure du paquet

OverviewAperçu

Built for APERO's s1d productsConçu pour les produits s1d d'APERO

APERO writes spectrally-merged 1D spectra (s1d_v / s1d_w) for every SPIRou and NIRPS exposure. ccf_s1d takes a stack of those files and a line mask, computes the cross-correlation function band by band, and fits each profile with a Gaussian for a radial velocity, FWHM and contrast. If you don't have a mask yet, it can build one directly from your own spectra.

APERO produit des spectres 1D fusionnés spectralement (s1d_v / s1d_w) pour chaque exposition SPIRou et NIRPS. ccf_s1d prend une série de ces fichiers et un masque de raies, calcule la fonction de corrélation croisée bande par bande, et ajuste chaque profil avec une gaussienne pour obtenir une vitesse radiale, une largeur et un contraste. Si vous n'avez pas encore de masque, l'outil peut en construire un directement à partir de vos propres spectres.

Try it, out of the boxÀ l'essai, prêt à l'emploi

The repo ships 30 real AU Mic SPIRou exposures from 2019 (sample_data/) and a ready-made line mask (masks/LBL_Mask_AUMIC_neg_spirou.fits), so there's no need to bring your own data. Once you've cloned the repo as above, from inside ccf_s1d/:

Le dépôt inclut 30 expositions réelles d'AU Mic prises par SPIRou en 2019 (sample_data/) ainsi qu'un masque de raies prêt à l'emploi (masks/LBL_Mask_AUMIC_neg_spirou.fits) : aucune donnée personnelle n'est nécessaire. Une fois le dépôt cloné comme ci-dessus, depuis ccf_s1d/ :

ccf-s1d run sample_data/*.fits \
    masks/LBL_Mask_AUMIC_neg_spirou.fits --plot

ccf-s1d run sample_data/*.fits \
    masks/LBL_Mask_AUMIC_neg_spirou.fits --plot

--plot also saves a normalized CCF plot (PNG) per file. When it's done, it prints exactly where the CCF data and plots landed, e.g. sample_data/ccf/.

--plot enregistre aussi un graphique du CCF normalisé (PNG) par fichier. À la fin, la commande indique précisément où les données CCF et les graphiques ont été enregistrés, par exemple sample_data/ccf/.

Building your own maskConstruire votre propre masque

Don't have a mask for your own target yet? Build one directly from a stack of your own s1d spectra: it stacks them into a low-noise template, flattens the continuum, and keeps the absorption lines that are deeper than a threshold, weighted by depth.

Vous n'avez pas encore de masque pour votre propre cible ? Construisez-en un directement à partir d'une série de vos propres spectres s1d : l'outil les empile en un modèle à faible bruit, aplatit le continuum, et conserve les raies d'absorption plus profondes qu'un seuil, pondérées par leur profondeur.

# builds a mask from a stack of your own s1d spectra
ccf-s1d mask your_star_s1d_files/*.fits \
    --out my_mask.fits

# construit un masque à partir d'une série de vos propres spectres s1d
ccf-s1d mask your_star_s1d_files/*.fits \
    --out my_mask.fits

Figures, from the bundled AU Mic dataFigures, à partir des données AU Mic incluses

Normalized CCF vs. velocity for the Y, J, H and K bands of one AU Mic SPIRou exposure, each showing a clear absorption dip near zero velocity, all on the same 0-1 depth scale. — Fig. 1 The four-band CCF of a single AU Mic exposure, each band normalized to its own continuum so Y, J, H and K (very different absolute flux levels) sit on one comparable depth scale. H and J carry the most correlation signal. Le CCF à quatre bandes d'une seule exposition d'AU Mic, chaque bande normalisée par son propre continuum pour que Y, J, H et K (des niveaux de flux absolus très différents) se retrouvent sur une échelle de profondeur comparable. H et J portent le plus de signal de corrélation.

River plot: a stack of 30 H-band CCF profiles, one row per epoch, ordered by calendar date, showing a stable dark absorption core with no drift. — Fig. 2 River plot: every H-band CCF from the 30 bundled epochs, one row per date. The core sits at the same velocity from April to November 2019: no BERV leakage, no drift. Diagramme en rivière : chaque CCF en bande H parmi les 30 époques incluses, une ligne par date. Le cœur du profil reste à la même vitesse d'avril à novembre 2019 : aucune fuite du BERV, aucune dérive.

Three stacked time series against calendar date: radial velocity near 0.2 km/s, FWHM around 15-21 km/s, and contrast around 50-65 percent, for AU Mic in the H band. — Fig. 3 Radial velocity isn't the only thing a CCF gives you: FWHM and contrast, plotted here against true calendar dates, track the line profile's shape and depth over the season. La vitesse radiale n'est pas la seule chose qu'un CCF vous donne : la largeur (FWHM) et le contraste, tracés ici selon de vraies dates calendaires, suivent la forme et la profondeur du profil de raie au fil de la saison.

Package layoutStructure du paquet

Module What's in itContenu

ccf_s1d.core compute_ccf, doppler, gauss: the CCF itself. : le CCF lui-même.

ccf_s1d.mask build_mask_from_files: builds a line mask from a stack of your own s1d spectra when you don't have one. : construit un masque de raies à partir d'une série de vos propres spectres s1d quand vous n'en avez pas.

ccf_s1d.fit fit_ccf, fit_ccf_table: Gaussian fits for RV, FWHM and contrast, per band. : ajustements gaussiens pour la vitesse radiale, la largeur et le contraste, par bande.

ccf_s1d.plotting plot_ccf, plot_ccf_river, plot_ccf_moments: the figures on this page. : les figures de cette page.

ccf_s1d.cli the l'outil en ligne de commande ccf-s1d command line tool (mask, run). (mask, run).

Module	What's in itContenu
`ccf_s1d.core`	`compute_ccf`, `doppler`, `gauss`: the CCF itself. : le CCF lui-même.
`ccf_s1d.mask`	`build_mask_from_files`: builds a line mask from a stack of your own s1d spectra when you don't have one. : construit un masque de raies à partir d'une série de vos propres spectres s1d quand vous n'en avez pas.
`ccf_s1d.fit`	`fit_ccf`, `fit_ccf_table`: Gaussian fits for RV, FWHM and contrast, per band. : ajustements gaussiens pour la vitesse radiale, la largeur et le contraste, par bande.
`ccf_s1d.plotting`	`plot_ccf`, `plot_ccf_river`, `plot_ccf_moments`: the figures on this page. : les figures de cette page.
`ccf_s1d.cli`	the l'outil en ligne de commande `ccf-s1d` command line tool (`mask`, `run`). (`mask`, `run`).