Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configfile #13

Merged
merged 4 commits into from
Sep 24, 2024
Merged

Configfile #13

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f76dbb
added cache_dir option
Nschanche Sep 20, 2024
d6b9ba6
rearrange cache_dir
Nschanche Sep 23, 2024
5e6e234
Update changelog
Nschanche Sep 24, 2024
b86aabb
remove print
Nschanche Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

- Added the option to use the initial TESS commissioning PRF files [#9]
- Modified tessprf.py and keplerprf.py to use only the closest PRF measurements to create the supersampled PRF [#8]

- Added cache_dir flag to change default location for reading/writing engineer files [#13]
1.0.3 (2024-07-30)
==================

Expand Down
32 changes: 16 additions & 16 deletions src/lkprf/data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from scipy.ndimage import label, uniform_filter

from . import logger, PACKAGEDIR
CACHEDIR = PACKAGEDIR + '/data/'

__all__ = [
"download_kepler_prf_file",
Expand Down Expand Up @@ -91,10 +92,10 @@ def _download_file(url, file_path):
raise http_err


def download_kepler_prf_file(module: int, output: int):
def download_kepler_prf_file(module: int, output: int, cache_dir: str = CACHEDIR):
"""Download a Kepler Module file"""
filename = f"kplr{module:02}.{output}_2011265_prf.fits"
file_path = f"{PACKAGEDIR}/data/{filename}"
file_path = f"{cache_dir}{filename}"
url = f"https://archive.stsci.edu/missions/kepler/fpc/prf/{filename}"
logger.info(f"Downloading {module:02}.{output}")
_download_file(url, file_path)
Expand All @@ -104,7 +105,7 @@ def download_kepler_prf_file(module: int, output: int):
return


def build_tess_prf_file(camera: int, ccd: int, sector: int):
def build_tess_prf_file(camera: int, ccd: int, sector: int, cache_dir: str = CACHEDIR):
"""Download a set of TESS PRF files for a given camera/ccd"""

def open_file(url: str):
Expand Down Expand Up @@ -138,7 +139,7 @@ def open_file(url: str):
prefix = _tess_prefixes[camera][ccd]
filename = f"tess-prf-cam{camera}-ccd{ccd}-sec4.fits"

file_path = f"{PACKAGEDIR}/data/{filename}"
file_path = f"{cache_dir}{filename}"
# ensure the file_path exists
if not os.path.exists(file_path):
os.makedirs(os.path.dirname(file_path), exist_ok=True)
Expand All @@ -160,51 +161,50 @@ def open_file(url: str):
return


def get_kepler_prf_file(module: int, output: int):
def get_kepler_prf_file(module: int, output: int, cache_dir: str = CACHEDIR):
"""Download a Kepler Module file"""
filename = f"kplr{module:02}.{output}_2011265_prf.fits"
file_path = f"{PACKAGEDIR}/data/{filename}"
file_path = f"{cache_dir}{filename}"
if not os.path.isfile(file_path):
logger.info(
f"No local files found, building Kepler PRF for Module {module}, output {output}."
)
download_kepler_prf_file(module=module, output=output)
file_path = f"{PACKAGEDIR}/data/{filename}"
download_kepler_prf_file(module=module, output=output, cache_dir=cache_dir)

hdulist = fitsio.FITS(file_path)
return hdulist


def get_tess_prf_file(camera: int, ccd: int, sector: int = 4):
def get_tess_prf_file(camera: int, ccd: int, sector: int = 4, cache_dir: str = CACHEDIR):
"""Get a PRF file for a given camera/ccd/sector"""
if sector <= 3:
filename = f"tess-prf-cam{camera}-ccd{ccd}-sec1.fits"
else:
filename = f"tess-prf-cam{camera}-ccd{ccd}-sec4.fits"
file_path = f"{PACKAGEDIR}/data/{filename}"
file_path = f"{cache_dir}{filename}"
if not os.path.isfile(file_path):
logger.info(
f"No local files found, building TESS PRF for Camera {camera}, CCD {ccd}."
)
build_tess_prf_file(camera=camera, ccd=ccd, sector=sector)

build_tess_prf_file(camera=camera, ccd=ccd, sector=sector, cache_dir=cache_dir)
hdulist = fitsio.FITS(file_path)
return hdulist


def clear_kepler_cache():
def clear_kepler_cache(cache_dir: str = CACHEDIR):
for module in np.arange(26):
for output in np.arange(1, 5):
filename = f"kplr{module:02}.{output}_2011265_prf.fits"
file_path = f"{PACKAGEDIR}/data/{filename}"
file_path = f"{cache_dir}{filename}"
if os.path.isfile(file_path):
os.remove(file_path)


def clear_tess_cache():
def clear_tess_cache(cache_dir: str = CACHEDIR):
for camera in np.arange(1, 5):
for ccd in np.arange(1, 5):
filename = f"tess-prf-{camera}-{ccd}.fits"
file_path = f"{PACKAGEDIR}/data/{filename}"
file_path = f"{cache_dir}{filename}"
if os.path.isfile(file_path):
os.remove(file_path)
7 changes: 5 additions & 2 deletions src/lkprf/keplerprf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import numpy as np
from .utils import channel_to_module_output, LKPRFWarning
from .data import get_kepler_prf_file
from . import PACKAGEDIR
import warnings

from .prfmodel import PRF
Expand All @@ -21,18 +22,20 @@ class KeplerPRF(PRF):
https://archive.stsci.edu/missions/kepler/commissioning_prfs/
"""

def __init__(self, channel: int):
def __init__(self, channel: int, cache_dir: str = PACKAGEDIR + '/data/'):
super().__init__()
self.channel = channel
self.mission = "Kepler"
self.cache_dir = cache_dir
self._prepare_prf()


def __repr__(self):
return f"KeplerPRF Object [Channel {self.channel}]"

def _get_prf_data(self):
module, output = channel_to_module_output(self.channel)
return get_kepler_prf_file(module=module, output=output)
return get_kepler_prf_file(module=module, output=output, cache_dir = self.cache_dir)

def update_coordinates(self, targets: List[Tuple], shape: Tuple):
row, column = self._unpack_targets(targets)
Expand Down
7 changes: 5 additions & 2 deletions src/lkprf/tessprf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import numpy as np
from .utils import LKPRFWarning
from .data import get_tess_prf_file
from . import PACKAGEDIR
import warnings

from .prfmodel import PRF
Expand All @@ -14,19 +15,21 @@ class TESSPRF(PRF):
"""A TESSPRF class. The TESS PRF measurements are supersampled by a factor of 9.
Two PRF models were produced, one for sectors 1-3 and a second set for sectors 4+ """

def __init__(self, camera: int, ccd: int, sector: int = 4):
def __init__(self, camera: int, ccd: int, sector: int = 4, cache_dir: str = PACKAGEDIR + '/data/'):
super().__init__()
self.camera = camera
self.ccd = ccd
self.sector = sector
self.mission = "TESS"
self.cache_dir = cache_dir
self._prepare_prf()

def __repr__(self):
return f"TESSPRF Object [Camera {self.camera}, CCD {self.ccd}, Sector {self.sector}]"

def _get_prf_data(self):
return get_tess_prf_file(camera=self.camera, ccd=self.ccd, sector=self.sector)
print(self.cache_dir)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be removed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

return get_tess_prf_file(camera=self.camera, ccd=self.ccd, sector=self.sector, cache_dir=self.cache_dir)

def update_coordinates(self, targets: List[Tuple], shape: Tuple):
row, column = self._unpack_targets(targets)
Expand Down
Loading