Coverage for python/lsst/pipe/tasks/script/registerSkymap.py: 38%

23 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-03-29 10:41 +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 

22import logging 

23 

24from lsst.daf.butler import Butler 

25import lsst.pex.config as pexConfig 

26from lsst.skymap import skyMapRegistry 

27 

28 

29_log = logging.getLogger(__name__) 

30 

31 

32class MakeSkyMapConfig(pexConfig.Config): 

33 """Config for makeSkyMap. 

34 """ 

35 name = pexConfig.Field( 

36 doc="Name assigned to created skymap in butler registry", 

37 dtype=str, 

38 default=None, 

39 optional=True 

40 ) 

41 skyMap = skyMapRegistry.makeField( 

42 doc="type of skyMap", 

43 default="dodeca", 

44 ) 

45 

46 def validate(self): 

47 if self.name is None: 

48 raise ValueError("The name field must be set to the name of the specific " 

49 "skymap to use when writing to the butler") 

50 

51 

52def makeSkyMap(butler, config): 

53 """Construct and save a SkyMap into a gen3 butler repository. 

54 

55 Parameters 

56 ---------- 

57 butler : `lsst.daf.butler.Butler` 

58 Butler repository to which the new skymap will be written. 

59 config : `MakeSkyMapConfig` or None 

60 Instance of a configuration class specifying task options. 

61 """ 

62 skyMap = config.skyMap.apply() 

63 skyMap.logSkyMapInfo(_log) 

64 skyMap.register(config.name, butler) 

65 

66 

67def registerSkymap(repo, config, config_file): 

68 """Make and register a SkyMap in a butler repository. 

69 

70 Parameters 

71 ---------- 

72 repo : `str` 

73 URI to the location of the butler repository. 

74 config : `dict` [`str`, `str`] or `None` 

75 Key-value pairs to apply as overrides to the ingest config. 

76 config_file : `str` or `None` 

77 Path to a config overrides file. 

78 

79 Raises 

80 ------ 

81 RuntimeError 

82 If a config overrides file is given and does not exist. 

83 """ 

84 

85 skyMapConfig = MakeSkyMapConfig() 

86 if config_file: 

87 skyMapConfig.load(config_file) 

88 

89 if config: 

90 skyMapConfig.update(**config) 

91 

92 butler = Butler(repo, writeable=True) 

93 makeSkyMap(butler, skyMapConfig)