sherlockpipe.search.sherlock_target.SherlockTarget

class sherlockpipe.search.sherlock_target.SherlockTarget(object_info, detrend_method='biweight', detrend_l_min=None, detrend_l_max=None, detrends_number=10, detrend_cores=1, custom_selection_algorithm=None, custom_transit_template=None, search_zone=None, custom_search_zone=None, snr_min=5, sde_min=5, min_sectors=0, max_sectors=99999, bin_minutes=10, mask_mode='mask', cpu_cores=1, max_runs=10, period_min=0.5, period_max=33, period_protect=10, best_signal_algorithm='border-correct', quorum_strength=1, min_quorum=0, fit_method='tls', oversampling=10, t0_fit_margin=0.05, duration_grid_step=1.1, source_properties_file=None, cache_dir='/home/docs/', ignore_original=False, pickle_mode='none', use_harmonics_spectra=False, ois_mask=False, min_transits_count=2, compute_phase_coverage=False, search_engine='cpu')

Bases: object

Used as input for sherlockpipe.sherlock.Sherlock:

__init__(object_info, detrend_method='biweight', detrend_l_min=None, detrend_l_max=None, detrends_number=10, detrend_cores=1, custom_selection_algorithm=None, custom_transit_template=None, search_zone=None, custom_search_zone=None, snr_min=5, sde_min=5, min_sectors=0, max_sectors=99999, bin_minutes=10, mask_mode='mask', cpu_cores=1, max_runs=10, period_min=0.5, period_max=33, period_protect=10, best_signal_algorithm='border-correct', quorum_strength=1, min_quorum=0, fit_method='tls', oversampling=10, t0_fit_margin=0.05, duration_grid_step=1.1, source_properties_file=None, cache_dir='/home/docs/', ignore_original=False, pickle_mode='none', use_harmonics_spectra=False, ois_mask=False, min_transits_count=2, compute_phase_coverage=False, search_engine='cpu')

Configuration container for a single transiting planet search target.

Parameters

object_infolcbuilder.objectinfo.ObjectInfo.ObjectInfo

The mission object information (TIC, KIC, EPIC, etc.).

detrend_methodstr

Detrending method (‘biweight’ or ‘gp’).

detrend_l_minfloat or None

Minimum detrend window length / kernel size in days.

detrend_l_maxfloat or None

Maximum detrend window length / kernel size in days.

detrends_numberint

Number of detrend models to apply.

detrend_coresint

Number of CPU cores for detrending.

custom_selection_algorithmcallable or None

Custom signal selection algorithm.

custom_transit_templatecallable or None

Custom transit template generator for TLS.

search_zonestr or None

Predefined search zone (‘hz’, ‘ohz’, or None).

custom_search_zoneobject or None

Custom search zone resolver.

snr_minfloat

Minimum SNR threshold for a signal to be considered.

sde_minfloat

Minimum SDE threshold for a signal to be considered.

min_sectorsint

Minimum number of sectors required.

max_sectorsint

Maximum number of sectors allowed.

bin_minutesint

Binning size in minutes for detrend plots.

mask_modestr

Signal masking mode (‘mask’ or ‘subtract’).

cpu_coresint

Number of CPU cores for the search and fit.

max_runsint

Maximum number of iterative search runs.

period_minfloat

Minimum search period in days.

period_maxfloat

Maximum search period in days.

period_protectfloat

Period protection window in days for detrending.

best_signal_algorithmstr

Algorithm used to select the best signal among detrended curves.

quorum_strengthfloat

Voting strength for quorum-based signal selectors.

min_quorumint

Minimum votes for quorum-based signal selectors.

fit_methodstr

Transit fit method (‘tls’, ‘bls’, ‘bls-periodogram’, ‘grazing’, ‘tailed’, etc.).

oversamplingfloat

Oversampling factor for the period grid.

t0_fit_marginfloat

Margin in days for T0 fitting.

duration_grid_stepfloat

Step size for the duration grid.

source_properties_filestr or None

Path to the source YAML properties file.

cache_dirstr

Directory for caching downloaded data.

ignore_originalbool

If True, skip searching the original (undetrended) light curve.

pickle_modestr

Pickle output mode (‘none’, ‘all’, or ‘selected’).

use_harmonics_spectrabool

If True, compute harmonic spectra for detected signals.

ois_maskbool

If True, mask known Objects of Interest in the light curve.

min_transits_countint

Minimum number of transits required for a valid signal.

compute_phase_coveragebool

If True, compute the phase coverage over the period grid.

search_enginestr

Search engine backend (‘cpu’, ‘gpu’, or ‘gpu_approximate’).

Methods

__init__(object_info[, detrend_method, ...])

Configuration container for a single transiting planet search target.

Attributes

MASK_MODES
VALID_SIGNAL_SELECTORS