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__all__ = ( 

24 "VisitContext", 

25 "CoaddContext", 

26 "MatchedRefDiffContext", 

27 "MatchedRefChiContext", 

28 "RefMatchContext", 

29) 

30 

31from ._baseContext import Context 

32 

33"""This is a module where concrete Contexts should be defined. These should 

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

35context is for as it's docstring. 

36""" 

37 

38 

39class VisitContext(Context): 

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

41 of visit level data. 

42 """ 

43 

44 pass 

45 

46 

47class CoaddContext(Context): 

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

49 of coadd level data. 

50 """ 

51 

52 pass 

53 

54 

55class MatchedRefDiffContext(Context): 

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

57 between matches to reference objects. 

58 """ 

59 

60 

61class MatchedRefChiContext(Context): 

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

63 differences between matches to reference objects. 

64 """ 

65 

66 

67class RefMatchContext(Context): 

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

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

70 """