arve.star package

Submodules

arve.star.add_vpsd_components module

class arve.star.add_vpsd_components.add_vpsd_components[source]

Bases: object

add_vpsd_components(components: list[Literal['oscillations', 'granulation', 'supergranulation', 'noise']] = ['oscillations', 'granulation', 'supergranulation', 'noise']) → None[source]

Add velocity power spectral density (VPSD) components.

Parameters:: components (list[Literal["oscillations", "granulation", "supergranulation", "noise"]], optional) – VPSD components, by default [“oscillations”, “granulation”, “supergranulation”, “noise”]
Returns:: None
Return type:: None

arve.star.compute_vpsd module

class arve.star.compute_vpsd.compute_vpsd[source]

Bases: object

compute_vpsd(oversamp: float = 1, N_bin: int | None = None) → None[source]

Compute velocity power spectral density (VPSD).

Parameters:

oversamp (float, optional) – oversamling factor of the periodogram frequency grid, by default 1
N_bin (int | None, optional) – number of logarithmically equidistant frequency bins for the averaged VPSD (if None, each order of magnitude in frequency is divided into 10 bins), by default None

Returns:

None

Return type:

None

arve.star.fit_vpsd_coefficients module

class arve.star.fit_vpsd_coefficients.fit_vpsd_coefficients[source]

Bases: object

fit_vpsd_coefficients(coef_bound: float = 10) → None[source]

Fit velocity power spectral density (VPSD) coefficients.

Parameters:: coef_bound (float, optional) – multiplicative factor within which the fitted coefficient are bounded with respect to their theoretical values, by default 10
Returns:: None
Return type:: None

arve.star.get_stellar_parameters module

class arve.star.get_stellar_parameters.get_stellar_parameters[source]

Bases: object

get_stellar_parameters() → None[source]

Get stellar parameters. Spectral type is queried from SIMBAD and other parameters are interpolated from a main-sequence table. The Sun has hard-coded values.

Returns:: None
Return type:: None

arve.star.plot_vpsd_components module

class arve.star.plot_vpsd_components.plot_vpsd_components[source]

Bases: object

plot_vpsd_components(fig: Figure | None = None, figsize: tuple = (10, 10), colors: list[str] = ['C0', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9'], add_legend: bool = True, total_only: bool = False) → Figure[source]

Plot velocity power spectral density (VPSD) components.

Parameters:

fig (plt.Figure | None, optional) – figure on which to plot (if None, a new figure is created), by default None
figsize (tuple, optional) – figure size, by default (10,10)
colors (list[str], optional) – line colors for components, by default [“C0”, “C1”, “C2”, “C3”, “C4”, “C5”, “C6”, “C7”, “C8”, “C9”]
add_legend (bool, optional) – add legend about line colors, by default True
total_only (bool, optional) – plot only total component (sum of all components), by default False

Returns:

figure with the VPSD, its log-average and its modeled components

Return type:

plt.Figure

arve.star.simulate_vrad_from_vpsd_components module

class arve.star.simulate_vrad_from_vpsd_components.simulate_vrad_from_vpsd_components[source]

Bases: object

simulate_vrad_from_vpsd_components(time_start: float, time_stop: float, time_step: float) → None[source]

Simulate radial velocities (RVs) from velocity power spectral density (VPSD) components.

Parameters:

time_start (float) – start time
time_stop (float) – stop time
time_step (float) – time step

Returns:

None

Return type:

None

Module contents

class arve.star.Star(arve)[source]

Bases: add_vpsd_components, compute_vpsd, fit_vpsd_coefficients, get_stellar_parameters, plot_vpsd_components, simulate_vrad_from_vpsd_components

ARVE Star subclass.