LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
registerSkymap.py
Go to the documentation of this file.
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 
22 import logging
23 
24 from lsst.daf.butler import Butler
25 import lsst.pex.config as pexConfig
26 from lsst.skymap import skyMapRegistry
27 
28 
29 _log = logging.getLogger(__name__)
30 
31 
32 class 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.namename 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 
52 def 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 
67 def 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)
def registerSkymap(repo, config, config_file)