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

13 statements  

« prev     ^ index     » next       coverage.py v7.5.0, created at 2024-04-27 04:18 -0700

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 "DrpContext", 

34 "ApContext", 

35) 

36 

37from ._baseContext import Context 

38 

39 

40class VisitContext(Context): 

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

42 of visit level data. 

43 """ 

44 

45 pass 

46 

47 

48class CoaddContext(Context): 

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

50 of coadd level data. 

51 """ 

52 

53 pass 

54 

55 

56class MatchedRefDiffContext(Context): 

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

58 between matches to reference objects. 

59 """ 

60 

61 

62class MatchedRefChiContext(Context): 

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

64 differences between matches to reference objects. 

65 """ 

66 

67 

68class RefMatchContext(Context): 

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

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

71 """ 

72 

73 

74class DrpContext(Context): 

75 """A context which indicates the analysis tool is built for DRP style 

76 data products/catalogs and will use the appropriate column names. 

77 """ 

78 

79 

80class ApContext(Context): 

81 """A context which indicates the analysis tool is built for AP style 

82 data products/catalogs and will use appropriate column names. 

83 """