sherlockpipe.loading.tool_with_candidate.ToolWithCandidate

class sherlockpipe.loading.tool_with_candidate.ToolWithCandidate(is_candidate_from_search, candidates_df)

Bases: object

Base class to be extended by tools that process candidates information.

__init__(is_candidate_from_search, candidates_df) → None

Methods

__init__(is_candidate_from_search, candidates_df)
is_candidate_aware()	Boolean return to inform whether the candidate to be processed comes from SHERLOCK searches or is user-given.
mask_previous_candidates(time, flux, ...)	Masks all the candidates found in previous runs in the SHERLOCK search.

is_candidate_aware()

Boolean return to inform whether the candidate to be processed comes from SHERLOCK searches or is user-given.

Returns:

boolean with the value

mask_previous_candidates(time, flux, flux_err, candidate_id)

Masks all the candidates found in previous runs in the SHERLOCK search.

Parameters:

• time – the time array

• flux – the flux measurements array

• flux_err – the flux error measurements array

• candidate_id – the candidate number

Returns:

time, flux and flux_err with previous candidates in-transit data masked