Coverage for python / lsst / obs / subaru / strayLight / formatter.py: 83%

1# This file is part of obs_subaru. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <http://www.gnu.org/licenses/>. 

21 

22from typing import Any 

23from lsst.resources import ResourcePath 

24from lsst.daf.butler import FormatterV2, FormatterNotImplementedError 

25 

26from .yStrayLight import SubaruStrayLightData 

27 

28__all__ = ("SubaruStrayLightDataFormatter",) 

29 

30 

31class SubaruStrayLightDataFormatter(FormatterV2): 

32 """Gen3 Butler Formatters for HSC y-band stray light correction data. 

33 """ 

34 

35 can_read_from_local_file = True 

36 default_extension = ".fits" 

37 

38 def read_from_local_file( 

39 self, path: str, component: str | None = None, expected_size: int = -1 

40 ) -> Any: 

41 # Docstring inherited from FitsGenericFormatter._readFile. 

42 return SubaruStrayLightData.readFits(path) 

43 

44 def write_local_file(self, in_memory_dataset: Any, uri: ResourcePath) -> None: 

45 # Docstring inherited from FitsGenericFormatter._writeFile. 

46 raise FormatterNotImplementedError("SubaruStrayLightData cannot be written directly.")