diff --git a/sohstationviewer/view/util/functions.py b/sohstationviewer/view/util/functions.py index 75d54dc727ca4d0353974abc77082256d85616cf..4e56d329a7792e5389a3d4af0712f0d0d83879eb 100644 --- a/sohstationviewer/view/util/functions.py +++ b/sohstationviewer/view/util/functions.py @@ -223,6 +223,16 @@ def check_masspos(mp_data: Dict[str, Dict], req_mp = [] if include_mp123: + """ + If the MassPos 123/ZNE/ABC checkbox is checked, the included_mp list + will be compared against 3 predefined lists: 123, ZNE, ABC. + If any channel in included_mp matches a channel from one of these + lists, the entire list (123, ZNE, or ABC) will be used for checking + missing channels. + If no channel in included_mp matches any of the channels from these + lists, only the 123 list will be included in the warning message + regarding missing channels. + """ req_mp123 = [] # represent 123/zne/abc mp123 = ['1', '2', '3'] mpzne = ['Z', 'N', 'E'] @@ -240,6 +250,16 @@ def check_masspos(mp_data: Dict[str, Dict], req_mp += req_mp123 if include_mp456: + """ + If the MassPos 456/UVW checkbox is checked, the included_mp list + will be compared against 2 predefined lists: 456, UVW. + If any channel in included_mp matches a channel from one of these + lists, the entire list (123, ZNE, or ABC) will be used for checking + missing channels. + If no channel in included_mp matches any of the channels from these + lists, only the 456 list will be included in the warning message + regarding missing channels. + """ req_mp456 = [] # represent 456/uvw mp456 = ['4', '5', '6'] mpuvw = ['U', 'V', 'W']