sherlockpipe.vetting.vetter.Vetter

class sherlockpipe.vetting.vetter.Vetter(object_dir, vetting_dir, is_candidate_from_search, candidates_df)

Bases: ToolWithCandidate

Coordinates the vetting of transit candidates using the WATSON pipeline.

Extends ToolWithCandidate to wrap the Watson vetting tool, providing convenient methods for running vetting with pre-loaded data.

__init__(object_dir, vetting_dir, is_candidate_from_search, candidates_df) → None

Initialize the vetter.

Parameters

object_dirstr

Directory containing the object’s data files.

vetting_dirstr

Directory where vetting outputs will be written.

is_candidate_from_searchbool

Whether the candidate comes from a SHERLOCK search.

candidates_dfpandas.DataFrame

DataFrame of candidate information.

Methods

__init__(object_dir, vetting_dir, ...)	Initialize the vetter.
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.
object_dir()	Return the object directory used by the internal WATSON instance.
run(cpus, **kwargs)	Execute the vetting analysis via WATSON.

Attributes

watson

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

object_dir()

Return the object directory used by the internal WATSON instance.

Returns

str

Path to the object’s data directory.

run(cpus, **kwargs)

Execute the vetting analysis via WATSON.

Parameters

cpusint

Number of CPUs to use.

**kwargsdict

Vetting parameters passed to watson.vetting_with_data, including candidate, star_df, transits_df, transits_mask, and TRICERATOPS options.