LSSTApplications  20.0.0
LSSTDataManagementBasePackage
makeGen3SkyMap.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 # (https://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 <https://www.gnu.org/licenses/>.
21 import lsst.pex.config as pexConfig
22 import lsst.pipe.base as pipeBase
23 from lsst.daf.butler import DatasetType
24 from lsst.skymap import skyMapRegistry
25 
26 from sqlalchemy.exc import IntegrityError
27 
28 
29 class MakeGen3SkyMapConfig(pexConfig.Config):
30  """Config for MakeGen3SkyMapTask
31  """
32  datasetTypeName = pexConfig.Field(
33  doc="Name assigned to created skymap in butler registry",
34  dtype=str,
35  default="deepCoadd_skyMap",
36  )
37  name = pexConfig.Field(
38  doc="Name assigned to created skymap in butler registry",
39  dtype=str,
40  default=None,
41  optional=True
42  )
43  skyMap = skyMapRegistry.makeField(
44  doc="type of skyMap",
45  default="dodeca",
46  )
47 
48  def validate(self):
49  if self.name is None:
50  raise ValueError("The name field must be set to the name of the specific "
51  "skymap to use when writing to the butler")
52 
53 
54 class MakeGen3SkyMapTask(pipeBase.Task):
55  ConfigClass = MakeGen3SkyMapConfig
56  _DefaultName = "makeGen3SkyMap"
57 
58  """This is a task to construct and optionally save a SkyMap into a gen3
59  butler repository.
60 
61  Parameters
62  ----------
63  config : `MakeGen3SkyMapConfig` or None
64  Instance of a configuration class specifying task options, a default
65  config is created if value is None
66  """
67 
68  def __init__(self, *, config=None, **kwargs):
69  super().__init__(config=config, **kwargs)
70 
71  def run(self, butler):
72  """Construct and optionally save a SkyMap into a gen3 repository
73  Parameters
74  ----------
75  butler : `lsst.daf.butler.Butler`
76  Butler repository to which the new skymap will be written
77  """
78  skyMap = self.config.skyMap.apply()
79  skyMap.logSkyMapInfo(self.log)
80  skyMapHash = skyMap.getSha1()
81  self.log.info(f"Registering dataset type {self.config.datasetTypeName}.")
82  butler.registry.registerDatasetType(DatasetType(name=self.config.datasetTypeName,
83  dimensions=["skymap"],
84  storageClass="SkyMap",
85  universe=butler.registry.dimensions))
86  self.log.info(f"Inserting SkyMap {self.config.name} with hash={skyMapHash}")
87  with butler.registry.transaction():
88  try:
89  skyMap.register(self.config.name, butler.registry)
90  except IntegrityError as err:
91  raise RuntimeError("A skymap with the same name or hash already exists.") from err
92  butler.put(skyMap, self.config.datasetTypeName, {"skymap": self.config.name})
93  return pipeBase.Struct(
94  skyMap=skyMap
95  )
lsst.pipe.tasks.makeGen3SkyMap.MakeGen3SkyMapTask.__init__
def __init__(self, *config=None, **kwargs)
Definition: makeGen3SkyMap.py:68
lsst::log.log.logContinued.info
def info(fmt, *args)
Definition: logContinued.py:198
lsst.pipe.tasks.makeGen3SkyMap.MakeGen3SkyMapTask.run
def run(self, butler)
Definition: makeGen3SkyMap.py:71
lsst.pipe.tasks.makeGen3SkyMap.MakeGen3SkyMapConfig.name
name
Definition: makeGen3SkyMap.py:37
lsst.pipe.tasks.makeGen3SkyMap.MakeGen3SkyMapConfig
Definition: makeGen3SkyMap.py:29
lsst.pipe.tasks.makeGen3SkyMap.MakeGen3SkyMapTask
Definition: makeGen3SkyMap.py:54
lsst.pipe.tasks.makeGen3SkyMap.MakeGen3SkyMapConfig.validate
def validate(self)
Definition: makeGen3SkyMap.py:48
lsst.skymap
Definition: __init__.py:1
lsst.pipe.base
Definition: __init__.py:1