Coverage for python / lsst / analysis / tools / atools / diffimMetadataMetrics.py: 67%

1# This file is part of analysis_tools. 

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/>. 

21from __future__ import annotations 

22 

23__all__ = ("DiffimMetadataMetricTool",) 

24 

25from deprecated.sphinx import deprecated 

26 

27from lsst.pex.config import DictField 

28 

29from ..actions.scalar import ValueAction 

30from ..interfaces import AnalysisTool 

31 

32 

33@deprecated( 

34 reason=("This tool is superceded by TaskMetadataMetricTool, which should be used instead."), 

35 version="v29.0", 

36 category=FutureWarning, 

37) 

38class DiffimMetadataMetricTool(AnalysisTool): 

39 """This tool is designed to extract values from diffim task metadata""" 

40 

41 metrics = DictField[str, str](doc="The metrics to calculate from the task metadata and their units") 

42 

43 def finalize(self): 

44 for name, unit in self.metrics.items(): 

45 setattr(self.process.calculateActions, name, ValueAction(vectorKey=name)) 

46 self.produce.metric.units = dict(self.metrics.items())