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

29 statements  

« prev     ^ index     » next       coverage.py v7.4.3, created at 2024-03-05 13:33 +0000

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.resources import ResourcePath 

24from lsst.skymap import BaseSkyMap 

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

26from lsst.pipe.base import Instrument 

27 

28 

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

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

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

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

33 this function. 

34 

35 Constructs a skymap from calibrated exposure in the butler repository 

36 

37 Parameters 

38 ---------- 

39 repo : `str` 

40 URI to the location to read the repo. 

41 config_file : `str` or `None` 

42 URI to a config file that contains overrides to the skymap config. 

43 collections : `list` [`str`] 

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

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

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

47 with the calibrated exposures. 

48 instrument : `str` 

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

50 skymap_id : `str`, optional 

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

52 old_skymap_id : `str`, optional 

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

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

55 """ 

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

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

58 config = MakeDiscreteSkyMapConfig() 

59 instr.applyConfigOverrides(MakeDiscreteSkyMapTask._DefaultName, config) 

60 

61 if config_file is not None: 

62 resource = ResourcePath(config_file) 

63 with resource.as_local() as local_config: 

64 config.load(local_config.ospath) 

65 

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

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

68 oldSkyMap = None 

69 if config.doAppend: 

70 if old_skymap_id is None: 

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

72 dataId = {'skymap': old_skymap_id} 

73 try: 

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

75 dataId=dataId) 

76 except LookupError as e: 

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

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

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

80 

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

82 wcs_bbox_tuple_list = [(butler.get(ref.makeComponentRef("wcs")), 

83 butler.get(ref.makeComponentRef("bbox"))) 

84 for ref in datasets] 

85 task = MakeDiscreteSkyMapTask(config=config) 

86 result = task.run(wcs_bbox_tuple_list, oldSkyMap) 

87 result.skyMap.register(skymap_id, butler)