From de08ab140514449c4ed3dd1622305872d79aabc7 Mon Sep 17 00:00:00 2001 From: JannisNe Date: Fri, 24 Mar 2023 12:34:25 +0100 Subject: [PATCH] add doc --- timewise/wise_data_base.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/timewise/wise_data_base.py b/timewise/wise_data_base.py index c184d77..c1ea48b 100644 --- a/timewise/wise_data_base.py +++ b/timewise/wise_data_base.py @@ -1501,6 +1501,16 @@ def calculate_position_mask(lightcurve): return pd.Series(keep_mask).to_dict() def get_position_mask(self, service, chunk_number): + """ + Get the position mask for a chunk + + :param service: The service that was used to download the data, either of `gator` or `tap` + :type service: str + :param chunk_number: chunk number + :type chunk_number: int + :returns: position masks + :rtype: dict + """ logger.info(f"getting position masks for {service}, chunk {chunk_number}") fn = os.path.join(self.cache_dir, "position_masks", f"{service}_chunk{chunk_number}.json")