sherlockpipe.scoring.SdeBorderCorrectedSignalSelector.CorrectedBorderSdeSignalSelection

class sherlockpipe.scoring.SdeBorderCorrectedSignalSelector.CorrectedBorderSdeSignalSelection(score, corrected_sde, original_curve_index, original_transit_result, final_curve_index, final_transit_result)

Bases: SignalSelection

Container for the result of an SDE border-corrected signal selection.

__init__(score, corrected_sde, original_curve_index, original_transit_result, final_curve_index, final_transit_result)

Initialize the corrected border SDE signal selection.

Parameters

scorefloat

The selection score.

corrected_sdefloat

The border-corrected SDE value of the final selection.

original_curve_indexint

The curve index of the original (non-corrected) selection.

original_transit_resultTransitResult

The transit result of the original (non-corrected) selection.

final_curve_indexint

The curve index of the final (corrected) selection.

final_transit_resultTransitResult

The transit result of the final (corrected) selection.

Methods

__init__(score, corrected_sde, ...)	Initialize the corrected border SDE signal selection.
get_message()	Return a human-readable summary of the corrected border SDE signal selection.

get_message()

Return a human-readable summary of the corrected border SDE signal selection.

Returns

str

A string describing the chosen signal with its corrected SDE and the original signal that would have been chosen without correction.