is_period_cont

tessilator.contaminants.is_period_cont(d_target, d_cont, t_cont, frac_amp_cont=0.5)[source]

Identify neighbouring contaminants that may cause the periodicity.

If the user selects to measure periods for the neighbouring contaminants this function returns a flag to assess if a contaminant may actually be the source causing the observed periodicity. The function produces two flags: false_flag and reliable_flag, where the former assesses how likely a contaminant might be causing the periodicity, and the latter indicates how likely it is that the periodicity comes from the target.

Parameters:
d_targetdict

A dictionary containing periodogram data of the target star.

d_contdict

A dictionary containing periodogram data of the contaminant star.

t_contastropy.table.Table

A table containing Gaia data for the contaminant star

frac_amp_contfloat, optional, default=0.5

The threshold factor to account for the difference in amplitude of the two stars. If this is high, then the contaminants will be less likely to be flagged as the potential source

Returns:
false_flagint

Either 1 or 0, with 1 (0) indicating the contaminant is (un)likely to cause the periodicity.

reliable_flagint

Either 1 or 0, with 1 (0) suggesting that the target provides an unreliable (reliable) rotation period.