Coverage for python/lsst/pipe/tasks/getRegionTimeFromVisit.py: 82%

20 statements  

« prev     ^ index     » next       coverage.py v7.5.1, created at 2024-05-14 09:29 +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# (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 

22 

23__all__ = ["GetRegionTimeFromVisitTask", "GetRegionTimeFromVisitConfig"] 

24 

25 

26import lsst.pipe.base as pipeBase 

27from lsst.pipe.base.utils import RegionTimeInfo 

28from lsst.utils.timer import timeMethod 

29 

30 

31class GetRegionTimeFromVisitConnections(pipeBase.PipelineTaskConnections, 

32 dimensions={"instrument", "group", "detector"}, 

33 defaultTemplates={"coaddName": "goodSeeing", "fakesType": ""}): 

34 

35 dummy_visit = pipeBase.connectionTypes.Input( 

36 doc="Placeholder connection to provide visit-detector records and " 

37 "constrain data IDs to images we're processing. Use of a catalog " 

38 "dataset lets us also control how late in the pipeline the task " 

39 "is run.", 

40 name="{fakesType}{coaddName}Diff_diaSrcTable", 

41 storageClass="DataFrame", 

42 dimensions={"instrument", "visit", "detector"}, 

43 ) 

44 dummy_exposure = pipeBase.connectionTypes.Output( 

45 doc="Placeholder connection to guarantee visit-exposure-group mapping. " 

46 "This output is never produced and need not be registered.", 

47 name="getRegionTimeFromVisit_dummy", # Unique in case it gets registered anyway. 

48 storageClass="int", 

49 dimensions={"instrument", "exposure"}, 

50 multiple=True, 

51 ) 

52 output = pipeBase.connectionTypes.Output( 

53 doc="The region and time associated with this group's visit.", 

54 name="regionTimeInfo", 

55 storageClass="RegionTimeInfo", 

56 dimensions={"instrument", "group", "detector"}, 

57 ) 

58 

59 

60class GetRegionTimeFromVisitConfig(pipeBase.PipelineTaskConfig, 

61 pipelineConnections=GetRegionTimeFromVisitConnections): 

62 pass 

63 

64 

65class GetRegionTimeFromVisitTask(pipeBase.PipelineTask): 

66 """A converter that reads metadata from visit-dimension records and writes 

67 it to a Butler dataset. 

68 """ 

69 _DefaultName = "getRegionTimeFromVisit" 

70 ConfigClass = GetRegionTimeFromVisitConfig 

71 

72 @timeMethod 

73 def runQuantum(self, butlerQC, inputRefs, outputRefs): 

74 """Convert the passed dataset refs to persistable metadata. 

75 """ 

76 # Input datasetRefs guaranteed to be expanded. 

77 times = inputRefs.dummy_visit.dataId.records["visit"].timespan 

78 region = inputRefs.dummy_visit.dataId.records["visit_detector_region"].region 

79 outputs = pipeBase.Struct( 

80 output=RegionTimeInfo(region=region, timespan=times), 

81 dummy_exposure=None, 

82 ) 

83 butlerQC.put(outputs, outputRefs) 

84 

85 # All work is done in runQuantum 

86 run = None