Coverage for python/lsst/pipe/tasks/script/makeDiscreteSkyMap.py: 15%

26 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-06-13 17:19 -0700

1# This file is part of pipe_tasks. 

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 lsst.daf.butler import Butler 

23from lsst.skymap import BaseSkyMap 

24from lsst.pipe.tasks.makeDiscreteSkyMap import MakeDiscreteSkyMapTask, MakeDiscreteSkyMapConfig 

25from lsst.pipe.base import Instrument 

26 

27 

28def makeDiscreteSkyMap(repo, config_file, collections, instrument, 

29 skymap_id='discrete', old_skymap_id=None): 

30 """Implements the command line interface `butler make-discrete-skymap` subcommand, 

31 should only be called by command line tools and unit test code that tests 

32 this function. 

33 

34 Constructs a skymap from calibrated exposure in the butler repository 

35 

36 Parameters 

37 ---------- 

38 repo : `str` 

39 URI to the location to read the repo. 

40 config_file : `str` or `None` 

41 Path to a config file that contains overrides to the skymap config. 

42 collections : `list` [`str`] 

43 An expression specifying the collections to be searched (in order) when 

44 reading datasets, and optionally dataset type restrictions on them. 

45 At least one collection must be specified. This is the collection 

46 with the calibrated exposures. 

47 instrument : `str` 

48 The name or fully-qualified class name of an instrument. 

49 skymap_id : `str`, optional 

50 The identifier of the skymap to save. Default is 'discrete'. 

51 old_skymap_id : `str`, optional 

52 The identifer of the skymap to append to. Must differ from 

53 ``skymap_id``. Ignored unless ``config.doAppend=True``. 

54 """ 

55 butler = Butler(repo, collections=collections, writeable=True) 

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

57 config = MakeDiscreteSkyMapConfig() 

58 instr.applyConfigOverrides(MakeDiscreteSkyMapTask._DefaultName, config) 

59 

60 if config_file is not None: 

61 config.load(config_file) 

62 # The coaddName for a SkyMap is only relevant in Gen2, and we completely 

63 # ignore it here; once Gen2 is gone it can be removed. 

64 oldSkyMap = None 

65 if config.doAppend: 

66 if old_skymap_id is None: 

67 raise ValueError("old_skymap_id must be provided if config.doAppend is True.") 

68 dataId = {'skymap': old_skymap_id} 

69 try: 

70 oldSkyMap = butler.get(BaseSkyMap.SKYMAP_DATASET_TYPE_NAME, collections=collections, 

71 dataId=dataId) 

72 except LookupError as e: 

73 msg = (f"Could not find seed skymap with dataId {dataId} " 

74 f"in collections {collections} but doAppend is {config.doAppend}. Aborting...") 

75 raise LookupError(msg, *e.args[1:]) 

76 

77 datasets = butler.registry.queryDatasets('calexp', collections=collections) 

78 wcs_bbox_tuple_list = [(butler.getDirect(ref.makeComponentRef("wcs")), 

79 butler.getDirect(ref.makeComponentRef("bbox"))) 

80 for ref in datasets] 

81 task = MakeDiscreteSkyMapTask(config=config) 

82 result = task.run(wcs_bbox_tuple_list, oldSkyMap) 

83 result.skyMap.register(skymap_id, butler)