Coverage for python / lsst / analysis / tools / contexts / _contexts.py: 100%

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"""This is a module where concrete Contexts should be defined. These should 

24be a subclass of `Context`, and should contain a description of what the 

25context is for as it's docstring. 

26""" 

27__all__ = ( 

28 "VisitContext", 

29 "CoaddContext", 

30 "MatchedRefDiffContext", 

31 "MatchedRefChiContext", 

32 "RefMatchContext", 

33) 

34 

35from ._baseContext import Context 

36 

37 

38class VisitContext(Context): 

39 """A context which indicates `AnalysisAction`s are being run in the context 

40 of visit level data. 

41 """ 

42 

43 pass 

44 

45 

46class CoaddContext(Context): 

47 """A context which indicates `AnalysisAction`s are being run in the context 

48 of coadd level data. 

49 """ 

50 

51 pass 

52 

53 

54class MatchedRefDiffContext(Context): 

55 """A context which indicates `AnalysisAction`s are computing differences 

56 between matches to reference objects. 

57 """ 

58 

59 

60class MatchedRefChiContext(Context): 

61 """A context which indicates `AnalysisAction`s are computing error-scaled 

62 differences between matches to reference objects. 

63 """ 

64 

65 

66class RefMatchContext(Context): 

67 """A context which indicates that `AnalysisActions` are being computed 

68 on HSC data matched to the Gaia or PS reference catalogues. 

69 """