Coverage for tests/test_contexts.py: 48%
100 statements
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-01 11:53 +0000
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-01 11:53 +0000
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 <http://www.gnu.org/licenses/>.
21from __future__ import annotations
23import warnings
24from typing import cast
25from unittest import TestCase, main
27import astropy.units as apu
28import lsst.utils.tests
29import numpy as np
30from lsst.analysis.tools.actions.scalar import MeanAction, MedianAction
31from lsst.analysis.tools.contexts import Context
32from lsst.analysis.tools.interfaces import (
33 AnalysisAction,
34 AnalysisTool,
35 KeyedData,
36 KeyedDataAction,
37 KeyedDataSchema,
38 KeyedResults,
39 Scalar,
40 ScalarAction,
41 Vector,
42)
43from lsst.pex.config import Field
44from lsst.pex.config.configurableActions import ConfigurableActionField, ConfigurableActionStructField
45from lsst.verify import Measurement
48class MedianContext(Context):
49 """Test Context for median"""
51 pass
54class MeanContext(Context):
55 """Test Context for mean"""
57 pass
60class MultiplyContext(Context):
61 """Test Context to multiply results"""
63 pass
66class DivideContext(Context):
67 """Test Context to divide result"""
69 pass
72class TestAction1(KeyedDataAction):
73 multiple = ConfigurableActionStructField[ScalarAction](doc="Multiple Actions")
75 def getInputSchema(self) -> KeyedDataSchema:
76 return (("a", Vector),)
78 def medianContext(self) -> None:
79 self.multiple.a = MedianAction(vectorKey="a")
80 self.multiple.b = MedianAction(vectorKey="a")
81 self.multiple.c = MedianAction(vectorKey="a")
83 def meanContext(self) -> None:
84 self.multiple.a = MeanAction(vectorKey="a")
85 self.multiple.b = MeanAction(vectorKey="a")
87 def __call__(self, data: KeyedData, **kwargs) -> KeyedData:
88 result = np.array([action(data, **kwargs) for action in self.multiple])
89 return cast(KeyedData, {"b": result})
92class TestAction2(KeyedDataAction):
93 single = ConfigurableActionField[ScalarAction](doc="Single Action")
94 multiplier = ConfigurableActionField[AnalysisAction](doc="Multiplier")
96 def getInputSchema(self) -> KeyedDataSchema:
97 return (("b", Vector),)
99 def setDefaults(self) -> None:
100 super().setDefaults()
101 # This action remains constant in every context, but it will be
102 # recursively configured with any contexts
103 self.multiplier = TestAction3()
105 def medianContext(self) -> None:
106 self.single = MedianAction(vectorKey="b")
108 def meanContext(self) -> None:
109 self.single = MeanAction(vectorKey="b")
111 def __call__(self, data: KeyedData, **kwargs) -> KeyedData:
112 result = self.single(data, **kwargs)
113 intermediate = self.multiplier(cast(KeyedData, {"c": result}), **kwargs)["d"]
114 intermediate = cast(Measurement, intermediate)
115 assert intermediate.quantity is not None
116 result *= cast(Scalar, intermediate.quantity.value)
117 return {"c": result}
120class TestAction3(KeyedDataAction):
121 multiplier = Field[float](doc="Number to multiply result by")
123 def getInputSchema(self) -> KeyedDataSchema:
124 return (("c", Vector),)
126 def multiplyContext(self):
127 self.multiplier = 2
129 def divideContext(self):
130 self.multiplier = 0.5
132 def __call__(self, data: KeyedData, **kwargs) -> KeyedResults:
133 result = Measurement("TestMeasurement", cast(Scalar, data["c"]) * self.multiplier * apu.Unit("count"))
134 return {"d": result}
137class TestAnalysisTool(AnalysisTool):
138 def setDefaults(self) -> None:
139 self.prep = TestAction1()
140 self.process = TestAction2()
141 self.produce = TestAction3()
144class ContextTestCase(TestCase):
145 def setUp(self) -> None:
146 super().setUp()
147 self.array = np.arange(20)
148 self.input = cast(KeyedData, {"a": self.array})
150 def testContext1(self):
151 tester = TestAnalysisTool()
152 # test applying contexts serially
153 tester.applyContext(MultiplyContext())
155 # verify assignment syntax works to support Yaml
156 # normally this should be called as a function in python
157 tester.applyContext = MedianContext
158 with warnings.catch_warnings():
159 warnings.simplefilter("ignore")
160 result = cast(Measurement, tester(self.input)["d"])
161 assert result.quantity is not None
162 self.assertEqual(result.quantity.value, 361)
164 def testContext2(self):
165 tester2 = TestAnalysisTool()
166 compound = MeanContext | DivideContext
167 tester2.applyContext(compound)
168 with warnings.catch_warnings():
169 warnings.simplefilter("ignore")
170 result = cast(Measurement, tester2(self.input)["d"])
171 assert result.quantity is not None
172 self.assertEqual(result.quantity.value, 22.5625)
175class MyMemoryTestCase(lsst.utils.tests.MemoryTestCase):
176 pass
179def setup_module(module):
180 lsst.utils.tests.init()
183if __name__ == "__main__": 183 ↛ 184line 183 didn't jump to line 184, because the condition on line 183 was never true
184 lsst.utils.tests.init()
185 main()