Coverage for python/lsst/cp/pipe/_lookupStaticCalibration.py: 27%

9 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-01-14 10:59 +0000

1# This file is part of cp_pipe. 

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 <http://www.gnu.org/licenses/>. 

21 

22from lsst.obs.base import Instrument 

23 

24__all__ = ["lookupStaticCalibration"] 

25 

26 

27def lookupStaticCalibration(datasetType, registry, quantumDataId, collections): 

28 """A lookup function override for QuantumGraph generation that allows a 

29 PipelineTask to have an input dataset (usually a camera) that is formally a 

30 calibration with a validity range, without having a temporal data ID for 

31 the lookup, by asserting that there is in fact only dataset for all time. 

32 

33 Parameters 

34 ---------- 

35 datasetType : `lsst.daf.butler.DatasetType` 

36 Dataset type to look up. 

37 registry : `lsst.daf.butler.Registry` 

38 Registry for the data repository being searched. 

39 quantumDataId : `lsst.daf.butler.DataCoordinate` 

40 Data ID for the quantum of the task this dataset will be passed to. 

41 This must include an "instrument" key, and should also include any 

42 keys that are present in ``datasetType.dimensions``. If it has an 

43 ``exposure`` or ``visit`` key, that's a sign that this function is 

44 not actually needed, as those come with the temporal information that 

45 would allow a real validity-range lookup. 

46 collections : `lsst.daf.butler.registry.CollectionSearch` 

47 Collections passed by the user when generating a QuantumGraph. Ignored 

48 by this function (see notes below). 

49 

50 Returns 

51 ------- 

52 refs : `list` [ `DatasetRef` ] 

53 A zero- or single-element list containing the matching dataset, if one 

54 was found. 

55 

56 Notes 

57 ----- 

58 This works by looking in the `~CollectionType.RUN` collection 

59 that `lsst.obs.base.Instrument.writeCuratedCalibrations` (currently!) uses, 

60 instead of the collections passed into it. This may be considered 

61 surprising by users (but will usually go unnoticed because the dataset 

62 returned _is_ actually in those given input colllections, too). It may 

63 stop working entirely once we have data repositories with multiple 

64 calibration collections; a better workaround or a more principled change 

65 to the PipelineTasks that use this function (which are by definition asking 

66 for something ill-defined) will ultimately be needed. 

67 """ 

68 instrument = Instrument.fromName(quantumDataId["instrument"], registry) 

69 unboundedCollection = instrument.makeUnboundedCalibrationRunName() 

70 ref = registry.findDataset(datasetType, dataId=quantumDataId, collections=[unboundedCollection]) 

71 if ref is None: 

72 return [] 

73 else: 

74 return [ref]