sherlockpipe.scoring.SignalSelector.SignalSelection

class sherlockpipe.scoring.SignalSelector.SignalSelection(score, curve_index, transit_result)

Bases: object

Container for the result of a signal selection.

__init__(score, curve_index, transit_result)

Initialize the signal selection.

Parameters

scorefloat

The selection score (1 if thresholds are met, 0 otherwise).

curve_indexint

The index of the detrended curve that produced the best signal.

transit_resultTransitResult

The transit result object for the selected signal.

Methods

__init__(score, curve_index, transit_result)	Initialize the signal selection.
get_message()	Return a human-readable summary of the signal selection.

get_message()

Return a human-readable summary of the signal selection.

Returns

str

A string describing the chosen signal with its name, period, SNR, SDE, FAP, and border score.