Coverage for src / lstautorta / observation_data.py: 19%

50 statements  

« prev     ^ index     » next       coverage.py v7.13.5, created at 2026-08-10 11:56 +0000

1from typing import Annotated, NamedTuple 

2 

3import pymongo 

4import pymongo.errors 

5from annotated_types import Ge, Gt, Le, Lt 

6 

7 

8class ObsInfo(NamedTuple): 

9 obs_id: Annotated[int, Gt(0)] | None 

10 time_start_camera: Annotated[float, Gt(0)] | None 

11 RA: Annotated[float, Ge(0.0), Le(360.0)] | None 

12 DEC: Annotated[float, Ge(-90.0), Le(90.0)] | None 

13 source_RA: Annotated[float, Ge(0.0), Le(360.0)] | None 

14 source_DEC: Annotated[float, Ge(-90.0), Le(90.0)] | None 

15 

16 

17def get_current_run_info( 

18 db_hostname: str, 

19 obs_target_query_timeout_s: Annotated[int, Gt(0), Lt(60)], 

20) -> ObsInfo: 

21 """Queries the LST database for the current observation and observation parameters 

22 

23 Parameters 

24 ---------- 

25 db_hostname : str 

26 Hostname of the DB server. Example lst101 

27 obs_target_query_timeout_s : Annotated[int, Gt(0), Lt(60)] 

28 Maximal amount of time passed to query DB for observation parameters 

29 

30 Raises 

31 ------ 

32 pymongo.errors.ExecutionTimeout 

33 When the database query exceeds the timeout. 

34 pymongo.errors.PyMongoError 

35 When the database query returned inconsistent results between data.camera and data.structure fields 

36 

37 Returns 

38 ------- 

39 ObsInfo 

40 Current observation information 

41 """ 

42 # The "lst1_obs_summary", DB is filled by LST sub-systems with the information they have/use, when they "want" 

43 # The observation information can be retrieved from the "telescope" collection which is updated with 

44 # camera and structure data, after a run a started (so we get a delay until the information is available) 

45 # For the record, the "camera" collection is updated at the end of a run. 

46 

47 # There can be an issue with the values retrieved from the DB concerning the run_number: the run number 

48 # is decided by the EVB, and communicating it to the TCU that writes the DB can take longer than the TCU 

49 # is willing to wait. When this happens, the TCU writes the previous run_number, so there can be duplicated 

50 # run_number in the DB, and the run_number can be wrong. 

51 # In addition, the pointing information is not written in the same array than the run_number, therefore we 

52 # must query for 2 different pieces of the documents. 

53 # Also, the DB documents contain information for muliple runs (for a complete set of wobbles). 

54 # To circumvent these issues, we do the following: 

55 # - query the DB and sort (descending) on the tstart field of both data.structure and data.camera 

56 # - limit the query to 1 element, because otherwise the sort takes to much memory. 

57 # Doing so allows the sort to only keep in memory the max value 

58 # https://www.mongodb.com/docs/manual/reference/operator/aggregation/sort/#-sort-operator-and-memory 

59 # - sort the retrieved documents by tstart (sorting the info of each wobble run) 

60 # - assert the two documents are coherent (simply check length). We can't compare tstart because the 

61 # tstart of camera is the time at which the camera start, while tstart of structure is the time at which 

62 # the drive started tracking, they can be different. 

63 # - assign the observation information with the most recent values. 

64 # - iterate on the previous runs information and check that the run_number is different 

65 # (in inner for loop: iterate on wobbles, in outer while loop: iterate over previous wobble sets) 

66 # If the run_number is different, or obs_id is not duplicated, we can quit. Otherwise, we increment the 

67 # value by which we need to shift the obs_id. 

68 # - If a document is inserted in the DB while we are iterating, we will get the same "_id" again, so we can 

69 # simply ignore it. 

70 

71 obs_id = None 

72 tstart_camera = None 

73 ra = None 

74 dec = None 

75 source_ra = None 

76 source_dec = None 

77 

78 with pymongo.MongoClient(db_hostname) as client: 

79 collection = client.get_database("lst1_obs_summary").get_collection("telescope") 

80 camera_data_index = [("data.camera.tstart", pymongo.DESCENDING)] 

81 

82 keep_querying = True 

83 query_idx = 0 

84 visited_ids = set() 

85 nb_duplicated_run_numbers = 0 

86 obs_info = ObsInfo(None, None, None, None, None, None) 

87 while keep_querying: 

88 with collection.find( 

89 { 

90 "data.camera.run_number": {"$exists": True}, 

91 "data.camera.tstart": {"$exists": True}, 

92 "data.structure.tstart": {"$exists": True}, 

93 "data.structure.target.ra": {"$exists": True}, 

94 "data.structure.target.dec": {"$exists": True}, 

95 "data.structure.target.source_ra": {"$exists": True}, 

96 "data.structure.target.source_dec": {"$exists": True}, 

97 }, 

98 { 

99 "_id": True, 

100 "data.camera.run_number": True, 

101 "data.camera.tstart": True, 

102 "data.structure.tstart": True, 

103 "data.structure.target.ra": True, 

104 "data.structure.target.dec": True, 

105 "data.structure.target.source_ra": True, 

106 "data.structure.target.source_dec": True, 

107 }, 

108 sort=camera_data_index, 

109 max_time_ms=obs_target_query_timeout_s * 1000, 

110 skip=query_idx, 

111 limit=1, 

112 ) as cursor: 

113 query_data = cursor.next() 

114 if query_data["_id"] not in visited_ids: 

115 visited_ids.add(query_data["_id"]) 

116 

117 structure_list = sorted(query_data["data"]["structure"], key=lambda x: x["tstart"], reverse=True) 

118 camera_list = sorted(query_data["data"]["camera"], key=lambda x: x["tstart"], reverse=True) 

119 

120 # if the DB is incoherent for the latest run: raise error. 

121 # Otherwise do not, and pray the incoherence is not caused by camera field... 

122 if (len(structure_list) != len(camera_list)) and (query_idx == 0): 

123 # Raise pymongo error because 

124 raise pymongo.errors.PyMongoError( 

125 f"TCU DB query returned inconsistent data.structure (length {len(structure_list)}) " 

126 f"and data.camera (length {len(camera_list)})" 

127 ) 

128 

129 if query_idx == 0: 

130 obs_id = camera_list[0]["run_number"] 

131 tstart_camera = camera_list[0]["tstart"] 

132 ra = structure_list[0]["target"]["ra"] 

133 dec = structure_list[0]["target"]["dec"] 

134 source_ra = structure_list[0]["target"]["source_ra"] 

135 source_dec = structure_list[0]["target"]["source_dec"] 

136 

137 comparison_start_idx = 1 if query_idx == 0 else 0 

138 for field in camera_list[comparison_start_idx:]: 

139 if field["run_number"] != obs_info.obs_id: 

140 keep_querying = False 

141 break 

142 nb_duplicated_run_numbers += 1 

143 

144 query_idx += 1 

145 

146 return ObsInfo(obs_id + nb_duplicated_run_numbers, tstart_camera, ra, dec, source_ra, source_dec)