sherlockpipe.search.phase_coverage.phase_coverage.PhaseCoverage

class sherlockpipe.search.phase_coverage.phase_coverage.PhaseCoverage

Bases: object

Computes and plots the phase coverage of a time series over a grid of trial periods.

Phase coverage measures what fraction of each orbital phase is sampled by the observations, which is useful for assessing signal detectability.

__init__()

Methods

__init__()
compute_phase_coverage(dir, time, period_grid)	Computes the phase coverage over the full period grid and saves a plot.
phase_coverage(phase_coverage_input)	Computes the phase coverage for a single trial period.

static compute_phase_coverage(dir: str, time: List[float], period_grid: List[float], cpus=1)

Computes the phase coverage over the full period grid and saves a plot.

Parameters

dirstr

Output directory where the phase coverage plot is saved.

timelist of float

Time array of the observations in days.

period_gridlist of float

Array of trial periods in days.

cpusint

Number of CPU cores for parallel computation.

static phase_coverage(phase_coverage_input: PhaseCoverageInput)

Computes the phase coverage for a single trial period.

Parameters

phase_coverage_inputPhaseCoverageInput

Container with the time array and trial period.

Returns

float

The phase coverage fraction (0 to 1).