arve.functions package

Submodules

arve.functions.convert_air_to_vac module

class arve.functions.convert_air_to_vac.convert_air_to_vac[source]

Bases: object

convert_air_to_vac(wave_air: float | ndarray) → float | ndarray[source]

Convert wavelengths from air to vacuum. Source: https://www.astro.uu.se/valdwiki/Air-to-vacuum%20conversion

Parameters:: wave_air (float | np.ndarray) – wavelength(s) in air [Å]
Returns:: wavelength(s) in vacuum [Å]
Return type:: float | np.ndarray

arve.functions.convert_vac_to_air module

class arve.functions.convert_vac_to_air.convert_vac_to_air[source]

Bases: object

convert_vac_to_air(wave_vac: float | ndarray) → float | ndarray[source]

Convert wavelengths from vacuum to air. Source: https://www.astro.uu.se/valdwiki/Air-to-vacuum%20conversion

Parameters:: wave_vac (float | np.ndarray) – wavelength(s) in vacuum [Å]
Returns:: wavelength(s) in air [Å]
Return type:: float | np.ndarray

arve.functions.doppler_shift module

class arve.functions.doppler_shift.doppler_shift[source]

Bases: object

doppler_shift(wave: float | ndarray, v: float) → float | ndarray[source]

Doppler shift.

Parameters:

wave (float | np.ndarray) – wavelength(s)
v (float) – velocity in km/s

Returns:

Doppler-shifted wavelength(s)

Return type:

float | np.ndarray

arve.functions.gls_periodogram module

class arve.functions.gls_periodogram.gls_periodogram[source]

Bases: object

gls_periodogram(time_val: ndarray, data_val: ndarray, data_err: ndarray | None = None, oversamp: float = 1, normalize: bool = True, win_func: bool = False) → tuple[ndarray | float][source]

Generalized Lomb-Scargle (GLS) periodogram.

Parameters:

time_val (np.ndarray) – time values
data_val (np.ndarray) – data values
data_err (np.ndarray | None, optional) – data errors, by default None
oversamp (float, optional) – oversamling factor of the periodogram frequency grid, by default 1
normalize (bool, optional) – normalization of the periodogram, by default True
win_func (bool, optional) – return window function, by default False

Returns:

frequency, power spectrum and phase of the periodogram; if win_func is True, the frequency, power spectrum and area of the window function are returned as well

Return type:

tuple[np.ndarray | float]

arve.functions.inverted_gaussian module

class arve.functions.inverted_gaussian.inverted_gaussian[source]

Bases: object

inverted_gaussian(x: ndarray, *params: tuple[float]) → ndarray[source]

Inverted Gaussian.

Parameters:

x (np.ndarray) – abscissa values (e.g., RVs for CCF, or wavelengths for spectral lines)
params (tuple[float]) – tuple with continuum, contrast, center and FWHM

Returns:

inverted Gaussian evaluated at x

Return type:

np.ndarray

arve.functions.keplerian module

class arve.functions.keplerian.keplerian[source]

Bases: object

keplerian(t: ndarray, *params: tuple[float]) → ndarray[source]

Keplerian.

Parameters:

t (np.ndarray) – time values
params (tuple[float]) – tuple with period, RV semi-amplitude, phase and RV offset

Returns:

Keplerian evaluated at t

Return type:

np.ndarray

arve.functions.sptype_to_num module

class arve.functions.sptype_to_num.sptype_to_num[source]

Bases: object

sptype_to_num(sptype: str) → int[source]

Spectral type to number.

Parameters:: sptype (str) – spectral type
Returns:: spectral type represented as a number
Return type:: int

Module contents

class arve.functions.Functions(arve)[source]

Bases: convert_air_to_vac, convert_vac_to_air, doppler_shift, gls_periodogram, inverted_gaussian, keplerian, sptype_to_num

ARVE Functions subclass.