sherlockpipe.vetting.run.run_vet

sherlockpipe.vetting.run.run_vet(object_dir, candidate, properties, cpus=1, run_iatson=False, run_gpt=False, gpt_key=None, only_summary=False, triceratops_bins=100, triceratops_scenarios=5, triceratops_curve_file=None, triceratops_contrast_curve_file=None, triceratops_additional_stars_file=None, triceratops_sigma_mode='flux_err', triceratops_ignore_ebs=False, triceratops_resolved_companion=None, triceratops_ignore_background_stars=False, sectors=None)

Run vetting on a transit candidate using WATSON and TRICERATOPS.

Loads star and candidate data from disk, configures the Vetter, and executes the vetting pipeline including IATSON, GPT, and TRICERATOPS analyses.

Parameters

object_dirstr or None

Directory containing the object’s results. Defaults to current directory.

candidateint or None

Candidate number to vet. If None, properties file is used.

propertiesstr or None

Path to YAML properties file for non-search candidates.

cpusint, optional

Number of CPUs to use. Default is all minus one.

run_iatsonbool, optional

Whether to run deep-learning IATSON validation.

run_gptbool, optional

Whether to run GPT-based validation.

gpt_keystr, optional

API key for GPT services.

only_summarybool, optional

Whether to produce only a summary report.

triceratops_binsint, optional

Number of TRICERATOPS bins. Default is 100.

triceratops_scenariosint, optional

Number of TRICERATOPS scenarios. Default is 5.

triceratops_curve_filestr, optional

Path to a contrast curve file for TRICERATOPS.

triceratops_contrast_curve_filestr, optional

Path to a contrast curve file.

triceratops_additional_stars_filestr, optional

Path to a file listing additional nearby stars.

triceratops_sigma_modestr, optional

TRICERATOPS sigma mode. Default is ‘flux_err’.

triceratops_ignore_ebsbool, optional

Whether to ignore eclipsing binaries during TRICERATOPS.

triceratops_resolved_companionfloat, optional

Separation in arcseconds of a resolved companion.

triceratops_ignore_background_starsbool, optional

Whether to ignore background stars during TRICERATOPS.

sectorslist, optional

List of TESS sectors to use.