arve.planets package

Submodules

arve.planets.fit_keplerians module

class arve.planets.fit_keplerians.fit_keplerians[source]

Bases: object

fit_keplerians(oversamp: float = 3, fap: float = 0.01, P_lim: float = 0.1, N_max: int = 10) → None[source]

Fit Keplerians.

Parameters:

  • oversamp (float, optional) – oversamling factor of the periodogram frequency grid, by default 3

  • fap (float, optional) – false-alarm probability (FAP) level, by default 0.01

  • P_lim (float, optional) – allowed fractional period error for fitting bound, by default 0.1

  • N_max (int, optional) – maximum number of fitted Keplerians, by default 10

Returns:

None

Return type:

None

arve.planets.injection_recovery module

class arve.planets.injection_recovery.injection_recovery[source]

Bases: object

injection_recovery(xy_arr: ndarray | None = None, p_arr: ndarray | None = None, xy_map: list[float] | None = None, map_dim: list[float] | None = [10, 10], x_var: Literal['P', 'a'] = 'P', y_var: Literal['K', 'm'] = 'K', scale: Literal['linear', 'log'] = 'linear', P_lim: float = 0.1, oversamp: float = 3, fap: float = 0.01, N_max: int = 10) → None[source]

Injection-recovery test of specific injected values, 2D map or both.

Parameters:

  • xy_arr (np.ndarray | None, optional) – 2D array with injected values in the format [x_arr, y_arr], by default None

  • p_arr (np.ndarray | None, optional) – 1D array with injected phases, by default None

  • xy_map (list[float] | None, optional) – array with 2D map bounds in the format [x_min, x_max, y_min, y_max], by default None

  • map_dim (list[float] | None, optional) – map dimensions in the format [x_dim, y_dim] (only used if xy_map is provided), by default [10,10]

  • x_var (Literal["P", "a"], optional) – x variable, either period “P” in days or semi-major axis “a” in AUs, by default “P”

  • y_var (Literal["K", "m"], optional) – y variable, either RV semi-amplitude “K” in km/s or planet mass “m” in Earth masses, by default “K”

  • scale (Literal["linear", "log"], optional) – scale of injected values, either “linear” or “log”, by default “linear”

  • P_lim (float, optional) – fraction of injected periods within which the recovered periods can differ to count as recoveries, by default 0.1

  • oversamp (float, optional) – oversamling factor of the periodogram frequency grid, by default 3

  • fap (float, optional) – false-alarm probability (FAP) level, by default 0.01

  • N_max (int, optional) – maximum number of fitted Keplerians, by default 10

Returns:

None

Return type:

None

arve.planets.plot_keplerians module

class arve.planets.plot_keplerians.plot_keplerians[source]

Bases: object

plot_keplerians(figsize: tuple | None = None) → Figure[source]

Plot Keplerians.

Parameters:

figsize (tuple | None, optional) – figure size, by default None

Returns:

figure with fitted Keplerians and their periodograms

Return type:

plt.Figure

arve.planets.plot_recoveries module

class arve.planets.plot_recoveries.plot_recoveries[source]

Bases: object

plot_recoveries(figsize: tuple = (10, 10), vmin: float = 0, vmax: float = 2) → Figure[source]

Plot recoveries.

Parameters:

  • figsize (tuple, optional) – figure size, by default (10,10)

  • vmin (float, optional) – minimum value in color map, by default 0

  • vmax (float, optional) – maximum value in color map, by default 2

Returns:

figure with injection-recovery test results

Return type:

plt.Figure

arve.planets.recovery_test module

class arve.planets.recovery_test.recovery_test[source]

Bases: object

recovery_test(P_inj: ndarray, K_inj: ndarray, p_inj: ndarray | None = None, P_err: ndarray | None = None, oversamp: float = 3, fap: float = 0.01, N_max: int = 10) → ndarray[source]

Recovery test (used by injection_recovery() function).

Parameters:

  • P_inj (np.ndarray) – injected periods

  • K_inj (np.ndarray) – injected RV semi-amplitudes

  • p_inj (np.ndarray | None, optional) – injected phases, by default None

  • P_err (np.ndarray | None, optional) – allowed differences between injected and fitted periods to count as recoveries (set to 10% of injected periods if not provided), by default None

  • oversamp (float, optional) – oversamling factor of the periodogram frequency grid, by default 3

  • fap (float, optional) – false-alarm probability (FAP) level, by default 0.01

  • N_max (int, optional) – maximum number of fitted Keplerians, by default 10

Returns:

ratios between recovered and injected RV semi-amplitudes for recovered Keplerians

Return type:

np.ndarray

Module contents

class arve.planets.Planets(arve)[source]

Bases: fit_keplerians, injection_recovery, plot_keplerians, plot_recoveries, recovery_test

ARVE Planets subclass.