iCCF provides a few command-line scripts to work with CCFs.

iccf-make-ccf

This script is very meta, because it creates CCFs themselves! Provided an S2D file with a stellar spectra (across the spatial and cross-dispersion dimensions), it will correlate it with a CCF mask to calculate the CCF. Currently, this works best for S2D files created with the official ESPRESSO pipeline, but the code could be general enough to work in other cases.

usage: iccf-make-ccf [-h] [-o OUTPUT] [-m MASK] [-rv RV] [--rv-range RV_RANGE] 
                          [--keep-prefix] [--ncores NCORES] files [files ...]

This script takes a list of S2D fits files and calculates the CCF for 
a given RV array and a given mask. If these are not provided, it uses
the same as specified in the S2D file.

positional arguments:
  files                 S2D files

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Output file name
  -m MASK, --mask MASK  Mask (G2, G9, K6, M2, ...). A file called `INST_[mask].fits` should exist.
  -rv RV, --rv RV       RV array, in the form start:end:step [km/s]
  --rv-range RV_RANGE   Full RV range where to calculate CCF [km/s]
  --keep-prefix         Keep any prefix of the S2D file on the output file
  --ncores NCORES       Number of cores to distribute calculation; default is all available

A lot of effort has been put into making sure that the CCFs calculated by iCCF are identical to those from the ESPRESSO pipeline! Indeed, the code is based on the pipeline’s implementation and follows exactly the same steps.


Copyright © 2020-2025 João Faria. Distributed under the MIT license.