Coverage for python/lsst/obs/base/script/writeCuratedCalibrations.py: 62%

8 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-01-04 02:10 -0800

1# This file is part of obs_base. 

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 

22import logging 

23 

24from lsst.daf.butler import Butler 

25from lsst.pipe.base import Instrument 

26 

27log = logging.getLogger(__name__) 

28 

29 

30def writeCuratedCalibrations(repo, instrument, collection, labels): 

31 """Add an instrument's curated calibrations to the data repository. 

32 

33 Parameters 

34 ---------- 

35 repo : `str` 

36 URI to the location to create the repo. 

37 instrument : `str` 

38 The name or the fully qualified class name of an instrument. 

39 collection : `str` or `None` 

40 The path to the collection that assocaites datasets with validity 

41 ranges. 

42 Can be `None` in which case the collection name will be determined 

43 automatically. 

44 labels : `Sequence` [ `str` ] 

45 Extra strings to include in the names of collections that datasets are 

46 inserted directly into, and if ``collection`` is `None`, the automatic 

47 calibration collection name as well. 

48 

49 Raises 

50 ------ 

51 RuntimeError 

52 Raised if the instrument can not be imported, instantiated, or obtained 

53 from the registry. 

54 TypeError 

55 Raised if the instrument is not a subclass of 

56 `lsst.obs.base.Instrument`. 

57 """ 

58 butler = Butler(repo, writeable=True) 

59 instr = Instrument.from_string(instrument, butler.registry) 

60 instr.writeCuratedCalibrations(butler, collection=collection, labels=labels)