API

Previous

iCCF documentation page

iCCF.iCCF.Indicators(rv, ccf, eccf=None, RV_on=True, FWHM_on=True, BIS_on=True, Vspan_on=True, Wspan_on=True, contrast_on=True, BIS_HARPS=False)

Class to hold CCFs and CCF indicators

The default constructor takes rv and ccf arrays as input. See Indicators.from_file for another way to create the object from a CCF fits file. The CCF uncertainties can be provided as the eccf array. Keyword parameters turn specific indicators on or off. Is BIS_HARPS is True, the BIS is calculated using the same routine as in the HARPS pipeline.

OBJECT property

OBJECT keyword in the header

bjd property

Barycentric Julian Day when the observation was made

mask property

Mask used for the CCF calculation

RV property

Radial velocity, from a Gaussian fit to the CCF [km/s]

RVerror property

Photon-noise uncertainty on the radial velocity [km/s]

FWHM property

The full width at half maximum of the CCF [km/s]

FWHMerror property

Photon noise uncertainty on the FWHM of the CCF [km/s]

BIS property

Bisector span [km/s]

BISerror property

Photon noise uncertainty on the BIS of the CCF [km/s]

Vspan property

Vspan indicator [km/s], see Boisse et al. (2011b, A&A 528 A4)

Wspan property

Wspan indicator [km/s] see Santerne et al. (2015, MNRAS 451, 3)

DeltaV property

DeltaV indicator from a biGaussian fit [km/s] see Figueira et al. (2013, A&A, 557, A93)

ΔV property

ΔV indicator from a biGaussian fit [km/s] see Figueira et al. (2013, A&A, 557, A93)

contrast property

The contrast (depth) of the CCF, measured in percentage

contrast_error property

Uncertainty on the contrast (depth) of the CCF, measured in percentage

individual_RV property

Individual radial velocities for each spectral order [km/s]

individual_RVerror property

Individual radial velocity errors for each spectral order [km/s]

individual_FWHM property

Individual FWHM for each spectral order [km/s]

individual_FWHMerror property

Individual FWHM errors for each spectral order [km/s]

individual_contrast property

The contrast (depth) of the CCF for each spectral order [%]

individual_contrast_error property

Uncertainty on the contrast (depth) of the CCF for each spectral order [%]

all property

All the indicators that are on

pipeline_RV property

The radial velocity as derived by the pipeline, from the header.

pipeline_FWHM property

The CCF FWHM as derived by the pipeline, from the header.

pipeline_CONTRAST property

The CCF contrast as derived by the pipeline, from the header.

pipeline_BIS property

The CCF BIS SPAN as derived by the pipeline, from the header.

pipeline_RVerror property

The RV error as derived by the pipeline, from the header.

from_file(file, hdu_number=1, data_index=-1, sort_bjd=True, keep_open=False, **kwargs) classmethod

Create an Indicators object from one or more fits files.

Parameters

file : str or list of str The name(s) of the fits file(s) hdu_number : int, default = 1 The index of the HDU list which contains the CCF data_index : int, default = -1 The index of the .data array which contains the CCF. The data will be accessed as ccf = HDU[hdu_number].data[data_index,:] sort_bjd : bool (default True) If True and filename is a list of files, sort them by BJD before reading

shift(radial_velocity, inplace=False)

Shift the CCF by a given radial velocity [km/s], using linear interpolation. If inplace=True, replaces self.ccf.

recalculate_ccf(orders=None, weighted=False)

Recompute the final CCF from the CCFs of individual orders

Parameters:

Name Type Description Default
orders (slice, int, tuple, list, array)

List of orders for which to sum the CCFs. If None, use all orders. If an int, return directly the CCF of that order (1-based).

 None

remove_orders(orders, weighted=False)

Remove specific orders and recompute the CCF (CAREFUL: 1-based indexing)

Parameters:

Name Type Description Default
orders (slice, int, tuple, list, array)

List of orders for which to sum the CCFs. If None, use all orders. If an int, return directly the CCF of that order (1-based).

 required

reset()

Reset the CCF to the original CCF

check(verbose=False)

Check if the iCCF calculated values match the pipeline values

fitted_gaussian(n=1000, over=0)

Evaluate the Gaussian fit to the CCF at n points

plot(ax=None, show_fit=True, show_bisector=False, show_residuals=False, over=0)

Plot the CCF, together with the Gaussian fit and the bisector

plot_individual_CCFs(fig=None, show_errors=True, show_fit=False, **kwargs)

Plot the CCFs for individual orders

plot_individual_RV(ax=None, relative=False, **kwargs)

Plot the RV for individual orders

Scripts