Coverage for python / lsst / meas / photoz / base / estimate_photoz_task_knn.py: 85%

1# This file is part of meas_photoz_base. 

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

21 

22__all__ = [ 

23 "EstimatePhotozKNNAlgoConfig", 

24 "EstimatePhotozKNNAlgoTask", 

25 "EstimatePhotozKNNConfig", 

26 "EstimatePhotozKNNTask", 

27] 

28 

29from rail.estimation.algos.k_nearneigh import KNearNeighEstimator 

30from rail.estimation.estimator import CatEstimator 

31 

32import lsst.pex.config as pexConfig 

33 

34from .estimate_photoz_task import ( 

35 EstimatePhotozAlgoConfigBase, 

36 EstimatePhotozAlgoTask, 

37 EstimatePhotozTask, 

38 EstimatePhotozTaskConfig, 

39 photozAlgoRegistry, 

40) 

41 

42 

43class EstimatePhotozKNNAlgoConfig(EstimatePhotozAlgoConfigBase): 

44 """Config for EstimatePhotozKNNAlgoTask. 

45 

46 This will select and configure the KNearNeighEstimator p(z) 

47 estimation algorithm. 

48 """ 

49 

50 @classmethod 

51 def estimator_class(cls) -> type[CatEstimator]: 

52 return KNearNeighEstimator 

53 

54 @classmethod 

55 def stage_name(cls): 

56 return "knn" 

57 

58 

59EstimatePhotozKNNAlgoConfig._make_fields() 

60 

61 

62@pexConfig.registerConfigurable(EstimatePhotozKNNAlgoConfig.stage_name(), photozAlgoRegistry) 

63class EstimatePhotozKNNAlgoTask(EstimatePhotozAlgoTask): 

64 """Subtask to run RAIL KNN algorithm for p(z) estimation. 

65 

66 See https://github.com/LSSTDESC/rail_sklearn/blob/main/src/rail/estimation/algos/k_nearneigh.py 

67 for algorithm implementation. 

68 """ 

69 

70 ConfigClass = EstimatePhotozKNNAlgoConfig 

71 _DefaultName = "estimatePhotozKNNAlgo" 

72 

73 

74class EstimatePhotozKNNConfig(EstimatePhotozTaskConfig): 

75 """Config for EstimatePhotozKNNTask.""" 

76 

77 def setDefaults(self) -> None: 

78 super().setDefaults() 

79 name = EstimatePhotozKNNAlgoConfig.stage_name() 

80 self.connections.algo = name 

81 self.photoz_algo = name 

82 

83 

84class EstimatePhotozKNNTask(EstimatePhotozTask): 

85 """Task that runs RAIL KNN algorithm for p(z) estimation.""" 

86 

87 ConfigClass = EstimatePhotozKNNConfig 

88 _DefaultName = "estimatePhotozKNN"