sherlockpipe.search_zones.SearchZone.SearchZone

class sherlockpipe.search_zones.SearchZone.SearchZone

Bases: ABC

Abstract class to be implemented for calculating minimum and maximum search periods for an input star.

__init__()

Initialize the search zone.

Methods

__init__()	Initialize the search zone.
calculate_period_range(star_info)	Calculates the minimum and maximum periods for the given star_info

abstractmethod calculate_period_range(star_info: StarInfo)

Calculates the minimum and maximum periods for the given star_info

Parameters:

star_info – the star where the range should be calculated

Returns:

a tuple of minimum_period and maximum_period