LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
_instrument.py
Go to the documentation of this file.
1 # This file is part of obs_decam.
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 """Butler instrument description for the Dark Energy Camera.
23 """
24 
25 __all__ = ("DarkEnergyCamera",)
26 
27 import os
28 from functools import lru_cache
29 
30 from lsst.afw.cameraGeom import makeCameraFromPath, CameraConfig
31 from lsst.obs.base import Instrument
32 from lsst.obs.base.gen2to3 import BandToPhysicalFilterKeyHandler, TranslatorFactory
33 from lsst.obs.decam.decamFilters import DECAM_FILTER_DEFINITIONS
34 
35 from lsst.daf.butler.core.utils import getFullTypeName
36 from lsst.utils import getPackageDir
37 
38 
39 class DarkEnergyCamera(Instrument):
40  filterDefinitions = DECAM_FILTER_DEFINITIONS
41  policyName = "decam"
42  obsDataPackage = "obs_decam_data"
43 
44  def __init__(self, **kwargs):
45  super().__init__(**kwargs)
46  packageDir = getPackageDir("obs_decam")
47  self.configPathsconfigPaths = [os.path.join(packageDir, "config")]
48 
49  @classmethod
50  def getName(cls):
51  return "DECam"
52 
53  def getCamera(self):
54  path = os.path.join(getPackageDir("obs_decam"), self.policyNamepolicyName, "camGeom")
55  return self._getCameraFromPath_getCameraFromPath(path)
56 
57  @staticmethod
58  @lru_cache()
59  def _getCameraFromPath(path):
60  """Return the camera geometry given solely the path to the location
61  of that definition."""
62  config = CameraConfig()
63  config.load(os.path.join(path, "camera.py"))
64  return makeCameraFromPath(
65  cameraConfig=config,
66  ampInfoPath=path,
67  shortNameFunc=lambda name: name.replace(" ", "_"),
68  )
69 
70  def register(self, registry, update=False):
71  camera = self.getCameragetCamera()
72  # Combined with detector_max=100 (below), obsMax=2**25 causes the
73  # number of bits in packed IDs to match the Gen2 ones.
74  obsMax = 2**25
75  with registry.transaction():
76  # Note that detector_max here is really only used for packing
77  # detector and visit/exposure IDs together into a single integer,
78  # so it's rounded up to the nearest power of ten to make that
79  # encoding decodable by humans (and consistent with its previous
80  # Gen2 definition). There are other checks (database constraints)
81  # that ensure any ingested raws have "real" detector values, and
82  # those are based on the detector records added in the loop below.
83  registry.syncDimensionData(
84  "instrument",
85  {
86  "name": self.getNamegetName(), "detector_max": 100, "visit_max": obsMax, "exposure_max": obsMax,
87  "class_name": getFullTypeName(self),
88  },
89  update=update
90  )
91 
92  for detector in camera:
93  registry.syncDimensionData(
94  "detector",
95  {
96  "instrument": self.getNamegetName(),
97  "id": detector.getId(),
98  "full_name": detector.getName(),
99  "name_in_raft": detector.getName()[1:],
100  "raft": detector.getName()[0],
101  "purpose": str(detector.getType()).split(".")[-1],
102  },
103  update=update
104  )
105 
106  self._registerFilters(registry, update=update)
107 
108  def getRawFormatter(self, dataId):
109  # local import to prevent circular dependency
110  from .rawFormatter import DarkEnergyCameraRawFormatter
111  return DarkEnergyCameraRawFormatter
112 
113  def makeDataIdTranslatorFactory(self) -> TranslatorFactory:
114  # Docstring inherited from lsst.obs.base.Instrument.
115  factory = TranslatorFactory()
116  factory.addGenericInstrumentRules(self.getNamegetName(), calibFilterType="band",
117  detectorKey="ccdnum")
118  # DECam calibRegistry entries are bands or aliases, but we need
119  # physical_filter in the gen3 registry.
120  factory.addRule(_DecamBandToPhysicalFilterKeyHandler(self.filterDefinitionsfilterDefinitions),
121  instrument=self.getNamegetName(),
122  gen2keys=("filter",),
123  consume=("filter",),
124  datasetTypeName="cpFlat")
125  return factory
126 
127 
128 class _DecamBandToPhysicalFilterKeyHandler(BandToPhysicalFilterKeyHandler):
129  """A specialization of `~lsst.obs.base.gen2to3.BandToPhysicalKeyHandler`
130  that allows filter aliases to be used as alternative band names.
131 
132  Parameters
133  ----------
134  filterDefinitions : `lsst.obs.base.FilterDefinitionCollection`
135  The filters to translate from Gen 2 to Gen 3.
136  """
137 
138  __slots__ = ("_aliasMap",)
139 
140  def __init__(self, filterDefinitions):
141  super().__init__(filterDefinitions)
142  self._aliasMap_aliasMap = {alias: d.physical_filter for d in filterDefinitions for alias in d.alias}
143 
144  def extract(self, gen2id, *args, **kwargs):
145  # Expect _aliasMap to be small, so try it first
146  gen2Filter = gen2id["filter"]
147  if gen2Filter in self._aliasMap_aliasMap:
148  return self._aliasMap_aliasMap[gen2Filter]
149  else:
150  return super().extract(gen2id, *args, **kwargs)
def register(self, registry, update=False)
Definition: _instrument.py:70
TranslatorFactory makeDataIdTranslatorFactory(self)
Definition: _instrument.py:113
def makeCameraFromPath(cameraConfig, ampInfoPath, shortNameFunc, pupilFactoryClass=PupilFactory)
std::string getPackageDir(std::string const &packageName)
return the root directory of a setup package
Definition: packaging.cc:33