Skip to content

Survey

gravtools.models.survey

Classes for modelling relative gravity surveys.

Copyright (C) 2021 Andreas Hellerschmied andreas.hellerschmied@bev.gv.at

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Survey

Gravity survey (instrument-independent).

A gravity survey object contains all data that belongs to a single field observation job, carried out under the same circumstances (same instrument, measurement area, drift- and datum-point planing, same observer, etc.). A survey is usually observed on the same day, under similar conditions by the same operator.

All analytical observation-level reductions and corrections are applied here. The reduced g values are stored in the columns g_red_mugal and the according standard deviation in sd_g_red_mugal in obs_df. The following corrections/reductions are supported:

  • Tidal corrections of observations

  • Corrections of the CG-5 instruments provided in the observation files (Longman, 1959)

  • No corrections
  • Longman (1959) model, evaluated in GravTools for the longitude, latitude , altitude and UTC time stamp of each observation. The correction is calculated for the middle of the reading time (obs_epoch + duration_sec/2)

  • Interpolated from correction time series (e.g. loaded from Tsoft TSF files)

  • Reduction of the observed gravity to different reference height levels

  • Control point level

  • Ground level
  • Level of the gravimeter top
  • Sensor level
Notes

Basically it is possible to initialize an empty survey, by just defining the survey's name on the instantiation step. In this case all other (class and instance) attributes are initialized with the default values listed below in the Attributes section.

The observation reference time in GravTools is equal to the start time of an instrument reading - in accordance with the CG-5 observation files. This has to be taken into account when calculating time dependent corrections, such as tidal corrections.

Attributes:

Name Type Description
name str

Name of the survey
date

Date of te survey.
operator (str, optional(default=''))

Name of the responsible operator that carried out the observations of this survey.
gravimeter_serial_number (str, optional(default=''))

Gravimeter serial number as stated in the observation file.
gravimeter_type (str, optional(default=''))

Valid gravimeter types have to be listed in :py:obj:gravtools.settings.GRAVIMETER_TYPES.
data_file_name (str, optional(default=''))

Name of the data source file (observation file). Without file path!
data_file_type (str, optional(default=''))

Type of the data source file. Since gravtools allows to load data from different sources, it is important to track the data source type.
obs_tide_correction_type str, (default='')

Type of the tidal corrections applied on the observations (gravimeter readings as obtained from the data source; column g_obs_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.TIDE_CORRECTION_TYPES.
obs_reference_height_type str, (default='')

Reference level type of the observations (gravimeter readings as obtained from the data source; column g_obs_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.REFERENCE_HEIGHT_TYPE.
obs_atm_pres_correction_type str, (default='')

Type of atmospheric pressure correction applied on the observations (gravimeter readings as obtained from the data source; column g_obs_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.ATM_PRES_CORRECTION_TYPES.
obs_scale_correction_type str, (default='')

Type of scale correction applied on the observations (gravimeter readings as obtained from the data source; column g_obs_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.SCALE_CORRECTION_TYPES.
obs_oceanload_correction_type str, (default='')

Type of ocean-loading correction applied on the observations (gravimeter readings as obtained from the data source; column g_obs_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.OCEANLOAD_CORRECTION_TYPES. Empty string, if corrected observations are not available.
red_tide_correction_type (str, optional(default=''))

Type of the tidal corrections applied on the reduced observations (column g_red_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.TIDE_CORRECTION_TYPES. Empty string, if corrected observations are not available.
red_reference_height_type (str, optional(default=''))

Reference level type of the reduced observations (column g_red_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.REFERENCE_HEIGHT_TYPE. Empty string, if corrected observations are not available.
red_atm_pres_correction_type str, (default='')

Type of atmospheric pressure correction applied on the reduced observations (column g_red_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.ATM_PRES_CORRECTION_TYPES. Empty string, if corrected observations are not available.
red_scale_correction_type str, (default='')

Type of scale correction applied on the reduced observations (column g_red_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.SCALE_CORRECTION_TYPES. Empty string, if corrected observations are not available.
red_oceanload_correction_type str, (default='')

Type of ocean-loading correction applied on the reduced observations (column g_red_mugal in obs_df). Valid entries have to be listed in :py:obj:gravtools.settings.OCEANLOAD_CORRECTION_TYPES. Empty string, if corrected observations are not available.
red_tide_correction_description (str, optional(default=''))

Optional description of the tide correction e.g. obtained from time series data. The reduced observations are stored in the column g_red_mugal and the corrections in column corr_tide_red_mugal in obs_df.
red_tide_corr_timeseries_interpol_method (str, optional(default=''))

Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are obtained from other sources or models, this attribute is irrelevant and has to be empty!
red_tide_corr_timeseries_creation_dt `datetime`, optional (default=`None`)

If tidal corrections are obtained from time series data, the time when the data was created, i.e. loaded into GravTools, is stored here as datetime object. This is required to uniquely identify the applies tidal corrections from time series data.
setup_tide_correction_type (str, optional(default=''))

Type of the tidal corrections applied on the observations that are used to calculate the setup data in the setup_df dataframe. Valid entries have to be listed in :py:obj:gravtools.settings.TIDE_CORRECTION_TYPES. Empty string, if corrected setup data has not been calculated so far (setup_df = None).
setup_reference_height_type (str, optional(default=''))

Reference height reduction type applied on the observations that are used to calculate the setup data in the setup_df dataframe. Valid entries have to be listed in :py:obj:gravtools.settings.TIDE_CORRECTION_TYPES. Empty string, if corrected setup data has not been calculated so far (setup_df = None).
setup_atm_pres_correction_type str, (default='')

Type of atmospheric pressure correction applied on the observations that are used to calculate the setup data in thesetup_df dataframe. Valid entries have to be listed in :py:obj:gravtools.settings.ATM_PRES_CORRECTION_TYPES.Empty string, if corrected setup data has not been calculated so far (setup_df = None).
setup_scale_correction_type str, (default='')

Type of scale correction applied on the observations that are used to calculate the setup data in thesetup_df dataframe. Valid entries have to be listed in :py:obj:gravtools.settings.SCALE_CORRECTION_TYPES.Empty string, if corrected setup data has not been calculated so far (setup_df = None).
setup_oceanload_correction_type str, (default='')

Type of oceanload correction applied on the observations that are used to calculate the setup data in thesetup_df dataframe. Valid entries have to be listed in :py:obj:gravtools.settings.OCEANLOAD_CORRECTION_TYPES.Empty string, if corrected setup data has not been calculated so far (setup_df = None).
setup_calc_method (str, optional(default=''))

Method for the calculation of setup data. variance_weighted_mean implies that setup observations (observed gravity, standard deviations and reference time) are calculated by variance weighted mean of the individual observations. individual_obs implies that the original observations are used as setup data without any aggregation.
setup_sd_method (str, optional(default=''))

Method for the determination of standard deviations (SD) of setup observations. sd_from_obs_file implies that SD are taken from the observation file. sd_default_per_obs and sd_default_per_setup imply that the given default SD is used, where the default SD is applied the individual observations in the first case and to setups in the second case. If applied to observations, the number of observations per setup still plays a role for weighting the setup observations in the adjustment.
keep_survey bool(default=True)

Flag that indicates whether this survey will be used to derive setup observations.True is the default and implies that this survey is considered. This flag is independent of the keep_obs flags in the obs_df dataframe (used to flag individual observations).
obs_df :py:obj:`pandas.core.frame.DataFrame`, optional (default=None)

Contains all observation data that belongs to this survey. One observation per line. If None, no observations have been assigned to the survey. All Columns are listed in :py:obj:.Survey._OBS_DF_COLUMNS:

  • station_name : str Name of observed station
  • setup_id : int Each setup (one or more observations at a station without moving the instrument) gets a unique ID in order to distinguish between independent groups of observations at a station. The setup_id is created based on the reference time of the first observation of a setup and the survey name.
  • loop_id: int, optional (default=None) Unique ID of a line. A survey can be split up into multiple lines. A line needs to have at least one station that was observed at least twice for drift control (preferably at the beginning and end of the line). If None, loops were not defined. The purpose of splitting surveys into loops is to carry out drift correction for individual loops (shorter time period) rather than fo the complete survey.
  • lon_deg : float, optional (default=None) Geographical longitude of the station [°]. When loading observation data from the CG-5 observation files, geographical coordinates are obtained from measurements of the built-in GPS device of the instrument.
  • lat_deg : float, optional (default=None) Geographical latitude of the station [°]. When loading observation data from the CG-5 observation files, geographical coordinates are obtained from measurements of the built-in GPS device of teh instrument.
  • alt_m : float, optional (default=None) Altitude of the station [m]. When loading observation data from the CG-5 observation files, altitudes are obtained from measurements of the built-in GPS device of teh instrument.
  • obs_epoch : :py:obj:datetime.datetime; timezone aware, if possible Reference epoch of the observation. Per default the start epoch (!) of an observation. Be aware that for the determination of tidal corrections by the CG-5 built-in model (Longman, 1959) the middle of the observation with the duration dur_sec [sec] is used (obs_epoch + duration_sec/2)!
  • g_obs_mugal : float Observed gravity value (instrument reading) [µGal], as obtained from the data source (observation files). Be aware that, depending on the instrument settings and the observation data source, different corrections and/or reductions may have been applied already! The reference height type and the applied tidal correction have to be concise with the statements in :py:obj:.Survey.obs_reference_height_type and :py:obj:.Survey.obs_tide_correction_type, respectively.
  • sd_g_obs_mugal : float, optional (default=None) Standard deviation of g_obs_mugal. If None, the standard deviation is not available.
  • g_red_mugal : float, optional (default=None) Reduced gravity observation. This value is derived from the observed gravimeter reading (g_obs_mugal) by applying reductions and corrections, e.g. from analytical models for tidal effects, by a reduction to a different height level (using the vertical gravity gradient), or reduction due to atmospheric pressure variations. Take care, that the same reductions and corrections are not applied more than once! The reference height type, the applied tidal correction and the applied atmospheric pressure corrections have to be concise with the statements in :py:obj:.Survey.red_reference_height_type, :py:obj:.Survey.red_tide_correction_type and :py:obj:.Survey.red_atm_pres_correction_type, respectively. If None, no reductions and/or corrections have been applied so far.
  • sd_g_red_mugal : float, optional (default=None) Standard deviation of the reduced gravity reading (g_red_mugal). This value is derived from the standard deviation of the gravity reading (sd_g_obs_mugal) by applying proper error propagation. If None, the SD of the gravity reading is not available, or no reductions/corrections have been applied so far, or an error propagation model is still missing. In general, this value should not be None, if g_red_mugal is not None.
  • corr_terrain : float, optional (default=None) Terrain correction [??] as determined by the built-in model of the Scintrex CG-5. If None, this correction is not available in the observation data.
  • corr_tide_mugal : float, optional (default=None) Tidal correction [µGal] as determined by the built-in model of the instrument. Be aware that the tidal corrections by the CG-5 model is determined fot the middle of the observation (also see obs_epoch). If None, this correction is not available in the observation data.
  • temp : float, optional (default=None) Temperature [mK] as determined by the Scintrex CG-5. Be aware that this is not the ambient temperature! This temperature is obtained from the GC-5 observation file and indicates internal temperature variations that are measured and used for the instrumental temperature compensation. If None, this information is not available in the observation data.
  • tiltx : float, optional (default=None) Tilt in x-direction [arcsec] of the gravimeter logged during the observation. If None, this information is not available in the observation data.
  • tilty : float, optional (default=None) Tilt in y-direction [arcsec] of the gravimeter logged during the observation. If None, this information is not available in the observation data.
  • dhf_m : float Vertical distance between instrument top and physical reference point [m]. This information is required for reducing the observed gravity to the reference point level (vertical gravity gradient also required).
  • dhb_m : float Vertical distance between instrument top and the ground [m]. This information is required for reducing the observed gravity to the ground level (vertical gravity gradient also required).
  • keep_obs : bool (default=True) Flag, that indicates whether this observation should be considered in the data analysis (adjustment). If True, the observations takes part in the analysis.
  • vg_mugalm : float, optional (default=numpy.nan) Vertical gravity gradient at the station [µGal/m], obtained from an external source (e.g. station info file). The vertical gradient is required for reducing the observed gravity to different reference heights.
  • corr_tide_red_mugal : float, optional (default=numpy.nan) Tidal correction [µGal] that is applied to g_red_mugal.
  • duration_sec : int Duration of each observation from the CG-5 observation files. Given in seconds.
  • atm_pres_hpa : float, optional (default=None) Measured atmospheric pressure in hPa. Used for correcting atmospheric pressure variations.
  • norm_atm_pres_hpa : float, optional (default=None) Normal atmospheric pressure in hPa. Used for correcting atmospheric pressure variations.
  • corr_atm_pres_red_mugal : float, optional (default=None) Atmospheric pressure correction [µGal] that is applied to g_red_mugal.
  • linear_scale : float, optional (default=None) Linear scale factor applied on the gravity readings in GravTools.
  • corr_oceanload_instrument_mugal : float, optional (default=NaN) Ocean-loading correction [µGal] as determined by the built-in model of the instrument. NaN implies that, this correction is not available in the observation data, i.e. no corrections were loaded from the observation files.
  • corr_oceanload_red_mugal : float, optional (default=NaN) Ocean-Loading correction [µGal] that is applied to g_red_mugal.
ref_delta_t_dt (datetime, optional(default=None))

Reference time for relative times (), e.g. reference time t0 the for drift polynomial adjustment.
setup_df :py:obj:`pandas.core.frame.DataFrame`, optional (default=None)

Contains a single pseudo observation per setup calculated as variance weighted mean of all active (flag keep_obs = True) reduced observations of a setup and other information that is required for the subsequent parameter adjustment. If None, setup data ha not been determined yet. All Columns are listed in :py:obj:.Survey._SETUP_DF_COLUMNS:

  • station_name : str Name of the station that is observed in the setup.
  • setup_id : int Same as in obs_df.
  • g_mugal : float Variance weighted mean of all active reduced observations the setup [µGal].
  • sd_g_mugal : float Standard deviation of g_mugal [µGal]
  • epoch_unix : float Reference epoch of g_mugal in unix time [sec]
  • epoch_dt : :py:obj:datetime.datetime; timezone aware, if possible Reference epoch of g_mugal.
  • delta_t_h : float Time span since reference time :py:obj:Survey.ref_delta_t_dt in hours.
  • sd_setup_mugal : float Standard deviation of active observations in this setup [µGal].
  • number_obs : int Number of observations in a setup.
setup_obs_list_df :py:obj:`pandas.core.frame.DataFrame`, optional (default=None)

List of observations in the obs_df dataframe that were used to calculate the setup observations in the setup_df dataframe.

  • station_name : str Name of the station.
  • obs_epoch : :py:obj:datetime.datetime Reference epoch of the observation (timezone aware, if possible).
  • keep_obs : bool (default=True) False implies that the observation is not used for calculating setup observations.
Source code in gravtools/models/survey.py 
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
class Survey:
    """Gravity survey (instrument-independent).

    A gravity survey object contains all data that belongs to a single field observation job, carried out under the
    same circumstances (same instrument, measurement area, drift- and datum-point planing, same observer, etc.). A
    survey is usually observed on the same day, under similar conditions by the same operator.

    All analytical observation-level reductions and corrections are applied here. The reduced g values are stored in the
    columns `g_red_mugal` and the according standard deviation in `sd_g_red_mugal` in `obs_df`. The following
    corrections/reductions are supported:

    - Tidal corrections of observations

      - Corrections of the CG-5 instruments provided in the observation files (Longman, 1959)
      - No corrections
      - Longman (1959) model, evaluated in GravTools for the longitude, latitude , altitude and UTC time stamp of each observation. The correction is calculated for the middle of the reading time (obs_epoch + duration_sec/2)
      - Interpolated from correction time series (e.g. loaded from Tsoft TSF files)

    - Reduction of the observed gravity to different reference height levels

      - Control point level
      - Ground level
      - Level of the gravimeter top
      - Sensor level

    Notes
    -----
    Basically it is possible to initialize an empty survey, by just defining the survey's name on the instantiation
    step. In this case all other (class and instance) attributes are initialized with the default values listed below
    in the Attributes section.

    The observation reference time in GravTools is equal to the start time of an instrument reading - in accordance with
    the CG-5 observation files. This has to be taken into account when calculating time dependent corrections, such as
    tidal corrections.

    Attributes
    ----------
    name : str
        Name of the survey
    date :
        Date of te survey.
    operator : str, optional (default='')
        Name of the responsible operator that carried out the observations of this survey.
    gravimeter_serial_number : str, optional (default='')
        Gravimeter serial number as stated in the observation file.
    gravimeter_type: str, optional (default='')
        Valid gravimeter types have to be listed in :py:obj:`gravtools.settings.GRAVIMETER_TYPES`.
    data_file_name : str, optional (default='')
        Name of the data source file (observation file). Without file path!
    data_file_type : str, optional (default='')
        Type of the data source file. Since gravtools allows to load data from different sources, it is important to
        track the data source type.
    obs_tide_correction_type : str, (default='')
        Type of the tidal corrections applied on the observations (gravimeter readings as obtained from the data
        source; column `g_obs_mugal` in `obs_df`). Valid entries have to be listed in
        :py:obj:`gravtools.settings.TIDE_CORRECTION_TYPES`.
    obs_reference_height_type : str, (default='')
        Reference level type of the observations (gravimeter readings as obtained from the data
        source; column `g_obs_mugal` in `obs_df`). Valid entries have to be listed in
        :py:obj:`gravtools.settings.REFERENCE_HEIGHT_TYPE`.
    obs_atm_pres_correction_type : str, (default='')
        Type of atmospheric pressure correction applied on the observations (gravimeter readings as obtained from the
        data source; column `g_obs_mugal` in `obs_df`). Valid entries have to be listed in
        :py:obj:`gravtools.settings.ATM_PRES_CORRECTION_TYPES`.
    obs_scale_correction_type : str, (default='')
        Type of scale correction applied on the observations (gravimeter readings as obtained from the
        data source; column `g_obs_mugal` in `obs_df`). Valid entries have to be listed in
        :py:obj:`gravtools.settings.SCALE_CORRECTION_TYPES`.
    obs_oceanload_correction_type : str, (default='')
        Type of ocean-loading correction applied on the observations (gravimeter readings as obtained from the
        data source; column `g_obs_mugal` in `obs_df`). Valid  entries have to be listed in
        :py:obj:`gravtools.settings.OCEANLOAD_CORRECTION_TYPES`. `Empty string`, if corrected observations are not
        available.
    red_tide_correction_type : str, optional (default='')
        Type of the tidal corrections applied on the reduced observations (column `g_red_mugal` in `obs_df`). Valid
        entries have to be listed in :py:obj:`gravtools.settings.TIDE_CORRECTION_TYPES`. `Empty string`, if corrected
        observations are not available.
    red_reference_height_type : str, optional (default='')
        Reference level type of the reduced observations (column `g_red_mugal` in `obs_df`). Valid entries have to be
        listed in :py:obj:`gravtools.settings.REFERENCE_HEIGHT_TYPE`. `Empty string`, if corrected observations are not
        available.
    red_atm_pres_correction_type : str, (default='')
        Type of atmospheric pressure correction applied on the reduced observations (column `g_red_mugal` in `obs_df`).
        Valid entries have to be listed in :py:obj:`gravtools.settings.ATM_PRES_CORRECTION_TYPES`. `Empty string`, if
        corrected observations are not available.
    red_scale_correction_type : str, (default='')
        Type of scale correction applied on the reduced observations (column `g_red_mugal` in `obs_df`). Valid entries
         have to be listed in :py:obj:`gravtools.settings.SCALE_CORRECTION_TYPES`. `Empty string`, if corrected
        observations are not available.
    red_oceanload_correction_type : str, (default='')
        Type of ocean-loading correction applied on the reduced observations (column `g_red_mugal` in `obs_df`). Valid
        entries have to be listed in :py:obj:`gravtools.settings.OCEANLOAD_CORRECTION_TYPES`. `Empty string`, if
        corrected observations are not available.
    red_tide_correction_description : str, optional (default='')
        Optional description of the tide correction e.g. obtained from time series data. The reduced observations are
        stored in the column `g_red_mugal` and the corrections in column `corr_tide_red_mugal` in `obs_df`.
    red_tide_corr_timeseries_interpol_method : str, optional (default='')
        Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are
        obtained from other sources or models, this attribute is irrelevant and has to be empty!
    red_tide_corr_timeseries_creation_dt : `datetime`, optional (default=`None`)
        If tidal corrections are obtained from time series data, the time when the data was created, i.e. loaded into
        GravTools, is stored here as `datetime` object. This is required to uniquely identify the applies tidal
        corrections from time series data.
    setup_tide_correction_type : str, optional (default='')
        Type of the tidal corrections applied on the observations that are used to calculate the setup data in the
        `setup_df` dataframe. Valid entries have to be listed in :py:obj:`gravtools.settings.TIDE_CORRECTION_TYPES`.
        `Empty string`, if corrected setup data has not been calculated so far (`setup_df` = None).
    setup_reference_height_type : str, optional (default='')
        Reference height reduction type applied on the observations that are used to calculate the setup data in the
        `setup_df` dataframe. Valid entries have to be listed in :py:obj:`gravtools.settings.TIDE_CORRECTION_TYPES`.
        `Empty string`, if corrected setup data has not been calculated so far (`setup_df` = None).
    setup_atm_pres_correction_type : str, (default='')
        Type of atmospheric pressure correction applied on the observations that are used to calculate the setup data in
        the`setup_df` dataframe. Valid entries have to be listed in
        :py:obj:`gravtools.settings.ATM_PRES_CORRECTION_TYPES`.`Empty string`, if corrected setup data has not been
        calculated so far (`setup_df` = None).
    setup_scale_correction_type : str, (default='')
        Type of scale correction applied on the observations that are used to calculate the setup data in
        the`setup_df` dataframe. Valid entries have to be listed in
        :py:obj:`gravtools.settings.SCALE_CORRECTION_TYPES`.`Empty string`, if corrected setup data has not been
        calculated so far (`setup_df` = None).
    setup_oceanload_correction_type : str, (default='')
        Type of oceanload correction applied on the observations that are used to calculate the setup data in
        the`setup_df` dataframe. Valid entries have to be listed in
        :py:obj:`gravtools.settings.OCEANLOAD_CORRECTION_TYPES`.`Empty string`, if corrected setup data has not been
        calculated so far (`setup_df` = None).
    setup_calc_method : str, optional (default='')
        Method for the calculation of setup data. `variance_weighted_mean` implies that setup observations
        (observed gravity, standard deviations and reference time) are calculated by variance weighted mean of the
        individual observations. `individual_obs` implies that the original observations are used as setup data
        without any aggregation.
    setup_sd_method : str, optional (default='')
        Method for the determination of standard deviations (SD) of setup observations. `sd_from_obs_file` implies that
        SD are taken from the observation file. `sd_default_per_obs` and `sd_default_per_setup` imply that the
        given default SD is used, where the default SD is applied the individual observations in the first case and
        to setups in the second case. If applied to observations, the number of observations per setup still plays a
        role for weighting the setup observations in the adjustment.
    keep_survey : bool (default=True)
        Flag that indicates whether this survey will be used to derive setup observations.`True` is the
        default and implies that this survey is considered. This flag is independent of the `keep_obs` flags
        in the `obs_df` dataframe (used to flag individual observations).
    obs_df : :py:obj:`pandas.core.frame.DataFrame`, optional (default=None)
        Contains all observation data that belongs to this survey. One observation per line. If `None`, no observations
        have been assigned to the survey. All Columns are listed in :py:obj:`.Survey._OBS_DF_COLUMNS`:

        - station_name : str
            Name of observed station
        - setup_id : int
            Each setup (one or more observations at a station without moving the instrument) gets a unique ID in order
            to distinguish between independent groups of observations at a station. The setup_id is created based on
            the reference time of the first observation of a setup and the survey name.
        - loop_id: int, optional (default=None)
            Unique ID of a line. A survey can be split up into multiple lines. A line needs to have at least one station
            that was observed at least twice for drift control (preferably at the beginning and end of the line). If
            `None`, loops were not defined. The purpose of splitting surveys into loops is to carry out drift correction
            for individual loops (shorter time period) rather than fo the complete survey.
        -  lon_deg : float, optional (default=None)
            Geographical longitude of the station [°]. When loading observation data from the CG-5 observation files,
            geographical coordinates are obtained from measurements of the built-in GPS device of the instrument.
        -  lat_deg : float, optional (default=None)
            Geographical latitude of the station [°]. When loading observation data from the CG-5 observation files,
            geographical coordinates are obtained from measurements of the built-in GPS device of teh instrument.
        -  alt_m : float, optional (default=None)
            Altitude of the station [m]. When loading observation data from the CG-5 observation files,
            altitudes are obtained from measurements of the built-in GPS device of teh instrument.
        - obs_epoch : :py:obj:`datetime.datetime`; timezone aware, if possible
            Reference epoch of the observation. Per default the start epoch (!) of an observation. Be aware that for the
            determination of tidal corrections by the CG-5 built-in model (Longman, 1959) the middle of the observation
            with the duration dur_sec [sec] is used (obs_epoch + duration_sec/2)!
        - g_obs_mugal : float
            Observed gravity value (instrument reading) [µGal], as obtained from the data source (observation files).
            Be aware that, depending on the instrument settings and the observation data source, different corrections
            and/or reductions may have been applied already! The reference height type and the applied tidal correction
            have to be concise with the statements in :py:obj:`.Survey.obs_reference_height_type` and
            :py:obj:`.Survey.obs_tide_correction_type`, respectively.
        - sd_g_obs_mugal : float, optional (default=None)
            Standard deviation of `g_obs_mugal`. If `None`, the standard deviation is not available.
        - g_red_mugal : float, optional (default=None)
            Reduced gravity observation. This value is derived from the observed gravimeter reading (`g_obs_mugal`) by
            applying reductions and corrections, e.g. from analytical models for tidal effects, by a reduction to a
            different height level (using the vertical gravity gradient), or reduction due to atmospheric pressure
            variations. Take care, that the same  reductions and corrections are not applied more than once! The
            reference height type, the applied tidal correction and the applied atmospheric pressure corrections
            have to be concise with the statements in :py:obj:`.Survey.red_reference_height_type`,
            :py:obj:`.Survey.red_tide_correction_type` and :py:obj:`.Survey.red_atm_pres_correction_type`, respectively.
            If `None`, no reductions and/or corrections have been applied so far.
        - sd_g_red_mugal : float, optional (default=None)
            Standard deviation of the reduced gravity reading (`g_red_mugal`). This value is derived from the standard
            deviation of the gravity reading (`sd_g_obs_mugal`) by applying proper error propagation. If `None`, the SD
            of the gravity reading is not available, or no reductions/corrections have been applied so far, or an error
            propagation model is still missing. In general, this value should not be `None`, if `g_red_mugal` is not
            `None`.
        - corr_terrain : float, optional (default=None)
            Terrain correction [??] as determined by the built-in model of the Scintrex CG-5. If `None`, this
            correction is not available in the observation data.
        - corr_tide_mugal : float, optional (default=None)
            Tidal correction [µGal] as determined by the built-in model of the instrument. Be aware
            that the tidal corrections by the CG-5 model is determined fot the middle of the observation (also see
            `obs_epoch`). If `None`, this correction is not available in the observation data.
        - temp : float, optional (default=None)
            Temperature [mK] as determined by the Scintrex CG-5. Be aware that this is not the ambient temperature!
            This temperature is obtained from the GC-5 observation file and indicates internal temperature variations
            that are measured and used for the instrumental temperature compensation. If `None`, this information is
            not available in the observation data.
        - tiltx : float, optional (default=None)
            Tilt in x-direction [arcsec] of the gravimeter logged during the observation. If `None`, this
            information is not available in the observation data.
        - tilty : float, optional (default=None)
            Tilt in y-direction [arcsec] of the gravimeter logged during the observation. If `None`, this
            information is not available in the observation data.
        - dhf_m : float
            Vertical distance between instrument top and physical reference point [m]. This information is required
            for reducing the observed gravity to the reference point level (vertical gravity gradient also required).
        - dhb_m : float
            Vertical distance between instrument top and the ground [m]. This information is required
            for reducing the observed gravity to the ground level (vertical gravity gradient also required).
        - keep_obs : bool (default=True)
            Flag, that indicates whether this observation should be considered in the data analysis (adjustment).
            If `True`, the observations takes part in the analysis.
        - vg_mugalm : float, optional (default=numpy.nan)
            Vertical gravity gradient at the station [µGal/m], obtained from an external source (e.g. station info
            file). The vertical gradient is required for reducing the observed gravity to different reference heights.
        - corr_tide_red_mugal : float, optional (default=numpy.nan)
            Tidal correction [µGal] that is applied to `g_red_mugal`.
        - duration_sec : int
            Duration of each observation from the CG-5 observation files. Given in seconds.
        - atm_pres_hpa : float, optional (default=None)
            Measured atmospheric pressure in hPa. Used for correcting atmospheric pressure variations.
        - norm_atm_pres_hpa : float, optional (default=None)
            Normal atmospheric pressure in hPa. Used for correcting atmospheric pressure variations.
        - corr_atm_pres_red_mugal : float, optional (default=None)
            Atmospheric pressure correction [µGal] that is applied to `g_red_mugal`.
        - linear_scale : float, optional (default=None)
            Linear scale factor applied on the gravity readings in GravTools.
        - corr_oceanload_instrument_mugal : float, optional (default=NaN)
            Ocean-loading correction [µGal] as determined by the built-in model of the instrument. `NaN` implies that,
            this correction is not available in the observation data, i.e. no corrections were loaded from the
            observation files.
        - corr_oceanload_red_mugal : float, optional (default=NaN)
            Ocean-Loading correction [µGal] that is applied to `g_red_mugal`.

    ref_delta_t_dt : datetime, optional (default=None)
        Reference time for relative times (), e.g. reference time t0 the for drift polynomial adjustment.
    setup_df : :py:obj:`pandas.core.frame.DataFrame`, optional (default=None)
        Contains a single pseudo observation per setup calculated as variance weighted mean of all active
        (flag `keep_obs = True`) reduced observations of a setup and other information that is required for the
        subsequent parameter adjustment. If `None`, setup data ha not been determined yet. All Columns are listed in
        :py:obj:`.Survey._SETUP_DF_COLUMNS`:

        - station_name : str
            Name of the station that is observed in the setup.
        - setup_id : int
            Same as in `obs_df`.
        - g_mugal : float
            Variance weighted mean of all active reduced observations the setup [µGal].
        - sd_g_mugal : float
            Standard deviation of `g_mugal` [µGal]
        - epoch_unix : float
            Reference epoch of `g_mugal` in unix time [sec]
        - epoch_dt : :py:obj:`datetime.datetime`; timezone aware, if possible
            Reference epoch of `g_mugal`.
        - delta_t_h : float
            Time span since reference time :py:obj:`Survey.ref_delta_t_dt` in hours.
        - sd_setup_mugal : float
            Standard deviation of active observations in this setup [µGal].
        - number_obs : int
            Number of observations in a setup.

    setup_obs_list_df : :py:obj:`pandas.core.frame.DataFrame`, optional (default=None)
        List of observations in the `obs_df` dataframe that were used to calculate the setup observations in the
        `setup_df` dataframe.

        - station_name : str
            Name of the station.
        - obs_epoch : :py:obj:`datetime.datetime`
            Reference epoch of the observation (timezone aware, if possible).
        - keep_obs : bool (default=True)
            `False` implies that the observation is not used for calculating setup observations.

    """
    _OBS_DF_COLUMNS_DTYPES = {
        'station_name': str,  # Name of station (str)
        'setup_id': int,  # unique ID of setup (int)
        'loop_id': int,  # Line ID, optional (default=None) (int)
        'lon_deg': float,  # Longitude [deg], optional (float)
        'lat_deg': float,  # Latitude [deg], optional (float)
        'alt_m': float,  # Altitude [m], optional (float)
        'obs_epoch': np.datetime64,
        # Observation epoch (datetime object, TZ=<UTC>), start of instrument reading!# TODO: dt.datetime?
        'g_obs_mugal': float,  # observed g from obs file [µGal] (float)
        'sd_g_obs_mugal': float,  # Standard deviation of g observed from obs file (float) [µGal]
        'g_red_mugal': float,  # Reduced gravity observation at station (float) [µGal]
        'sd_g_red_mugal': float,  # Standard deviation of the reduced gravity (float) [µGal]
        'corr_terrain': float,  # Terrain correction [??]
        'corr_tide_mugal': float,
        # Tidal correction loaded from input file [µGal], optional (e.g. from CG5 built-in model)
        'temp': float,  # Temperature [mK], optional
        'tiltx': float,  # [arcsec], optional
        'tilty': float,  # [arcsec], optional
        'dhf_m': float,  # Distance between instrument top and physical reference point (float) [m]
        'dhb_m': float,  # Distance between instrument top and ground (float) [m]
        'keep_obs': bool,  # Remove observation, if false (bool)
        'vg_mugalm': float,  # vertical gradient [µGal/m]
        'corr_tide_red_mugal': float,  # Alternative tidal correction [µGal], optional
        'duration_sec': float,  # Duration [sec]
        'atm_pres_hpa': float,  # Measured atmospheric pressure [hPa]
        'norm_atm_pres_hpa': float,  # Normal atmospheric pressure [hPa]
        'corr_atm_pres_red_mugal': float,  # Normal atmospheric pressure correction [µGal]
        'linear_scale': float,  # Linear scale factor
        'corr_oceanload_instrument_mugal': float,  # Ocean loading correction loaded from instrument [µGal]
        'corr_oceanload_red_mugal': float,  # Applied ocean loading correction on reducesd obs. [µGal]
    }
    _OBS_DF_COLUMNS = tuple(_OBS_DF_COLUMNS_DTYPES.keys())

    _OBS_DF_INIT_COL_IF_MISSING = {
        'atm_pres_hpa': np.nan,
        'norm_atm_pres_hpa': np.nan,
        'corr_atm_pres_red_mugal': np.nan,
        'linear_scale': np.nan,
        'corr_tide_red_mugal': np.nan,
        'vg_mugalm': np.nan,
        'corr_oceanload_instrument_mugal': np.nan,
        'corr_oceanload_red_mugal': np.nan,
    }

    _SURVEY_ATTRIBUTES_INIT = {
        'setup_atm_pres_correction_type': '',
        'obs_atm_pres_correction_type': 'no_atm_pres_corr',
        'red_atm_pres_correction_type': '',
        'red_tide_correction_description': '',
        'obs_scale_correction_type': 'no_scale',
        'red_scale_correction_type': '',
        'setup_scale_correction_type': '',
        'obs_oceanload_correction_type': 'no_oceanload_corr',
        'red_oceanload_correction_type': '',
        'setup_oceanload_correction_type': '',
    }

    _SETUP_DF_COLUMNS = (
        'station_name',  # Name of station (str)
        'setup_id',  # Unique ID of setup (int)
        'g_mugal',  # Variance weighted mean of all active observations in setup [µGal] (float)
        'sd_g_mugal',  # Standard deviation of `g_mugal` (float) [µGal]
        'epoch_unix',  # Reference epoch of `g_mugal` (unix time [sec])
        'epoch_dt',  # Reference epoch of `g_mugal` (datetime obj)
        'delta_t_h',  # Time span since reference time [hours]
        'delta_t_campaign_h',  # Time span since reference time [hours]
        'sd_setup_mugal',  # Standard deviation of active observations in this setup [µGal]
        'number_obs',  # Number of observations in a setup
        'dhf_sensor_m',  # Vertical distance between control point and sensor height
        'linear_scale',  # Linear scale factor used for scaling the observations of the setup
    )

    _SETUP_OBS_LIST_DF_COLUMNS = (
        'station_name',  # Name of station (str)
        'obs_epoch',  # Observation epoch (datetime object, TZ=<UTC>), start of instrument reading!
        'keep_obs',  # If False, the observation is not used for calculating setup observations (bool)
    )

    def __init__(self,
                 name,
                 date=None,
                 operator='',
                 institution='',
                 gravimeter_serial_number='',
                 gravimeter_type='',
                 data_file_name='',
                 data_file_type='',
                 obs_df=None,
                 obs_tide_correction_type='',  # of "g_obs_mugal"
                 obs_reference_height_type='',  # of "g_obs_mugal"
                 obs_atm_pres_correction_type='',  # of "g_obs_mugal"
                 obs_scale_correction_type='',  # of "g_obs_mugal"
                 obs_oceanload_correction_type='',  # of "g_obs_mugal"
                 red_tide_correction_type='',  # of "g_red_mugal"
                 red_reference_height_type='',  # of "g_red_mugal"
                 red_atm_pres_correction_type='',  # of "g_red_mugal"
                 red_scale_correction_type='',  # of "g_red_mugal"
                 red_oceanload_correction_type='',  # of "g_red_mugal"
                 red_tide_correction_description='',  # of "g_red_mugal"
                 red_tide_corr_timeseries_interpol_method='',  # of "g_red_mugal"
                 red_tide_corr_timeseries_creation_dt=None,  # of "g_red_mugal"
                 setup_tide_correction_type='',
                 setup_reference_height_type='',
                 setup_atm_pres_correction_type='',
                 setup_scale_correction_type='',
                 setup_oceanload_correction_type='',
                 setup_calc_method='',
                 setup_sd_method='',
                 keep_survey=True,  # Flag
                 setup_df=None,
                 ref_delta_t_dt=None,  # Datetime object (UTC)
                 setup_obs_list_df=None  #
                 ):
        """Default constructor of class Survey."""

        # Check input arguments:
        # name:
        if name is not None:
            if isinstance(name, str):
                if len(name) > 0:
                    self.name = name
                else:
                    raise ValueError('"name" needs to be a non-empty string')
            else:
                raise TypeError('"name" needs to be a non-empty string')

        # date:
        if date is not None:
            if isinstance(date, dt.date):
                self.date = date
            else:
                raise TypeError('"date" needs to be a datetime object')
        else:
            self.date = date  # None

        # operator:
        if isinstance(operator, str):
            self.operator = operator
        else:
            raise TypeError('"operator" needs to be a string')

        # institution:
        if isinstance(institution, str):
            self.institution = institution
        else:
            raise TypeError('"institution" needs to be a string')

        # gravimeter_serial_number:
        if isinstance(gravimeter_serial_number, str):
            self.gravimeter_serial_number = gravimeter_serial_number
        else:
            raise TypeError('"gravimeter_serial_number" needs to be a string')

        # gravimeter_type:
        if isinstance(gravimeter_type, str):
            if gravimeter_type:
                if gravimeter_type in GRAVIMETER_TYPES.keys():
                    self.gravimeter_type = gravimeter_type
                else:
                    raise ValueError('"gravimeter_type" needs to be a key in GRAVIMETER_TYPES')
            else:
                self.gravimeter_type = gravimeter_type  # ''
        else:
            raise TypeError('"gravimeter_type" needs to be a string')

        # data_file_name:
        if isinstance(data_file_name, str):
            self.data_file_name = data_file_name
        else:
            raise TypeError('"data_file_name" needs to be a string')

        # data_file_type:
        if isinstance(data_file_type, str):
            if data_file_type:
                if data_file_type in SURVEY_DATA_SOURCE_TYPES.keys():
                    self.data_file_type = data_file_type
                else:
                    raise ValueError('"data_file_type" needs to be a key in SURVEY_DATA_SOURCE_TYPES')
            else:
                if self.data_file_name:  # Not empty
                    raise ValueError('If a data file is specified ("data_file_name" not empty), "data_file_type" has '
                                     'to be specified also.')
                self.data_file_type = data_file_type
        else:
            raise TypeError('"data_file_type" needs to be a string')

        # obs_df:
        if obs_df is not None:
            if isinstance(obs_df, pd.DataFrame):
                # Check if obs_df contains exactly all columns defined by self._OBS_DF_COLUMNS:
                if all([item for item in obs_df.columns.isin(self._OBS_DF_COLUMNS)]) and \
                        obs_df.shape[1] == len(self._OBS_DF_COLUMNS):
                    self.obs_df = obs_df
                else:
                    raise ValueError('"obs_df" needs the following columns:{}'.format(', '.join(self._OBS_DF_COLUMNS)))
            else:
                raise TypeError('"obs_df" needs to be a pandas DataFrame.')
        else:
            self.obs_df = obs_df  # None

        # obs_tide_correction_type:
        if isinstance(obs_tide_correction_type, str):
            if obs_tide_correction_type:
                if obs_tide_correction_type in TIDE_CORRECTION_TYPES.keys():
                    self.obs_tide_correction_type = obs_tide_correction_type
                else:
                    raise ValueError('"obs_tide_correction_type" needs to be a key in TIDE_CORRECTION_TYPES '
                                     '({})'.format(', '.join(TIDE_CORRECTION_TYPES.keys())))
            else:
                self.obs_tide_correction_type = obs_tide_correction_type  # None
        else:
            raise TypeError('"obs_tide_correction_type" needs to be a string')

        # red_tide_correction_type
        if isinstance(red_tide_correction_type, str):
            if red_tide_correction_type:
                if red_tide_correction_type in TIDE_CORRECTION_TYPES.keys():
                    self.red_tide_correction_type = red_tide_correction_type
                else:
                    raise ValueError('"red_tide_correction_type" needs to be a key in TIDE_CORRECTION_TYPES '
                                     '({})'.format(', '.join(TIDE_CORRECTION_TYPES.keys())))
            else:
                self.red_tide_correction_type = red_tide_correction_type  # None
        else:
            raise TypeError('"red_tide_correction_type" needs to be a string')

        # obs_reference_height_type:
        if isinstance(obs_reference_height_type, str):
            if obs_reference_height_type:
                if obs_reference_height_type in REFERENCE_HEIGHT_TYPE.keys():
                    self.obs_reference_height_type = obs_reference_height_type
                else:
                    raise ValueError('"obs_reference_height_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                     '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
            else:
                self.obs_reference_height_type = obs_reference_height_type  # None
        else:
            raise TypeError('"obs_reference_height_type" needs to be a string')

        # red_reference_height_type:
        if isinstance(red_reference_height_type, str):
            if red_reference_height_type:
                if red_reference_height_type in REFERENCE_HEIGHT_TYPE.keys():
                    self.red_reference_height_type = red_reference_height_type
                else:
                    raise ValueError('"red_reference_height_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                     '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
            else:
                self.red_reference_height_type = red_reference_height_type  # None
        else:
            raise TypeError('"red_reference_height_type" needs to be a string')

        # red_tide_correction_description
        if isinstance(red_tide_correction_description, str):
            self.red_tide_correction_description = red_tide_correction_description
        else:
            raise TypeError('"red_tide_correction_description" needs to be a string')

        # red_tide_corr_timeseries_interpol_method
        if isinstance(red_tide_corr_timeseries_interpol_method, str):
            self.red_tide_corr_timeseries_interpol_method = red_tide_corr_timeseries_interpol_method
        else:
            raise TypeError('"red_tide_corr_timeseries_interpol_method" needs to be a string')

        # red_tide_corr_timeseries_creation_dt
        if red_tide_corr_timeseries_creation_dt is not None:
            if not isinstance(red_tide_corr_timeseries_creation_dt, dt.datetime):
                raise TypeError('`red_tide_corr_timeseries_creation_dt` needs to be a datetime object.')
        self.red_tide_corr_timeseries_creation_dt = red_tide_corr_timeseries_creation_dt

        # obs_atm_pres_correction_type
        if isinstance(obs_atm_pres_correction_type, str):
            if obs_atm_pres_correction_type:
                if obs_atm_pres_correction_type in ATM_PRES_CORRECTION_TYPES.keys():
                    self.obs_atm_pres_correction_type = obs_atm_pres_correction_type
                else:
                    raise ValueError('"obs_atm_pres_correction_type" needs to be a key in ATM_PRES_CORRECTION_TYPES '
                                     '({})'.format(', '.join(ATM_PRES_CORRECTION_TYPES.keys())))
            else:
                self.obs_atm_pres_correction_type = obs_atm_pres_correction_type  # None
        else:
            raise TypeError('"obs_atm_pres_correction_type" needs to be a string')

        # red_atm_pres_correction_type
        if isinstance(red_atm_pres_correction_type, str):
            if red_atm_pres_correction_type:
                if red_atm_pres_correction_type in ATM_PRES_CORRECTION_TYPES.keys():
                    self.red_atm_pres_correction_type = red_atm_pres_correction_type
                else:
                    raise ValueError('"red_atm_pres_correction_type" needs to be a key in ATM_PRES_CORRECTION_TYPES '
                                     '({})'.format(', '.join(ATM_PRES_CORRECTION_TYPES.keys())))
            else:
                self.red_atm_pres_correction_type = red_atm_pres_correction_type  # None
        else:
            raise TypeError('"red_atm_pres_correction_type" needs to be a string')

        # obs_scale_correction_type
        if isinstance(obs_scale_correction_type, str):
            if obs_scale_correction_type:
                if obs_scale_correction_type in SCALE_CORRECTION_TYPES.keys():
                    self.obs_scale_correction_type = obs_scale_correction_type
                else:
                    raise ValueError(
                        '"obs_scale_correction_type" needs to be a key in SCALE_CORRECTION_TYPES '
                        '({})'.format(', '.join(SCALE_CORRECTION_TYPES.keys())))
            else:
                self.obs_scale_correction_type = obs_scale_correction_type  # None
        else:
            raise TypeError('"obs_scale_correction_type" needs to be a string')

        # red_scale_correction_type
        if isinstance(red_scale_correction_type, str):
            if red_scale_correction_type:
                if red_scale_correction_type in SCALE_CORRECTION_TYPES.keys():
                    self.red_scale_correction_type = red_scale_correction_type
                else:
                    raise ValueError(
                        '"red_scale_correction_type" needs to be a key in SCALE_CORRECTION_TYPES '
                        '({})'.format(', '.join(SCALE_CORRECTION_TYPES.keys())))
            else:
                self.red_scale_correction_type = red_scale_correction_type  # None
        else:
            raise TypeError('"red_scale_correction_type" needs to be a string')

        # obs_oceanload_correction_type
        if isinstance(obs_oceanload_correction_type, str):
            if obs_oceanload_correction_type:
                if obs_oceanload_correction_type in OCEANLOAD_CORRECTION_TYPES.keys():
                    self.obs_oceanload_correction_type = obs_oceanload_correction_type
                else:
                    raise ValueError(
                        '"obs_oceanload_correction_type" needs to be a key in OCEANLOAD_CORRECTION_TYPES '
                        '({})'.format(', '.join(OCEANLOAD_CORRECTION_TYPES.keys())))
            else:
                self.obs_oceanload_correction_type = obs_oceanload_correction_type  # ''
        else:
            raise TypeError('"obs_oceanload_correction_type" needs to be a string')

        # red_oceanload_correction_type
        if isinstance(red_oceanload_correction_type, str):
            if red_oceanload_correction_type:
                if red_oceanload_correction_type in OCEANLOAD_CORRECTION_TYPES.keys():
                    self.red_oceanload_correction_type = red_oceanload_correction_type
                else:
                    raise ValueError(
                        '"red_oceanload_correction_type" needs to be a key in OCEANLOAD_CORRECTION_TYPES '
                        '({})'.format(', '.join(OCEANLOAD_CORRECTION_TYPES.keys())))
            else:
                self.red_oceanload_correction_type = red_oceanload_correction_type  # ''
        else:
            raise TypeError('"red_oceanload_correction_type" needs to be a string')

        # setup_tide_correction_type:
        if isinstance(setup_tide_correction_type, str):
            if setup_tide_correction_type:
                if setup_tide_correction_type in REFERENCE_HEIGHT_TYPE.keys():
                    self.setup_tide_correction_type = setup_tide_correction_type
                else:
                    raise ValueError('"setup_tide_correction_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                     '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
            else:
                self.setup_tide_correction_type = setup_tide_correction_type  # ''
        else:
            raise TypeError('"setup_tide_correction_type" needs to be a string')

        # setup_reference_height_type:
        if isinstance(setup_reference_height_type, str):
            if setup_reference_height_type:
                if setup_reference_height_type in REFERENCE_HEIGHT_TYPE.keys():
                    self.setup_reference_height_type = setup_reference_height_type
                else:
                    raise ValueError('"setup_reference_height_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                     '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
            else:
                self.setup_reference_height_type = setup_reference_height_type  # ''
        else:
            raise TypeError('"setup_reference_height_type" needs to be a string')

        # setup_atm_pres_correction_type:
        if isinstance(setup_atm_pres_correction_type, str):
            if setup_atm_pres_correction_type:
                if setup_atm_pres_correction_type in ATM_PRES_CORRECTION_TYPES.keys():
                    self.setup_atm_pres_correction_type = setup_atm_pres_correction_type
                else:
                    raise ValueError('"setup_atm_pres_correction_type" needs to be a key in ATM_PRES_CORRECTION_TYPES '
                                     '({})'.format(', '.join(ATM_PRES_CORRECTION_TYPES.keys())))
            else:
                self.setup_atm_pres_correction_type = setup_atm_pres_correction_type  # ''
        else:
            raise TypeError('"setup_atm_pres_correction_type" needs to be a string')

        # setup_scale_correction_type:
        if isinstance(setup_scale_correction_type, str):
            if setup_scale_correction_type:
                if setup_scale_correction_type in SCALE_CORRECTION_TYPES.keys():
                    self.setup_scale_correction_type = setup_scale_correction_type
                else:
                    raise ValueError(
                        '"setup_scale_correction_type" needs to be a key in SCALE_CORRECTION_TYPES '
                        '({})'.format(', '.join(SCALE_CORRECTION_TYPES.keys())))
            else:
                self.setup_scale_correction_type = setup_scale_correction_type  # ''
        else:
            raise TypeError('"setup_scale_correction_type" needs to be a string')

        # setup_oceanload_correction_type:
        if isinstance(setup_oceanload_correction_type, str):
            if setup_oceanload_correction_type:
                if setup_oceanload_correction_type in OCEANLOAD_CORRECTION_TYPES.keys():
                    self.setup_oceanload_correction_type = setup_oceanload_correction_type
                else:
                    raise ValueError(
                        '"setup_oceanload_correction_type" needs to be a key in OCEANLOAD_CORRECTION_TYPES '
                        '({})'.format(', '.join(OCEANLOAD_CORRECTION_TYPES.keys())))
            else:
                self.setup_oceanload_correction_type = setup_oceanload_correction_type  # ''
        else:
            raise TypeError('"setup_oceanload_correction_type" needs to be a string')

        # setup_calc_method:
        if isinstance(setup_calc_method, str):
            if setup_calc_method:
                if setup_calc_method in SETUP_CALC_METHODS.keys():
                    self.setup_calc_method = setup_calc_method
                else:
                    raise ValueError('"setup_calc_method" needs to be a key in SETUP_CALC_METHODS '
                                     '({})'.format(', '.join(SETUP_CALC_METHODS.keys())))
            else:
                self.setup_calc_method = setup_calc_method  # ''
        else:
            raise TypeError('"setup_calc_method" needs to be a string')

        # setup_sd_method:
        if isinstance(setup_sd_method, str):
            if setup_sd_method:
                if setup_sd_method in SETUP_SD_METHODS.keys():
                    self.setup_sd_method = setup_sd_method
                else:
                    raise ValueError('"setup_sd_method" needs to be a key in SETUP_SD_METHODS '
                                     '({})'.format(', '.join(SETUP_SD_METHODS.keys())))
            else:
                self.setup_sd_method = setup_sd_method  # ''
        else:
            raise TypeError('"setup_sd_method" needs to be a string')

        # keep_survey
        if isinstance(keep_survey, bool):
            self.keep_survey = keep_survey
        else:
            raise TypeError('"keep_survey" needs to be a bool type.')

        # setup_df:
        if setup_df is not None:
            if isinstance(setup_df, pd.DataFrame):
                # Check if setup_df contains exactly all columns defined by self._SETUP_DF_COLUMNS:
                if all([item for item in obs_df.columns.isin(self._SETUP_DF_COLUMNS)]) and \
                        obs_df.shape[1] == len(self._SETUP_DF_COLUMNS):
                    self.setup_df = setup_df
                else:
                    raise ValueError(
                        '"setup_df" needs the following columns:{}'.format(', '.join(self._SETUP_DF_COLUMNS)))
            else:
                raise TypeError('"setup_df" needs to be a pandas DataFrame.')
        else:
            self.setup_df = setup_df  # None

        if ref_delta_t_dt is not None:
            if not isinstance(ref_delta_t_dt, dt.datetime):
                raise TypeError('`ref_delta_t_dt` needs to be a datetime object.')
        self.ref_delta_t_dt = ref_delta_t_dt

        # setup_obs_list_df:
        if setup_obs_list_df is not None:
            if isinstance(setup_obs_list_df, pd.DataFrame):
                # Check if setup_df contains exactly all columns defined by self._SETUP_DF_COLUMNS:
                if all([item for item in obs_df.columns.isin(self._SETUP_OBS_LIST_DF_COLUMNS)]) and \
                        obs_df.shape[1] == len(self._SETUP_OBS_LIST_DF_COLUMNS):
                    self.setup_obs_list_df = setup_obs_list_df
                else:
                    raise ValueError(
                        '"setup_obs_list_df" needs the following columns:{}'.format(
                            ', '.join(self._SETUP_OBS_LIST_DF_COLUMNS)))
            else:
                raise TypeError('"setup_obs_list_df" needs to be a pandas DataFrame.')
        else:
            self.setup_obs_list_df = setup_obs_list_df  # None

    @classmethod
    def from_cg6_survey(cls, cg6_survey, error_type: str = 'sd', location_type: str = 'user', keep_survey: bool = True,
                        pres_in_column: str = '', dhb_in_column: str = ''):
        """Construct that generates a Survey object based on a CG6Survey object.

        Parameters
        ----------
        cg6_survey : :py:obj:`gravtools.CG6_utils.cg6_survey.CG6Survey`
            Objects of the class CG6Survey containing all data from CG-6 observation files.
        error_type : str ('sd' or 'se'), optional (default = 'sd')
            'sd' indicates that the standard deviation values are loaded from the CG6 observation files whereas 'se'
            indicates that the standard error are used instead.
        location_type : str ('user' or 'gps'), optional (default = 'user')
            The CG6 gravimeter provides two sets of geolocation data (latitude, longitude, height):
            "user" (from predefined station file or from GPS) and "GPS" (from the GPS module). `user` indicates that
            the first set is user for locating the observations throughout the analysis process and `gps` indicates
            that the latter set is used.
        keep_survey : bool, optional (default=True)
            If False, this survey is excluded from further processing.
        pres_in_column : str, optional (default='line')
            In situ measurements of the atmospheric pressure [hPa] are provided in the column with the given name in the
            observation dataframe in the `CG6Survey` object. An empty string indicates that no pressure values are
            provided. In the latter case the `atm_pres_hpa` column in `obs_df` in initialized with `numpy.nan`.
        dhb_in_column : bool, optional (default=True)
            In situ measurements of the height difference [m] between the instrument and the ground (dhb) are provided
            in the column with the given name in the observation dataframe in the `CG6Survey` object. An empty string
            indicates that no height differences are provided. In the latter case the `dhb_m` column in `obs_df` in
            initialized with `numpy.nan`.

        Returns
        -------
        :py:obj:`.Survey`
            Contains all information of a specific survey independent of the data source.
        """
        # Check input arguments:
        if not isinstance(cg6_survey, CG6Survey):
            raise TypeError('"cg6_survey" has to be a CG6Survey object.')

        if cg6_survey.tidal_corr:
            obs_tide_correction_type = 'instrumental_corr'  # built-in tide correction of the CG-6 (multiple options)
        else:
            obs_tide_correction_type = 'no_tide_corr'

        if cg6_survey.ocean_loading_corr:
            obs_oceanload_correction_type = 'instrumental_corr'
        else:
            obs_oceanload_correction_type = 'no_oceanload_corr'

        # Prepare obs_df:
        obs_df_cg6 = cg6_survey.obs_df.sort_values('ref_time').copy(deep=True)

        # Check timezone of observation epoch and convert it to UTC, if necessary:
        if obs_df_cg6['ref_time'].dt.tz is None:  # TZ unaware => set TZ to <UTC>
            # obs_df_cg6.loc[:, 'ref_time'] = obs_df_cg6['ref_time'].dt.tz_localize('UTC')  # Causes a FutureWarning: https://github.com/pandas-dev/pandas/issues/55317
            obs_df_cg6['ref_time'] = obs_df_cg6['ref_time'].dt.tz_localize('UTC')
        elif obs_df_cg6['ref_time'].dt.tz != dt.timezone.utc:  # Change TZ to <UTC>
            # obs_df_cg6.loc[:, 'ref_time'] = obs_df_cg6['ref_time'].dt.tz_convert('UTC')  # Causes a FutureWarning: https://github.com/pandas-dev/pandas/issues/55317
            obs_df_cg6['ref_time'] = obs_df_cg6['ref_time'].dt.tz_convert('UTC')

        obs_df = pd.DataFrame()
        obs_df['station_name'] = obs_df_cg6['station']
        obs_df['setup_id'] = obs_df_cg6['setup_id']

        if 'line' in [pres_in_column, dhb_in_column]:
            obs_df['loop_id'] = None
        else:
            obs_df['loop_id'] = obs_df_cg6['line']
        if location_type == 'user':
            obs_df['lon_deg'] = obs_df_cg6['user_lon_deg']
            obs_df['lat_deg'] = obs_df_cg6['user_lat_deg']
            obs_df['alt_m'] = obs_df_cg6['user_height_m']
        elif location_type == 'gps':
            obs_df['lon_deg'] = obs_df_cg6['gps_lon_deg']
            obs_df['lat_deg'] = obs_df_cg6['gps_lat_deg']
            obs_df['alt_m'] = obs_df_cg6['gps_h_m']
        else:
            raise RuntimeError(f'location_type "{location_type}" is invalid!')
        obs_df['obs_epoch'] = obs_df_cg6['ref_time']
        obs_df['g_obs_mugal'] = obs_df_cg6['g_corr_mugal']
        if error_type == 'sd':
            obs_df['sd_g_obs_mugal'] = obs_df_cg6['sd_mugal']
        elif error_type == 'se':
            obs_df['sd_g_obs_mugal'] = obs_df_cg6['se_mugal']
        else:
            raise RuntimeError(f'Invalid error type "{error_type}" when loading survey {cg6_survey.survey_name}')
        obs_df['corr_terrain'] = np.nan  # Not available
        obs_df['corr_tide_mugal'] = obs_df_cg6['corr_tide_mugal']
        obs_df['temp'] = obs_df_cg6['sensor_temp_mk']
        obs_df['tiltx'] = obs_df_cg6['tilt_x_arcsec']
        obs_df['tilty'] = obs_df_cg6['tilt_y_arcsec']
        obs_df['dhf_m'] = obs_df_cg6['instr_height_m']
        if dhb_in_column != 'no_data':
            if dhb_in_column in obs_df_cg6.columns:
                try:
                    obs_df['dhb_m'] = obs_df_cg6[dhb_in_column].astype(float)
                except ValueError:
                    raise ValueError(f'Cannot convert values in column "{dhb_in_column}" to float (dhb).')
            else:
                raise RuntimeError(f'Invalid column name: {dhb_in_column}.')
        else:
            obs_df['dhb_m'] = np.nan
        obs_df['keep_obs'] = True
        obs_df['duration_sec'] = obs_df_cg6['duration']
        if pres_in_column != 'no_data':
            if pres_in_column in obs_df_cg6.columns:
                try:
                    obs_df['atm_pres_hpa'] = obs_df_cg6[pres_in_column].astype(float)
                except ValueError:
                    raise ValueError(f'Cannot convert values in column "{pres_in_column}" to float (pressure).')
            else:
                raise RuntimeError(f'Invalid column name: {pres_in_column}.')
        else:
            obs_df['atm_pres_hpa'] = np.nan
        obs_df['corr_oceanload_instrument_mugal'] = obs_df_cg6['corr_oceanload_mugal']

        # Drop columns that are not needed any more:
        # - all columns that are not in _OBS_DF_COLUMNS
        obs_df = cls._obs_df_drop_columns(obs_df)

        # Add all missing columns (init as None):
        obs_df = cls._obs_df_add_columns(obs_df)

        # Change column order:
        obs_df = cls._obs_df_reorder_columns(obs_df)

        # Check, if all columns are there:
        if not all([item for item in obs_df.columns.isin(cls._OBS_DF_COLUMNS)]):
            raise RuntimeError('Columns missing in "obs_df"')

        return cls(name=cg6_survey.survey_name,
                   date=obs_df_cg6.ref_time[0].date(),
                   operator=cg6_survey.operator,
                   institution='',  # Not available
                   gravimeter_type=DEFAULT_GRAVIMETER_TYPE_CG6_SURVEY,
                   gravimeter_serial_number=cg6_survey.serial_number,
                   data_file_name=os.path.split(cg6_survey.obs_filename)[1],  # Filename only, without path
                   data_file_type=cg6_survey.obs_file_type,
                   obs_df=obs_df,
                   obs_tide_correction_type=obs_tide_correction_type,
                   obs_reference_height_type='sensor_height',
                   obs_atm_pres_correction_type='no_atm_pres_corr',
                   obs_scale_correction_type='no_scale',
                   obs_oceanload_correction_type=obs_oceanload_correction_type,
                   red_tide_correction_type='',  # Not specified
                   red_reference_height_type='',  # Not specified
                   red_atm_pres_correction_type='',  # Not specified
                   red_scale_correction_type='',  # Not specified
                   red_oceanload_correction_type='',  # Not specified
                   keep_survey=keep_survey,
                   )

    @classmethod
    def from_cg5_survey(cls, cg5_survey, keep_survey: bool = True):
        """Constructor that generates and populates the survey object from a CG5Survey class object.

        Notes
        -----
        The observation epochs are represented by timezone aware datetime objects with TZ=<UTC>. The TZ is changed
        if necessary when loading data from any source.

        Parameters
        ----------
        cg5_survey : :py:obj:`gravtools.CG5_utils.cg5_survey.CG5Survey`
            Objects of the class CG5Survey contain all data from a CG-5 observation files.
        keep_survey : bool, optional (default=True)
            If False, this survey is excluded from further processing.

        Returns
        -------
        :py:obj:`.Survey`
            Contains all information of a specific survey independent of the data source.
        """

        # Check input arguments:
        if not isinstance(cg5_survey, CG5Survey):
            raise TypeError('"cg5_survey" has to be a CG5Survey object.')

        # Parse and check data from CG5Survey:
        # Get date from date and time:
        if cg5_survey.survey_parameters.date_time is not None:
            survey_date = cg5_survey.survey_parameters.date_time.date()
        else:
            survey_date = None

        # obs_df:
        if cg5_survey.obs_df is not None:
            # Refactor observation dataframe:
            obs_df = cg5_survey.obs_df.sort_values('obs_epoch').copy(
                deep=True)  # deep copy => No struggles with references

            # Add missing columns (initialized with default values):
            obs_df['g_obs_mugal'] = obs_df['g_mgal'] * 1e3
            obs_df['sd_g_obs_mugal'] = obs_df['sd_mgal'] * 1e3
            obs_df['sd_g_obs_mugal'] = obs_df['sd_mgal'] * 1e3
            obs_df['tide'] = obs_df['tide'] * 1e3
            obs_df['keep_obs'] = True

            # Check timezone of observation epoch and convert it to UTC, if necessary:
            if obs_df['obs_epoch'].dt.tz is None:  # TZ unaware => set TZ to <UTC>
                obs_df['obs_epoch'] = obs_df['obs_epoch'].dt.tz_localize('UTC')  # dtype: datetime64[ns, UTC]
            elif obs_df['obs_epoch'].dt.tz != dt.timezone.utc:  # Change TZ to <UTC>
                obs_df['obs_epoch'] = obs_df['obs_epoch'].dt.tz_convert('UTC')  # dtype: datetime64[ns, UTC]

            # Rename columns:
            obs_df.rename(columns={'terrain': 'corr_terrain',
                                   'tide': 'corr_tide_mugal', },
                          inplace=True)

            # Drop columns that are not needed any more:
            # - all columns that are not in _OBS_DF_COLUMNS
            obs_df = cls._obs_df_drop_columns(obs_df)

            # Add all missing columns (init as None):
            obs_df = cls._obs_df_add_columns(obs_df)

            # Change column order:
            obs_df = cls._obs_df_reorder_columns(obs_df)

            # Check, if all columns are there:
            # if not all(obs_df.columns.values == cls._OBS_DF_COLUMNS):
            if not all([item for item in obs_df.columns.isin(cls._OBS_DF_COLUMNS)]):
                raise RuntimeError('Columns missing in "obs_df"')
        else:
            obs_df = None  # If no observations are available, initialize as None

        if cg5_survey.options.tide_correction is None:
            obs_tide_correction_type = 'unknown'  # e.g. "CG-5 OPTIONS" block in observation file missing
        else:
            if cg5_survey.options.tide_correction:
                obs_tide_correction_type = 'instrumental_corr'  # built-in tide correction of the CG5
            else:
                obs_tide_correction_type = 'no_tide_corr'

        return cls(name=cg5_survey.survey_parameters.survey_name,
                   date=survey_date,
                   operator=cg5_survey.survey_parameters.operator,
                   institution=cg5_survey.survey_parameters.client,
                   gravimeter_type=DEFAULT_GRAVIMETER_TYPE_CG5_SURVEY,
                   gravimeter_serial_number=cg5_survey.survey_parameters.instrument_sn,
                   data_file_name=os.path.split(cg5_survey.obs_filename)[1],  # Filename only, without path
                   data_file_type='cg5_obs_file_txt',
                   obs_df=obs_df,
                   obs_tide_correction_type=obs_tide_correction_type,
                   obs_reference_height_type='sensor_height',
                   obs_atm_pres_correction_type='no_atm_pres_corr',
                   obs_scale_correction_type='no_scale',
                   obs_oceanload_correction_type='no_oceanload_corr',
                   red_tide_correction_type='',  # Not specified
                   red_reference_height_type='',  # Not specified
                   red_atm_pres_correction_type='',  # Not specified
                   red_scale_correction_type='',  # Not specified
                   keep_survey=keep_survey,
                   )

    @classmethod
    def from_cg5_obs_file(cls, filename, keep_survey=True):
        """Constructor that generates and populates the survey object directly from a CG5 observation file.

        Parameters
        ----------
        filename : str
            Name (and path) of a CG-5 observation file (text format).
        keep_survey : bool, optional (default=True)
            If False, this survey is excluded from further processing.

        Returns
        -------
        :py:obj:`.Survey`
            Contains all information of a specific survey independent of the data source.
        """
        cg5_survey = CG5Survey(filename)
        return cls.from_cg5_survey(cg5_survey, keep_survey=keep_survey)

    @classmethod
    def from_bev_obs_file(cls, filename, keep_survey=True, verbose=False):
        """Constructor that generates and populates the survey object from an observation file in the legacy BEV format.

        Notes
        -----
        Format of the legacy BEV observation files:
        - Line 1: Scaled values? ('Y'=True, 'N'=False)
        - Line 2: Instrument ID (e.g. 5 fpr CG5) and institution
        - Line 3: Degree of the drift polynomial to be fitted
        - Line 4: Date (YYYY MM DD)
        - Line 5: Timezone (UTC, MEZ, OEZ)
        - Line 6 bis n: Station name(x-xxx-xx), epoch (hh.mm), g [mGal], dhb [cm] (hh.h), dhf [cm] (hh.h)
        - Line n+1: 'end'

        The observation epochs are represented by timezone aware datetime objects with TZ=<UTC>. The TZ is changed
        if necessary when loading data from any source.

        Parameters
        ----------
        filename : str
            Name (and path) of an observation in the legacy BEV format.
        keep_survey : bool, optional (default=True)
            If False, this survey is excluded from further processing.
        verbose : bool, optional (default=False)
            If True, status messages are printed.

        Returns
        -------
        :py:obj:`.Survey`
            Contains all information of a specific survey independent of the data source.
        """
        survey_name = os.path.split(filename)[1]

        if verbose:
            print(f'Read observations from file: {filename}.')

        # Read header lines:
        num_of_header_lines = 5
        with open(filename) as myfile:
            head = [next(myfile) for x in range(num_of_header_lines)]
        # scaling = head[0][:-1] == 'Y'  # Keep for documentation
        gravimeter_id = head[1].split()[0]
        institution = head[1].split()[1]
        # polynomial_degree = int(head[2][:-1])  # Keep for documentation
        date_str = head[3][:-1]
        timezone_str = head[4][:-1]

        survey_date = dt.datetime.strptime(date_str, '%Y %m %d').date()

        # Read observations (fixed width file):
        widths = (
            11,  # Station name
            5,  # Time
            9,  # g [mGal]
            7,  # dhb [cm]
            6,  # dhf [cm]
        )
        column_names = (
            'station_name',
            'time_hh.mm',
            'g_mgal',
            'dhb_cm',
            'dhf_cm',
        )
        df = pd.read_fwf(filename, widths=widths, header=None, names=column_names, skiprows=5, skipfooter=1,
                         dtype={'time_hh.mm': object})

        # Prepare and initialize DataFrame:
        df['obs_epoch'] = pd.to_datetime(date_str + ' ' + df['time_hh.mm'] + ' ' + timezone_str,
                                         format='%Y %m %d %H.%M %Z')

        # Check timezone of observation epoch and convert it to UTC, if necessary:
        if df['obs_epoch'].dt.tz is None:  # TZ unaware => set TZ to <UTC>
            df['obs_epoch'] = df['obs_epoch'].dt.tz_localize('UTC')
        else:
            if df['obs_epoch'].dt.tz != dt.timezone.utc:  # Change TZ to <UTC>
                df['obs_epoch'] = df['obs_epoch'].dt.tz_convert('UTC')

        df['setup_id'] = df.apply(lambda row: make_setup_id(row['obs_epoch'], survey_name), axis=1)

        df['g_obs_mugal'] = df['g_mgal'] * 1e3
        df['dhb_m'] = df['dhb_cm'] * 1e-2
        df['dhf_m'] = df['dhf_cm'] * 1e-2

        df['keep_obs'] = True

        # Drop columns:
        obs_df = cls._obs_df_drop_columns(df)

        # Add all missing columns (init as None):
        obs_df = cls._obs_df_add_columns(obs_df)

        # Change column order:
        obs_df = cls._obs_df_reorder_columns(obs_df)

        # Get tide correction type:
        try:
            obs_tide_correction_type = BEV_GRAVIMETER_TIDE_CORR_LOOKUP[gravimeter_id]
        except KeyError:
            obs_tide_correction_type = 'unknown'
            if verbose:
                print(f'Warning: For gravimeter ID "{gravimeter_id}" the tide correction type is unknown '
                      f'(not specified in settings.BEV_GRAVIMETER_TIDE_CORR_LOOKUP). '
                      f'It is set to "{obs_tide_correction_type}".')

        # Use default values:
        gravimeter_serial_number = DEFAULT_GRAVIMETER_SERIAL_NUMBER
        gravimeter_type = DEFAULT_GRAVIMETER_TYPE

        return cls(name=survey_name,
                   date=survey_date,
                   operator='',
                   institution=institution,
                   gravimeter_type=gravimeter_type,
                   gravimeter_serial_number=gravimeter_serial_number,
                   data_file_name=os.path.split(filename)[1],  # Filename only, without path
                   data_file_type='bev_obs_file',
                   obs_df=obs_df,
                   obs_tide_correction_type=obs_tide_correction_type,
                   obs_reference_height_type='sensor_height',
                   obs_atm_pres_correction_type='no_atm_pres_corr',
                   obs_scale_correction_type='no_scale',
                   red_tide_correction_type='',  # Not specified
                   red_reference_height_type='',  # Not specified
                   red_atm_pres_correction_type='',  # Not specified
                   red_scale_correction_type='',  # Not specified
                   keep_survey=keep_survey,
                   )

    @classmethod
    def _obs_df_drop_columns(cls, obs_df):
        """Drop all columns of obs_df that are not listed in cls._OBS_DF_COLUMNS"""
        columns_to_be_dropped = list(set(obs_df.columns) - set(cls._OBS_DF_COLUMNS))
        obs_df.drop(columns=columns_to_be_dropped, inplace=True)
        return obs_df

    @classmethod
    def _obs_df_add_columns(cls, obs_df):
        """Add and initialize all columns that are listed in cls._OBS_DF_COLUMNS and not present in input obs_df.

        Notes
        -----
        Columns are initialized with the value `None`, if they are not a key in `cls._OBS_DF_INIT_COL_IF_MISSING`.
        Otherwise, they are initialized with the according value in `cls._OBS_DF_INIT_COL_IF_MISSING`. This provides
        the option to initialize columns with specific values, other than `None`, if required.
        """
        columns_to_be_initialized_as_none = list(set(cls._OBS_DF_COLUMNS) - set(obs_df.columns))
        obs_df[columns_to_be_initialized_as_none] = None
        cols_with_init_value = list(
            set(cls._OBS_DF_INIT_COL_IF_MISSING.keys()).intersection(set(columns_to_be_initialized_as_none)))
        for cols_name in cols_with_init_value:
            obs_df[cols_name] = cls._OBS_DF_INIT_COL_IF_MISSING[cols_name]
        return obs_df

    @classmethod
    def _obs_df_reorder_columns(cls, obs_df):
        """Change order of columns of obs_df to the order specified in cls._OBS_DF_COLUMNS.

        See: https://erikrood.com/Python_References/change_order_dataframe_columns_final.html
        """
        obs_df = obs_df[list(cls._OBS_DF_COLUMNS)]
        return obs_df

    def set_reference_time(self, ref_delta_t_dt):
        """Set reference time for the determination of relative time spans, e.g. for the drift polynomial.

        Parameters
        ----------
        ref_delta_t_dt : datetime object
            Reference time epoch w.r.t. UTC.
        """
        if isinstance(ref_delta_t_dt, dt.datetime):
            self.ref_delta_t_dt = ref_delta_t_dt
        else:
            raise ValueError('`ref_delta_t_dt` needs to be a datetime object.')

    def activate_setup(self, setup_id, flag_activate):
        """Activate or deactivate instrument setup with the specified ID.

        Parameters
        ----------
        setup_id : int
            ID of the setup that will be activated or deactivated.
        flag_activate : bool
            Specified whether the setup with the ID `setup_id` will be activated (`TRUE`) or deactivated (`False`).
        """
        if not isinstance(flag_activate, bool):
            raise TypeError('"flag_activate" has to be a boolean variable!')
        self.obs_df.loc[self.obs_df['setup_id'] == setup_id, 'keep_obs'] = flag_activate

    def activate_observation(self, obs_idx, flag_activate):
        """Activate or deactivate teh observation with the specified dataframe index.

        Parameters
        ----------
        obs_idx : int
            Index of the observation within the observation dataframe (`obs_df`) that will be activated or deactivated.
        flag_activate : bool
            Specified whether the observation with the index `obs_idx` will be activated (`TRUE`) or deactivated
            (`False`).
        """
        self.obs_df.at[obs_idx, 'keep_obs'] = flag_activate

    def check_obs_df(self, verbose=True) -> tuple[bool, str]:
        """Check, whether the observations DataFrame (`obs_df`) is valid and try to add missing columns.

        This method carried out the following checks:

        - Check the columns as specified in :py:obj:`.Survey._OBS_DF_COLUMNS`?

          - Does `obs_df` have all required columns?

          - If columns defined in :py:obj:`.Survey._OBS_DF_INIT_COL_IF_MISSING` are missing, they are added with the
            defined initial value.

        Parameters
        ----------
        verbose : bool, optional (default=False)
            If True, messages are printed in the command line interface.

        Returns
        -------
        is_valid : bool
            True, if `obs_df` is valid.
        error_msg : str
            Error Message. Empty if no errors occurred.
        """
        is_valid = True
        error_msg = ''

        # Invalid columns?
        invalid_cols = list(set(self.obs_df.columns) - set(self._OBS_DF_COLUMNS))
        if len(invalid_cols) > 0:
            is_valid = False
            error_msg = f'The following columns in the observation dataframe of survey "{self.name}" are not valid: {", ".join(invalid_cols)}. '
            if verbose:
                print(error_msg)

        # Missing columns?
        invalid_cols = list(set(self._OBS_DF_COLUMNS) - set(self.obs_df.columns))
        if len(invalid_cols) > 0:
            # Add columns with the default values, if defined in _OBS_DF_INIT_COL_IF_MISSING:
            for invalid_col in invalid_cols:
                if invalid_col in self._OBS_DF_INIT_COL_IF_MISSING:
                    self.obs_df[invalid_col] = self._OBS_DF_INIT_COL_IF_MISSING[invalid_col]
                    if verbose:
                        print(f'Added column "{invalid_col}" with default value "'
                              f'{self._OBS_DF_INIT_COL_IF_MISSING[invalid_col]}" in observation dataframe of survey "'
                              f'{self.name}".')
            # Check again:
            self.obs_df = self._obs_df_reorder_columns(self.obs_df)
            invalid_cols = list(set(self._OBS_DF_COLUMNS) - set(self.obs_df.columns))
            if len(invalid_cols) > 0:
                is_valid = False
                error_msg_tmp = (f'The following columns in the observation dataframe of survey "'
                                 f'{self.name}" are missing: {", ".join(invalid_cols)}. ')
                error_msg = error_msg + error_msg_tmp
                if verbose:
                    print(error_msg_tmp)

        return is_valid, error_msg

    def init_missing_attributes(self, verbose=True):
        """Initialize attributes defined in `_SURVEY_ATTRIBUTES_INIT`, if they are missing the current Survey instance.

        Notes
        -----
        This method is useful to establish downward compatibility between the current GravTools version and campaign
        data (pkl files) created/saved with previous version.

        Parameters
        ----------
        verbose : bool, optional (default=False)
            If True, messages are printed in the command line interface.
        """
        attributes = dir(self)
        for attribute, init_value in self._SURVEY_ATTRIBUTES_INIT.items():
            if attribute not in attributes:
                setattr(self, attribute, init_value)
                if verbose:
                    print(
                        f'Added attribute "{attribute}" (init. value: "{init_value}") to Survey object of survey "{self.name}".')

    def obs_df_drop_redundant_columns(self):
        """Drop all columns of obs_df that are not listed in self._OBS_DF_COLUMNS"""
        columns_to_be_dropped = list(set(self.obs_df.columns) - set(self._OBS_DF_COLUMNS))
        self.obs_df.drop(columns=columns_to_be_dropped, inplace=True)

    @classmethod
    def get_obs_df_column_name(cls, col_index):
        """Return the name of the observation dataframe column with the specified index.

        Parameters
        ----------
        col_index : int
            Column index for the observation dataframe.

        Returns
        -------
        str : Column name.
            Name of the column with index `col_index`
        """
        return cls._OBS_DF_COLUMNS[col_index]

    @classmethod
    def get_setup_df_column_name(cls, col_index):
        """Return the name of the setup dataframe column with the specified index.

        Parameters
        ----------
        col_index : int
            Column index for the setup dataframe.

        Returns
        -------
        str : Column name.
            Name of the column with index `col_index`
        """
        return cls._SETUP_DF_COLUMNS[col_index]

    @classmethod
    def get_obs_df_column_index(cls, column_name: str) -> int:
        """Returns the column index for specific column name for the obs_df dataframe.

        Parameters
        ----------
        column_name: str
            Name of the columns for which the column index is returned.

        Returns
        -------
        int : Column index
            Index of the column with the name `column_name`.
        """
        return cls._OBS_DF_COLUMNS.index(column_name)

    def get_number_of_observations(self) -> int:
        """Returns the number of observations of the current survey.

        Returns
        -------
        int
            Number of observations.
        """
        if self.obs_df is None:
            return 0
        else:
            return len(self.obs_df)

    def obs_df_populate_vg_from_stations(self, stations, verbose=False):
        """Populates the vertical gradient columns of the observation DataFrame with values from a Station object.

        Parameters
        ----------
        stations : :py:obj:`.Station` object
            Station data (datum- and non-datum-stations).

        verbose : bool, optional (default=False)
            If True, status messages are printed to the command line.

        Notes
        -----
        If an observed station is not present in the station object, or the station has no vertical gradient in the
        station object, the default vertical gradient is assigned to the observation.

        """
        # Merge stations Dataframe (`stat_df`) and observations DataFrame (`obs_df`) by the station names:
        self.obs_df = self.obs_df.merge(stations.stat_df[['station_name', 'vg_mugalm']], on='station_name',
                                        how='left', suffixes=('_x', ''))

        # Populate all missing VGs with the default value:
        self.obs_df.loc[self.obs_df['vg_mugalm'].isna(), 'vg_mugalm'] = VG_DEFAULT

        # Drop columns that are not required and check for validity:
        self.obs_df_drop_redundant_columns()
        self.obs_df = self._obs_df_reorder_columns(self.obs_df)
        valid_flag, error_msg = self.check_obs_df(verbose=verbose)
        if not valid_flag:
            raise RuntimeError(error_msg)

    def obs_df_populate_locations_from_stations(self, stations, verbose=False):
        """Populates the longitude, latitude and height columns with values from a Station object.

        Parameters
        ----------
        stations : :py:obj:`.Station` object
            Station data (datum- and non-datum-stations).

        verbose : bool, optional (default=False)
            If True, status messages are printed to the command line.

        Notes
        -----
        - Only update data for stations with data available from sources other than the gravimeter observation file!
          The data from the observation file has been added anyway.
        """
        if verbose:
            print(f'Survey "{self.name}": Get locations for observation and heights from station data')
        tmp_filter = stations.stat_df['source_type'] != 'obs_file'
        if not tmp_filter.any():
            if verbose:
                print(f' - No station data available.')
            return

        # Merge stations Dataframe and observations DataFrame  by the station names:
        tmp_stat_df = stations.stat_df.loc[tmp_filter, ['station_name', 'long_deg', 'lat_deg', 'height_m']].copy(
            deep=True)
        tmp_stat_df = tmp_stat_df.rename(
            columns={'long_deg': 'tmp_lon_deg', 'lat_deg': 'tmp_lat_deg', 'height_m': 'tmp_alt_m'})
        self.obs_df = self.obs_df.merge(tmp_stat_df, on='station_name', how='left')
        tmp_filter = ~self.obs_df['tmp_lat_deg'].isna() & ~self.obs_df['tmp_lat_deg'].isna() & ~self.obs_df[
            'tmp_alt_m'].isna()
        self.obs_df.loc[tmp_filter, 'lon_deg'] = self.obs_df.loc[tmp_filter, 'tmp_lon_deg']
        self.obs_df.loc[tmp_filter, 'lat_deg'] = self.obs_df.loc[tmp_filter, 'tmp_lat_deg']
        self.obs_df.loc[tmp_filter, 'alt_m'] = self.obs_df.loc[tmp_filter, 'tmp_alt_m']

        # Drop columns that are not required and check for validity:
        self.obs_df_drop_redundant_columns()
        self.obs_df = self._obs_df_reorder_columns(self.obs_df)
        valid_flag, error_msg = self.check_obs_df(verbose=verbose)
        if not valid_flag:
            raise RuntimeError(error_msg)

    def reduce_observations(self,
                            target_ref_height: str = None,
                            target_tide_corr: str = None,
                            target_atm_pres_corr: str = None,
                            target_scale_corr: str = None,
                            target_oceanload_corr: str = None,
                            atm_pres_admittance: float = ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT,
                            tide_corr_timeseries_interpol_method='',
                            correction_time_series=None,
                            gravimeters=None,
                            verbose: bool = False,
                            ) -> [bool, str]:
        """Reduce the observed gravity values by applying the selected corrections.

        The following corrections can be applied:

        - Reference height: Using the vertical gravity gradient at the measurement points (from station data file) and
          the vertical distances between instrument top, sensor height, ground and control point, the observations are
          reduced to the selected reference height. Information on the reference height of the input data (usually
          sensor height, as observed) and the target reference height are required.

        - Tidal correction: Observations are reduced due tidal gravitational attraction (caused by sun and moon).
          The applied model to determine the corrections for each observation, dependent on the location and time, can
          be selected. Information on the tidal corrections that were already applied on the input data is required

        - Atmospheric pressure variations: This correction is based on normal air pressure (ISO model), measured
          pressure at site and an admittance factor (default: 0.3).

        - Linear gravimeter scale factor: A priori linear scale factor are applied on the uncorrected gravity readings.
          The scale factors are instrument and time dependent and can be loaded from dedicated gravimeter files.

        Notes
        -----
        - For the reduction of the reference height vertical gravity gradients are required!

        Parameters
        ----------
        target_ref_height : string, specifying the target reference height type (default = `None`).
            The target reference height type has to be listed in :py:obj:`gravtools.settings.REFERENCE_HEIGHT_TYPE`.
            Default is `None` indicating that the reference heights of the input data are not changed.
        target_tide_corr : str, specifying the tidal correction type to be applied (default = `None`).
            The target tidal correction type specifies what kind of tidal correction will be applied. Valid types have
            to be listed in :py:obj:`gravtools.settings.TIDE_CORRECTION_TYPES`. Default is `None` indicating that the
            tidal corrections are not considered here (tidal corrections are inherited from input data).
        target_atm_pres_corr : str, optional (default = `None`)
            Specifying the atmospheric pressure correction type to be applied to all surveys. Valid types to be listed
            in :py:obj:`gravtools.settings.ATM_PRES_CORRECTION_TYPES`. Default is `None` indicating that the respective
            corrections of the input data are not changed.
        target_oceanload_corr : str, optional (default = `None`)
            Specifying the ocean-loading correction type to be applied to all surveys (if available). Valid types to be
            listed in :py:obj:`gravtools.settings.OCEANLOAD_CORRECTION_TYPES`. Default is `None` indicating that the
            respective corrections of the input data are not changed.
        target_scale_corr : str, optional (default = `None`)
            Specifies the scale correction type to be applied on all observations of this survey. Vali types are listed
            in :py:obj:`gravtools.settings.SCALE_CORRECTION_TYPES`. The default value `None` indicates that the
            respective corrections of the input data will not be changed.
        atm_pres_admittance : float, optional (default = `settings.ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT`)
            Admittance factor for the determination of pressure corrections based on the difference between measured and
            normal air pressure. The default value is taken from `settings.ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT`.
        tide_corr_timeseries_interpol_method : str, optional (default='')
            Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are
            obtained from other sources or models, this attribute is irrelevant and has to be empty!
        correction_time_series : `CorrectionTimeSeries` object, optional (default=None)
            Correction time series object that contains time series of tidal corrections for stations in surveys. This
            argument is required, if tidal corrections should be derived from time series data, i.e. if
            `self.target_tide_corr = from_time_series`.
        gravimeters : Gravimeter object, optional (default=`None`)
            Gravimeter object containing relevant information such as height differences for height corrections and
            scaling information.
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.
        """
        # Init.:
        tide_corr_timeseries_interpol_method_out = ''

        # Changes for compatibility to GravTools versions before 0.2.7:
        if self.obs_tide_correction_type == 'cg5_longman1959':
            self.obs_tide_correction_type = 'instrumental_corr'

        # Create a copy auf obs_df in order prevent problems with manipulation assigned py reference variables:
        obs_df = self.obs_df.copy(deep=True)

        # Initialize pandas series for reduced data by copying the observation data as loaded from the input file:
        g_red_mugal = obs_df['g_obs_mugal'].copy(deep=True)
        sd_g_red_mugal = obs_df['sd_g_obs_mugal']

        # Check whether field for reduced data are initialized correctly:
        flag_all_field_are_nan = all([obs_df['g_red_mugal'].isna().all(),
                                      obs_df['sd_g_red_mugal'].isna().all(),
                                      obs_df['corr_tide_red_mugal'].isna().all()
                                      ])
        flag_no_field_is_nan = all([
            all(~obs_df['g_red_mugal'].isna().values),
            all(~obs_df['sd_g_red_mugal'].isna().values),
            all(~obs_df['corr_tide_red_mugal'].isna().values)])
        if not (flag_all_field_are_nan or flag_no_field_is_nan):
            error_msg = 'In "obs_df" the columns "g_red_mugal", "sd_g_red_mugal" and "corr_tide_red_mugal" are not ' \
                        'initialized consistently! '
            raise RuntimeError(f'Survey "{self.name}":' + error_msg)

        if verbose:
            print(f'## Calculate reduced observations by applying the specified corrections:')

        # 0.) Scale correction:
        if (target_scale_corr is None) or (target_scale_corr == 'no_scale'):
            if verbose:
                print(f'No scaling correction applied.')
        elif target_scale_corr == 'linear_scale':
            if verbose:
                print(f'Apply linear scaling correction')

            # Remove instrumental tidal corrections first:
            if self.obs_tide_correction_type == 'instrumental_corr':
                g_red_mugal = g_red_mugal - obs_df['corr_tide_mugal']  # Undo instrumental corrections => No tide corr!
            elif self.obs_tide_correction_type == 'no_tide_corr':
                pass  # Already OK!
            else:
                raise RuntimeError(f'Not able to remove tidal corrections for the calculation of uncorrected '
                                   f'observations in survey {self.name}. Tidal corrections '
                                   f'{self.obs_tide_correction_type} cannot be removed properly.')

            # Apply scaling:
            tmp_g_df = pd.DataFrame({'epoch_dt': obs_df['obs_epoch'], 'g': g_red_mugal})
            tmp_g_df = gravimeters.apply_linear_scale(gravimeter_type=self.gravimeter_type,
                                                      serial_number=self.gravimeter_serial_number,
                                                      gravity_df=tmp_g_df,
                                                      verbose=True)
            g_red_mugal = tmp_g_df['g_scaled']
            linear_scale = tmp_g_df['linear_scale']

            # Add instrumental tidal corrections again:
            if self.obs_tide_correction_type == 'instrumental_corr':
                g_red_mugal = g_red_mugal + obs_df['corr_tide_mugal']
        else:
            raise RuntimeError(f'Unknown scaling correction type: {target_scale_corr}')

        # 1.) Check reference heights:
        if verbose:
            print(
                f'Reduction of reference heights to "{target_ref_height}" ({REFERENCE_HEIGHT_TYPE[target_ref_height]}):')

        if target_ref_height is None:  # Do nothing
            if verbose:
                print(f' - Reference heights are not changed!')
        else:
            # Check if the target reference height type is valid:
            if target_ref_height not in REFERENCE_HEIGHT_TYPE:
                raise ValueError(f'"{target_ref_height}" is an unknown reference height type.')

            # Check if reduction is necessary:
            if self.obs_reference_height_type == target_ref_height:
                if verbose:
                    print(f' - Observations are already referenced to: {target_ref_height}')
            else:
                # Check, if VG are available in obs_df:
                if obs_df.vg_mugalm.isna().any():
                    error_msg = f'For the following stations the vertical gravity gradient is not available: ' \
                                f'{", ".join(obs_df[obs_df.vg_mugalm.isna()].station_name.unique())}. ' \
                                f'Without vertical gradient the observed gravity cannot be reduced to another height ' \
                                f'level! '
                    raise RuntimeError(f'Survey "{self.name}":' + error_msg)

                # Reduction:
                # Distance between instrument top and sensor level:
                dst_m = gravimeters.get_height_offset(self.gravimeter_type, self.gravimeter_serial_number)
                if self.obs_reference_height_type == 'sensor_height':
                    if target_ref_height == 'control_point':
                        # + dst_m + dhf_m
                        g_red_mugal = g_red_mugal + (dst_m + obs_df['dhf_m']) * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'instrument_top':
                        # + dst_m
                        g_red_mugal = g_red_mugal + dst_m * obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'ground':
                        # + dst_m + dhb_m
                        g_red_mugal = g_red_mugal + (dst_m + obs_df['dhb_m']) * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif self.obs_reference_height_type == 'instrument_top':
                    if target_ref_height == 'sensor_height':
                        # - dst_m
                        g_red_mugal = g_red_mugal - dst_m * obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'ground':
                        # + dhb_m
                        g_red_mugal = g_red_mugal + obs_df['dhb_m'] * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'control_point':
                        # + dhf_m
                        g_red_mugal = g_red_mugal + obs_df['dhf_m'] * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif self.obs_reference_height_type == 'ground':
                    if target_ref_height == 'instrument_top':
                        # - dhb_m - dst_m + dst_m = - dhb_m
                        g_red_mugal = g_red_mugal - obs_df['dhb_m'] * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'sensor_height':
                        # - dhb_m - dst_m
                        g_red_mugal = g_red_mugal - (obs_df['dhb_m'] + dst_m) * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'control_point':
                        # - dhb_m - dst_m + dhf_m + dst_m = dhf_m - dhb_m
                        g_red_mugal = g_red_mugal + \
                                      (obs_df['dhf_m'] - obs_df['dhb_m']) * obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif self.obs_reference_height_type == 'control_point':
                    if target_ref_height == 'instrument_top':
                        # - dhf_m - dst_m + dst_m = - dhf_m
                        g_red_mugal = g_red_mugal - obs_df['dhf_m'] * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'ground':
                        # - dhf_m - dst_m + dst_m + dhb_m = dhb_m - dhf_m
                        g_red_mugal = g_red_mugal + \
                                      (obs_df['dhb_m'] - obs_df['dhf_m']) * obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                    elif target_ref_height == 'sensor_height':
                        # - dhf_m - dst_m
                        g_red_mugal = g_red_mugal - (obs_df['dhf_m'] + dst_m) * \
                                      obs_df['vg_mugalm']
                        # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                if verbose:
                    print('...done!')

        # 2.) Check tidal corrections:
        if target_tide_corr is None:  # Do nothing
            if verbose:
                print(f'Tidal corrections are not changed!')
        else:
            # Check if the target tidal correction type is valid:
            if target_tide_corr not in TIDE_CORRECTION_TYPES:
                error_msg = f'"{target_tide_corr}" is invalid!'
                raise RuntimeError(f'Survey "{self.name}":' + error_msg)
            tide_correction_description = TIDE_CORRECTION_TYPES[target_tide_corr]
            if verbose:
                print(f'Tidal corrections "{target_tide_corr}" ({tide_correction_description}):')
            # Check if reduction is necessary and/or possible:
            # - If time series data is used, corrections have to be calculated anyway, because the time series
            #   may have changed since their last determination!
            if (self.obs_tide_correction_type == target_tide_corr) & (target_tide_corr != 'from_time_series'):
                if verbose:
                    print(f' - Observations are already reduced by: {target_tide_corr}')
                if target_tide_corr == 'no_tide_corr':
                    corr_tide_red_mugal = obs_df['corr_tide_mugal'].copy(deep=True)
                    corr_tide_red_mugal[:] = 0
                else:
                    corr_tide_red_mugal = obs_df['corr_tide_mugal']

            elif self.obs_tide_correction_type == 'unknown':
                error_msg = 'Unknown tidal corrections at input data!'
                raise RuntimeError(f'Survey "{self.name}":' + error_msg)
            else:
                if self.obs_tide_correction_type == 'no_tide_corr':
                    if target_tide_corr == 'instrumental_corr':
                        g_red_mugal = g_red_mugal + obs_df['corr_tide_mugal']
                        corr_tide_red_mugal = obs_df['corr_tide_mugal']
                    elif target_tide_corr == 'longman1959':
                        corr_tide_red_mugal = self.get_tidal_corrections_from_longman1959()
                        g_red_mugal = g_red_mugal + corr_tide_red_mugal
                    elif target_tide_corr == 'from_time_series':
                        corr_tide_red_mugal = self.get_tidal_corrections_from_timeseries(
                            correction_time_series=correction_time_series,
                            interpolation_method=tide_corr_timeseries_interpol_method)
                        g_red_mugal = g_red_mugal + corr_tide_red_mugal
                        tide_corr_timeseries_interpol_method_out = tide_corr_timeseries_interpol_method

                elif self.obs_tide_correction_type == 'instrumental_corr':
                    g_red_mugal = g_red_mugal - obs_df[
                        'corr_tide_mugal']  # Undo instrumental corrections => No tide corr!
                    if target_tide_corr == 'no_tide_corr':
                        corr_tide_red_mugal = obs_df['corr_tide_mugal'].copy(deep=True)
                        corr_tide_red_mugal[:] = 0
                    elif target_tide_corr == 'longman1959':
                        corr_tide_red_mugal = self.get_tidal_corrections_from_longman1959()
                        g_red_mugal = g_red_mugal + corr_tide_red_mugal
                    elif target_tide_corr == 'from_time_series':
                        corr_tide_red_mugal = self.get_tidal_corrections_from_timeseries(
                            correction_time_series=correction_time_series,
                            interpolation_method=tide_corr_timeseries_interpol_method)
                        g_red_mugal = g_red_mugal + corr_tide_red_mugal
                        tide_corr_timeseries_interpol_method_out = tide_corr_timeseries_interpol_method

                elif self.obs_tide_correction_type == 'longman1959':
                    # This should never be the case!
                    g_red_mugal = g_red_mugal - obs_df[
                        'corr_tide_red_mugal']  # Undo corrections => No tide corr!
                    if target_tide_corr == 'no_tide_corr':
                        corr_tide_red_mugal = obs_df['corr_tide_mugal'].copy(deep=True)
                        corr_tide_red_mugal[:] = 0
                    elif target_tide_corr == 'instrumental_corr':
                        g_red_mugal = g_red_mugal + obs_df['corr_tide_mugal']
                        corr_tide_red_mugal = obs_df['corr_tide_mugal']
                    elif target_tide_corr == 'from_time_series':
                        corr_tide_red_mugal = self.get_tidal_corrections_from_timeseries(
                            correction_time_series=correction_time_series,
                            interpolation_method=tide_corr_timeseries_interpol_method)
                        g_red_mugal = g_red_mugal + corr_tide_red_mugal
                        tide_corr_timeseries_interpol_method_out = tide_corr_timeseries_interpol_method
                else:
                    raise RuntimeError(f'Tidal corrections of observation data ("{self.obs_tide_correction_type}") not '
                                       f'supported!')
                if verbose:
                    print('...done!')

        # 3.) Check atmospheric pressure corrections:
        if target_atm_pres_corr is None:  # Do nothing
            if verbose:
                print(f'Atmospheric pressure corrections are not changed!')
        else:
            # Check if the target correction type is valid:
            if target_atm_pres_corr not in ATM_PRES_CORRECTION_TYPES:
                error_msg = f'"{target_atm_pres_corr}" is invalid!'
                raise RuntimeError(f'Survey "{self.name}":' + error_msg)
            if verbose:
                print(
                    f'Atmospheric pressure corrections "{target_atm_pres_corr}" ({ATM_PRES_CORRECTION_TYPES[target_atm_pres_corr]}):')

            # Check, if an admittance factor is available:
            if atm_pres_admittance is None:
                error_msg = (f'The admittance factor for the determination of atmospheric pressure corrections is not'
                             f'available (is None).')
                raise RuntimeError(f'Survey "{self.name}":' + error_msg)

            if self.obs_atm_pres_correction_type == 'no_atm_pres_corr':
                if target_atm_pres_corr == 'no_atm_pres_corr':
                    corr_atm_pres_red_mugal = None
                    norm_atm_pres_hpa = np.nan
                if target_atm_pres_corr == 'iso_2533_1975':
                    height_m = obs_df['alt_m']
                    atm_pres_hpa = obs_df['atm_pres_hpa']
                    corr_atm_pres_red_mugal, norm_atm_pres_hpa = atmosphere_correction.pressure_correction_iso_pandas_series(
                        height_m,
                        atm_pres_hpa,
                        admittance=atm_pres_admittance)
                    # Apply non-NaN values only:
                    tmp_filter = ~corr_atm_pres_red_mugal.isna()
                    g_red_mugal.loc[tmp_filter] = g_red_mugal.loc[tmp_filter] - corr_atm_pres_red_mugal.loc[tmp_filter]
                    if verbose:
                        num_with_p_corr = len(tmp_filter.loc[tmp_filter])
                        number_of_obs = len(tmp_filter)
                        if num_with_p_corr != number_of_obs:
                            print(
                                f'WARNING: Pressure corrections are available for {num_with_p_corr} of {number_of_obs} observations in survey {self.name} only, probably due to missing pressure observations.')

            # This case should not be possible wit the current instruments since they are not capable to calculate
            # atmospheric corrections and provide them along with the observation data in the input files!
            # elif self.obs_atm_pres_correction_type == 'iso_2533_1975':
            #     # Undo the corrections...
            #     if target_atm_pres_corr == 'no_atm_pres_corr':
            #         corr_atm_pres_red_mugal = 0

            else:
                raise RuntimeError(f'Atmosphere pressure corrections of observation data '
                                   f'("{self.obs_atm_pres_correction_type}") not supported!')
            if verbose:
                print('...done!')

        # 4.) Check ocean-loading corrections:
        if target_oceanload_corr is None:  # Do nothing
            if verbose:
                print(f'Ocean loading corrections are not changed!')
        else:
            # Check if the target correction type is valid:
            if target_oceanload_corr not in OCEANLOAD_CORRECTION_TYPES:
                error_msg = f'"{target_oceanload_corr}" is invalid!'
                raise RuntimeError(f'Survey "{self.name}":' + error_msg)
            if verbose:
                print(
                    f'Ocean-loading corrections "{target_oceanload_corr}" ({OCEANLOAD_CORRECTION_TYPES[target_oceanload_corr]}):')

            if self.obs_oceanload_correction_type == 'no_oceanload_corr':
                if target_oceanload_corr == 'no_oceanload_corr':
                    if verbose:
                        print(f' - Observations are already reduced by: {target_oceanload_corr}')
                    corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal'].copy(deep=True)
                    corr_oceanload_red_mugal[:] = 0  # Set to zero
                if target_oceanload_corr == 'instrumental_corr':
                    # Check correction data availability:
                    if np.isnan(obs_df['corr_oceanload_instrument_mugal']).all():
                        corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal'].copy(deep=True)
                        corr_oceanload_red_mugal[:] = 0  # Set to zero
                    else:  # corrections available
                        corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal']
                        g_red_mugal = g_red_mugal + corr_oceanload_red_mugal  # TODO: correct sign?
            elif self.obs_oceanload_correction_type == 'instrumental_corr':
                if target_oceanload_corr == 'no_oceanload_corr':
                    corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal'].copy(deep=True)
                    corr_oceanload_red_mugal[:] = 0  # Set to zero
                    g_red_mugal = g_red_mugal - obs_df['corr_oceanload_instrument_mugal']  # TODO: correct sign?
                if target_oceanload_corr == 'instrumental_corr':
                    if verbose:
                        print(f' - Observations are already reduced by: {target_oceanload_corr}')
                    corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal']
            else:
                raise RuntimeError(f'Ocean-loading corrections of observation data '
                                   f'("{self.obs_oceanload_correction_type}") not supported!')

        # 5.) Apply changes, if no exceptions were raised:
        self.red_tide_correction_type = target_tide_corr
        self.red_reference_height_type = target_ref_height
        self.red_atm_pres_correction_type = target_atm_pres_corr
        self.red_oceanload_correction_type = target_oceanload_corr
        self.red_tide_correction_description = tide_correction_description
        self.red_tide_corr_timeseries_interpol_method = tide_corr_timeseries_interpol_method_out
        self.obs_df['g_red_mugal'] = g_red_mugal
        self.obs_df['sd_g_red_mugal'] = sd_g_red_mugal
        if target_tide_corr is not None:
            self.obs_df['corr_tide_red_mugal'] = corr_tide_red_mugal
        if target_atm_pres_corr is not None:
            self.obs_df['corr_atm_pres_red_mugal'] = corr_atm_pres_red_mugal
            self.obs_df['norm_atm_pres_hpa'] = norm_atm_pres_hpa
        if target_oceanload_corr is not None:
            self.obs_df['corr_oceanload_red_mugal'] = corr_oceanload_red_mugal
        self.red_scale_correction_type = target_scale_corr
        if target_scale_corr == 'linear_scale':
            self.obs_df['linear_scale'] = linear_scale
        else:
            self.obs_df['linear_scale'] = np.nan

    def get_tidal_corrections_from_timeseries(self, correction_time_series, interpolation_method: str) -> np.ndarray:
        """Derives tidal corrections for observations from time series data.

        Notes
        -----
        The derived corrections have to be ADDED to the observations in order to reduce tidal effects!

        Parameters
        ----------
        correction_time_series : `CorrectionTimeSeries` object, optional (default=None)
            Correction time series object that contains time series of tidal corrections for stations in surveys. This
            argument is required, if tidal corrections should be derived from time series data, i.e. if
            `self.target_tide_corr = from_time_series`.
        interpolation_method : str, optional (default='')
            Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are
            obtained from other sources or models, this attribute is irrelevant and has to be empty!

        Returns
        -------
        `pandas.Series`: Interpolated value for the given interpolation times.
        """
        # Check, if time series data is available for all stations in the survey:
        # - Survey:
        if self.name not in correction_time_series.surveys:
            raise RuntimeError(f'No correction time series data available for survey "{self.name}".')
        # - Stations in Survey:
        missing_stations = list(
            set(correction_time_series.surveys[self.name].station_names) - set(self.observed_stations))
        if len(missing_stations) > 0:
            raise RuntimeError(
                f'No correction time series data available for the stations: ' + ', '.join(missing_stations))

        # Prep. input observation dataframe: Keep required columns only:
        tmp_df = self.obs_df[['station_name', 'obs_epoch', 'duration_sec']].copy(deep=True)
        # Shift obs reference epoch from start to the middle of the gravity reading
        # (= evaluation time for the tide model):
        tmp_df['obs_epoch'] = tmp_df['obs_epoch'] + pd.to_timedelta(tmp_df['duration_sec'], 'sec') / 2
        tmp_df.drop(columns=['duration_sec'], inplace=True)
        tmp_df['ts_tide_corr_mugal'] = np.nan

        # Loop over stations, interpolate corrections and add them to tmp_df:
        # - Check temporal data availability (scipy.interpolate.interp1 raises an error anyway)
        # - consider interpolation_method
        # - consider the model type (correction or effect)
        # - consider the units => µGal
        for station in self.observed_stations:
            tmp_filter = tmp_df['station_name'] == station
            obs_epochs_dt64 = tmp_df.loc[tmp_filter, 'obs_epoch'].to_numpy()
            interp = correction_time_series.surveys[self.name].stations[station].tidal_correction.interpolate(
                interp_times=obs_epochs_dt64,
                kind=interpolation_method,
                return_correction=True)
            interp_mugal = convert_to_mugal(interp,
                                            correction_time_series.surveys[self.name].stations[
                                                station].tidal_correction.unit)
            tmp_df.loc[tmp_filter, 'ts_tide_corr_mugal'] = interp_mugal
        tide_corr_timeseries_mugal = tmp_df['ts_tide_corr_mugal'].to_numpy()
        return tide_corr_timeseries_mugal

    def get_tidal_corrections_from_longman1959(self) -> pd.Series:
        """Derive tidal corrections for all observations in this survey using the Longman (1959) model.

        Evaluates the Longman (1959) tidal model at the geographic position and UTC epoch of each
        observation in :py:obj:`.Survey.obs_df`. The tidal effect is evaluated at the **middle** of
        each gravity reading (``obs_epoch + duration_sec / 2``) rather than at the start epoch, which
        is the convention adopted throughout GravTools.

        The following columns of :py:obj:`.Survey.obs_df` are required and must not contain ``NaN``
        values: ``obs_epoch``, ``duration_sec``, ``lon_deg``, ``lat_deg``, ``alt_m``.

        Notes
        -----
        The returned corrections must be **added** to the raw gravity readings in order to remove
        (reduce) the tidal signal.

        Returns
        -------
        pandas.Series
            Tidal corrections [µGal] indexed by the integer row index of :py:obj:`.Survey.obs_df`.
            Positive values indicate that the Earth tide increases the measured gravity at that epoch;
            adding the correction removes the tidal contribution from the reading.

        Raises
        ------
        RuntimeError
            If any of the required coordinate or duration columns (``lon_deg``, ``lat_deg``,
            ``alt_m``) contain ``NaN`` values, indicating that station coordinates are missing.
        """
        tmp_df = self.obs_df[['obs_epoch', 'duration_sec', 'lon_deg', 'lat_deg', 'alt_m']].copy(
            deep=True)
        # Check availability of input data:
        if tmp_df['lon_deg'].isna().any() or tmp_df['lat_deg'].isna().any() or tmp_df['alt_m'].isna().any():
            raise RuntimeError(f'Failed to calculate tidal corrections according to Longman (1959) due to missing station coordinates!')
        # Shift obs reference epoch from start to the middle of the gravity reading
        # (= evaluation time for the tide model):
        tmp_df['obs_epoch'] = tmp_df['obs_epoch'] + pd.to_timedelta(tmp_df['duration_sec'], 'sec') / 2
        # Remove TZ info for longman evaluation:
        tmp_df['obs_epoch'] = tmp_df['obs_epoch'].dt.tz_localize(None)
        tmp_df['tmp_index'] = tmp_df.index
        tmp_df = tmp_df.set_index('obs_epoch')
        tmp_df = gravtools.tides.longman1959.solve_tide_df(tmp_df, lat='lat_deg', lon='lon_deg', alt='alt_m')
        tmp_df['longman_tide_corr_mugal'] = tmp_df['g0'] * 1e3  # Convert from mGal to µGal
        tmp_df = tmp_df.set_index('tmp_index')  # Restore numerical index
        return tmp_df['longman_tide_corr_mugal']

    def autselect_tilt(self, threshold_arcsec: int, setup_id: int = None, verbose: bool = False):
        """Deactivate all observations of the survey or of a setup with a tilt larger than the defined threshold.

        Parameters
        ----------
        threshold_arcsec : int
            Observations in this survey or the specified setup are deactivated, if their tilt in X or Y direction
            (columns `tiltx` and `tilty` in :py:obj:`.Survey.obs_df`) exceeds the given threshold [arcsec].
        setup_id : int (default=None)
            `None` implies that this autoselection function is applied on all observations of this survey. Otherwise,
            the autoselection function is only applied on observations of the setup with the provided ID (`setup_id`)
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.
        """
        filter_tilt = (abs(self.obs_df['tiltx']) > threshold_arcsec) | (abs(self.obs_df['tilty']) > threshold_arcsec)
        if setup_id is not None:  # Apply on whole survey
            filter_tilt = filter_tilt & (self.obs_df['setup_id'] == setup_id)
        self.obs_df.loc[filter_tilt, 'keep_obs'] = False
        if verbose:
            print(
                f'Removed observations due to tilt threshold ({threshold_arcsec} asec): {filter_tilt[filter_tilt].count()}')

    def autselect_duration(self, threshold_sec: int, setup_id: int = None, verbose: bool = False):
        """Detect and deactivate all observations with a measurement duration smaller than the threshold.

        Parameters
        ----------
        threshold_sec : int
            Threshold for the measurement duration.
        setup_id : int (default=None)
            `None` implies that this autoselection function is applied on all observations of this survey. Otherwise,
            the autoselection function is only applied on observations of the setup wirth the provided ID (`setup_id`)
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.
        """
        filter_duration = self.obs_df['duration_sec'] < threshold_sec
        if setup_id is not None:  # Apply on whole survey
            filter_duration = filter_duration & (self.obs_df['setup_id'] == setup_id)
        self.obs_df.loc[filter_duration, 'keep_obs'] = False
        if verbose:
            print(
                f'Removed observations due to duration threshold ({threshold_sec} sec): {filter_duration[filter_duration].count()}')

    def autselect_g_sd(self, threshold_mugal: int, obs_type: str = 'reduced', setup_id: int = None,
                       verbose: bool = False):
        """Deactivate observations with a gravity standard deviation larger than the defined threshold.

        Parameters
        ----------
        threshold_mugal : int
            Observations in this survey or the specified setup are deactivated, if the standard deviation of the
            observed or the reduced gravity (columns `sd_g_obs_mugal` or `sd_g_red_mugal` in
            :py:obj:`.Survey.obs_df`) exceed the given threshold [µGal].
        obs_type : str, 'observed' or 'reduced' (default)
            Defines whether the observed (as loaded from an observation file) or the reduced observations are used as
            reference for this autoselection function.
        setup_id : int (default=None)
            `None` implies that this autoselection function is applied on all observations of this survey. Otherwise,
            the autoselection function is only applied on observations of the setup wirth the provided ID (`setup_id`).
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.

        Returns
        -------
        bool : Error indicator.
            `False`, if at least one standard deviation value is `None` is case, reduced observations are usd as
            reference.
        """
        if obs_type == 'reduced':
            if self.obs_df['sd_g_red_mugal'].isna().any():
                if verbose:
                    print('ERROR: At least one value in column "sd_g_red_mugal" is None.')
                return False
            filter_g_sd = (abs(self.obs_df['sd_g_red_mugal']) > threshold_mugal)
        elif obs_type == 'observed':
            filter_g_sd = (abs(self.obs_df['sd_g_obs_mugal']) > threshold_mugal)
        else:
            raise ValueError(f'Invalid value assigned to the parameter "obs_type": {obs_type}')
        if setup_id is not None:  # Apply on whole survey
            filter_g_sd = filter_g_sd & (self.obs_df['setup_id'] == setup_id)
        self.obs_df.loc[filter_g_sd, 'keep_obs'] = False
        return True

    def autselect_delta_g(self, threshold_mugal: int, n_obs: int = 3, obs_type: str = 'reduced', setup_id: int = None,
                          verbose: bool = False):
        """Deactivate observations based ob the deviation of the stabilized gravity at a setup.

        Notes
        -----
        If a setup consists of less than `n_obs` observations, this autoselection function is not applied.


        Parameters
        ----------
        threshold_mugal : int
            Observations in this survey or the specified setup are deactivated, if the observed or the reduced gravity
            (columns `sd_g_obs_mugal` or `sd_g_red_mugal` in :py:obj:`.Survey.obs_df`) deviates from the stabilized
            gravity at the setup by more than the given threshold. The stabilized gravity at a setup is calculated as
            the mean (observed or reduced) gravity of the last `n_obs` observations in a setup.
        n_obs : int, optional (default=3)
            Number of observations at the end of a setup that are used to calculate the stabilized gravity as reference
            for deactivating observations.
        obs_type : str, 'observed' or 'reduced' (default)
            Defines whether the observed (as loaded from an observation file) or the reduced observations are used as
            reference for this autoselection function.
        setup_id : int, optional (default=None)
            `None` implies that this autoselection function is applied on all setup of this survey. Otherwise,
            the autoselection function is only applied on observations of the setup with the provided ID (`setup_id`).
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.

        Returns
        -------
        bool : Error indicator.
            `False`, if at least one standard deviation value is `None` is case, reduced observations are usd as
            reference.
        """
        # TODO: Check, if it makes sense to keep the last n_obs observations anyway (even if they do not meet the
        #  conditions here)! Check if reduced observations are available, if required:
        if obs_type == 'reduced':
            if self.obs_df['g_red_mugal'].isna().any():
                if verbose:
                    print('ERROR: At least one value in column "g_red_mugal" is None.')
                return False

        # Get list of IDs of all setups that will be handled:
        if setup_id is None:
            setup_ids = self.get_setup_ids()
        else:
            setup_ids = [setup_id]

        # Loop over all setups:
        for setup_id in setup_ids:
            filter_id = self.obs_df['setup_id'] == setup_id
            if verbose:
                print(f' - setup ID: {setup_id}')
            # Check number of observations in setup:
            if len(self.obs_df.loc[filter_id]) < (n_obs + 1):
                if verbose:
                    print(f'   - Less than {n_obs} observations available: {len(self.obs_df.loc[filter_id])}')
            else:  # Enough observations in this setup
                # Calculate stabilized gravity and set up filter:
                if obs_type == 'reduced':
                    g_stabilized_mugal = self.obs_df.loc[filter_id, 'g_red_mugal'].tail(n_obs).mean()
                    filter_delta_g = (self.obs_df['g_red_mugal'] < (g_stabilized_mugal - threshold_mugal)) | (
                            self.obs_df['g_red_mugal'] > (g_stabilized_mugal + threshold_mugal))
                elif obs_type == 'observed':
                    g_stabilized_mugal = self.obs_df.loc[filter_id, 'g_obs_mugal'].tail(n_obs).mean()
                    filter_delta_g = (self.obs_df['g_obs_mugal'] < (g_stabilized_mugal - threshold_mugal)) | (
                            self.obs_df['g_obs_mugal'] > (g_stabilized_mugal + threshold_mugal))
                else:
                    raise ValueError(f'Invalid value assigned to the parameter "obs_type": {obs_type}')

                # Apply filter:
                filter_all = filter_delta_g & filter_id
                if verbose:
                    print(f'   - Number of removed observations: {len(self.obs_df.loc[filter_all, "keep_obs"])}')
                self.obs_df.loc[filter_all, 'keep_obs'] = False
        return True

    def get_setup_ids(self) -> list:
        """Return the IDs of all setups in this survey

        Returns
        list : List of all setup IDs.
        """
        return self.obs_df.setup_id.unique().tolist()

    def __str__(self):
        if self.obs_df is not None:
            return f'Survey "{self.name}" with {len(self.obs_df)} observations.'
        else:
            return f'Survey "{self.name}"'

    def reset_setup_data(self, verbose=False):
        """Deletes the setup data.

        Parameters
        ----------
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.
        """
        if self.setup_df is None:
            if verbose:
                print('Nothing to delete. Setup data is empty.')
        else:
            if verbose:
                print('Setup data deleted.')
            self.setup_df = None
            self.setup_reference_height_type = ''
            self.setup_tide_correction_type = ''
            self.setup_atm_pres_correction_type = '',
            self.setup_scale_correction_type = '',
            self.setup_oceanload_correction_type = '',
            self.setup_calc_method = ''
            self.setup_obs_list_df = None

    def calculate_setup_data(self,
                             gravimeters,
                             obs_type='reduced',
                             ref_delta_t_campaign_dt=None,
                             active_obs_only_for_ref_epoch=True,
                             method='variance_weighted_mean',
                             method_sd='sd_from_obs_file',
                             default_sd_mugal=100.0,
                             verbose=False):
        """Accumulate all active observation within each setup and calculate a single representative pseudo observation.

        Parameters
        ----------
        gravimeters : Gravimeter object
            Gravimeter object containing relevant information such as height differences for height corrections and
            scaling information.
        obs_type : str, 'observed' or 'reduced' (default)
            Defines whether the observed (as loaded from an observation file) or the reduced observations from
            `self.obs_df` are used to determine the weighted mean values per setup.
        ref_delta_t_campaign_dt : datetime object, optional (default = None)
            Reference time for calculation of `delta_t_campaign_h`. `None` implies that the reference epoch is not
            available/defined. In the latter case `delta_t_campaign_h` is `None` for all setup observations.
        active_obs_only_for_ref_epoch: bool, optional (default=True)
            `True` implies that the relative reference epochs are determined by considering active observations only.
        method : str, optional (default=`variance_weighted_mean`)
            Select method for the calculation of setup data. `variance_weighted_mean` implies that setup observations
            (observed gravity, standard deviations and reference time) are calculated by variance weighted mean of the
            individual observations. `individual_obs` implies that the original observations are used as setup data
            without any aggregation.
        method_sd : str, optional (default='sd_from_obs_file')
            Method for the determination of standard deviations (SD) of setup observations. `sd_from_obs_file` implies that
            SD are taken from the observation file. `sd_default_per_obs` and `sd_default_per_setup` imply that the
            given default SD is used, where the default SD is applied the individual observations in the first case and
            to setups in the second case. If applied to observations, the number of observations per setup still plays a
            role for weighting the setup observations in the adjustment.
        default_sd_mugal : float, optional (default=100.0)
            Default standard deviation [µGal] that is used to determine the SD of setup observations when `method_sd` is
            `sd_default_per_obs` or `sd_default_per_setup`
        verbose : bool, optional (default=False)
            If `True`, status messages are printed to the command line.
        """

        if verbose:
            print(f'Calculate setup data for survey {self.name}')

        _VALID_OBS_TYPES = ('observed', 'reduced',)
        flag_calculate_delta_t_campaign_h = False

        self.reset_setup_data(verbose)

        # Initial checks:
        if obs_type not in _VALID_OBS_TYPES:
            raise AssertionError(f'Invalid observation type: {obs_type} (valid: "reduced" or "observed").')
        if method not in SETUP_CALC_METHODS:
            raise AssertionError(f'Invalid method: {method} (valid: "variance_weighted_mean" or "individual_obs").')
        if self.obs_df is None:
            raise AssertionError('Observation dataframe is empty!')

        # Get all active observations:
        tmp_filter = self.obs_df['keep_obs']
        active_obs_df = self.obs_df[tmp_filter].copy(deep=True)

        # Modify SD according to input options:
        if method_sd == 'sd_from_obs_file':
            pass  # keep SD
        elif method_sd == 'sd_default_per_obs':
            if verbose:
                print(f'Use default SD of {default_sd_mugal} µGal for weighting observations instead of SD from '
                      f'observation files.')
            active_obs_df['sd_g_red_mugal'] = default_sd_mugal
            active_obs_df['sd_g_obs_mugal'] = default_sd_mugal

        # Check, if at least one observation is active:
        if len(active_obs_df) == 0:
            if verbose:
                print(f'No active observations in survey {self.name}')
        else:

            # Check, if reduced data is available:
            if obs_type == 'reduced':
                if active_obs_df['g_red_mugal'].isnull().any() or active_obs_df['sd_g_red_mugal'].isnull().any():
                    raise AssertionError('Reduced observations (g and sd) are missing!')

            # Check input
            if ref_delta_t_campaign_dt is None:  # No reference time for the campaign defined
                flag_calculate_delta_t_campaign_h = False
            elif isinstance(ref_delta_t_campaign_dt, dt.datetime):  # Input is OK!
                flag_calculate_delta_t_campaign_h = True
            else:
                raise TypeError('`ref_delta_t_campaign_dt` needs to be a datetime object!')
            # - SD == 0? => This would create a divided by zero error!
            if obs_type == 'reduced':
                tmp_filter = active_obs_df['sd_g_red_mugal'] <= 0.0
            elif obs_type == 'observed':
                tmp_filter = active_obs_df['sd_g_obs_mugal'] <= 0.0
            if tmp_filter.any():
                error_str = active_obs_df.loc[tmp_filter, ['station_name', 'obs_epoch']].to_string()
                raise AssertionError(f'The SD of the following observations ({obs_type}) in the survey {self.name}'
                                     f' is <= 0.0 µGal (invalid!):\n{error_str}')

            # Determine reference time for the survey:
            if active_obs_only_for_ref_epoch:
                ref_delta_t_dt = active_obs_df['obs_epoch'].min()  # First observation epoch in survey (active only)
            else:
                ref_delta_t_dt = self.obs_df['obs_epoch'].min()  # First observation epoch (also inactive obs)

            dist_m = gravimeters.get_height_offset(self.gravimeter_type, self.gravimeter_serial_number)

            # Loop over setups:
            if method == 'variance_weighted_mean':
                # Initialize columns lists for creating dataframe:
                station_name_list = []
                setup_id_list = []
                g_mugal_list = []
                sd_g_red_mugal_list = []
                obs_epoch_list_unix = []
                obs_epoch_list_dt = []
                delta_t_h_list = []
                delta_t_campaign_h_list = []
                sd_setup_mugal_list = []
                number_obs_list = []
                dhf_sensor_m_list = []
                linear_scale_list = []

                setup_ids = active_obs_df['setup_id'].unique()
                for setup_id in setup_ids:
                    tmp_filter = active_obs_df['setup_id'] == setup_id
                    if obs_type == 'observed':
                        g_mugal = active_obs_df.loc[tmp_filter, 'g_obs_mugal'].to_numpy()
                        sd_g_mugal = active_obs_df.loc[tmp_filter, 'sd_g_obs_mugal'].to_numpy()
                    elif obs_type == 'reduced':
                        g_mugal = active_obs_df.loc[tmp_filter, 'g_red_mugal'].to_numpy()
                        sd_g_mugal = active_obs_df.loc[tmp_filter, 'sd_g_red_mugal'].to_numpy()
                    weights = 1 / sd_g_mugal ** 2
                    g_setup_mugal = np.sum(g_mugal * weights) / np.sum(weights)
                    sd_g_setup_mugal = np.sqrt(1 / np.sum(weights))
                    if len(active_obs_df.loc[tmp_filter, 'station_name'].unique()) > 1:
                        raise AssertionError(
                            f'Setup with ID "{setup_id}" in survey "{self.name}" contains '
                            f'{len(active_obs_df.loc[tmp_filter, "station_name"].unique())} stations (only 1 allowed)!'
                        )

                    # Standard deviation of active observations within setup:
                    # - If less than 2 active observations in setup => Calculation not possible => NaN
                    if len(g_mugal) >= 2:
                        sd_setup_mugal_list.append(g_mugal.std(ddof=1))  # degree of freedom = (len(g_mugal) - 1)
                    else:
                        sd_setup_mugal_list.append(np.nan)

                    number_obs_list.append(len(g_mugal))  # Number of observations

                    # Get vertical distance between sensor height and control point:
                    dhf_sensor_m_list.append(active_obs_df.loc[tmp_filter, 'dhf_m'].values[0] + dist_m)

                    # Get linear scale factor
                    unique_linear_scale_factor_of_setup = active_obs_df.loc[tmp_filter, 'linear_scale'].unique()
                    # - Check whether a single scale factor was used for the setup:
                    if unique_linear_scale_factor_of_setup.shape[0] == 1:
                        linear_scale_list.append(unique_linear_scale_factor_of_setup[0])
                    else:
                        linear_scale_list.append(np.nan)
                        if verbose:
                            print(
                                f'WARNING: In setup {setup_id} of survey {self.name} the linear scale factor is not unique!')

                    # observation epoch (UNIX timestamps in full seconds):
                    obs_epochs_series = active_obs_df.loc[tmp_filter, 'obs_epoch']
                    unix_obs_epochs = to_unix_seconds(obs_epochs_series)
                    unix_setup_epoch = np.sum(unix_obs_epochs * weights) / np.sum(weights)

                    # Reference epoch as datetime object (TZ=<UTC>):
                    dt_setup_epoch = dt.datetime.utcfromtimestamp(unix_setup_epoch)
                    dt_setup_epoch = dt_setup_epoch.replace(tzinfo=dt.timezone.utc)  # TZ = <UTC>

                    station_name_list.append(active_obs_df.loc[tmp_filter, 'station_name'].unique()[0])
                    setup_id_list.append(setup_id)
                    g_mugal_list.append(g_setup_mugal)
                    sd_g_red_mugal_list.append(sd_g_setup_mugal)
                    obs_epoch_list_unix.append(unix_setup_epoch)
                    obs_epoch_list_dt.append(dt_setup_epoch)
                    delta_t_h_list.append((unix_setup_epoch - ref_delta_t_dt.timestamp()) / 3600.0)
                    if flag_calculate_delta_t_campaign_h:
                        delta_t_campaign_h_list.append(
                            (unix_setup_epoch - ref_delta_t_campaign_dt.timestamp()) / 3600.0)
                    else:
                        delta_t_campaign_h_list.append(None)
            elif method == 'individual_obs':
                station_name_list = active_obs_df['station_name'].to_list()
                setup_id_list = active_obs_df['setup_id'].to_list()
                if obs_type == 'observed':
                    g_mugal_list = active_obs_df['g_obs_mugal'].to_list()
                    sd_g_red_mugal_list = active_obs_df['sd_g_obs_mugal'].to_list()
                elif obs_type == 'reduced':
                    g_mugal_list = active_obs_df['g_red_mugal'].to_list()
                    sd_g_red_mugal_list = active_obs_df['sd_g_red_mugal'].to_list()

                obs_epoch_unix_array = to_unix_seconds(active_obs_df['obs_epoch'])
                obs_epoch_list_unix = list(obs_epoch_unix_array)
                obs_epoch_list_dt = pd.to_datetime(obs_epoch_unix_array, unit='s').tz_localize('utc').to_list()

                delta_t_h_list = list((obs_epoch_unix_array - ref_delta_t_dt.timestamp()) / 3600.0)
                if flag_calculate_delta_t_campaign_h:
                    delta_t_campaign_h_list = list(
                        (obs_epoch_unix_array - ref_delta_t_campaign_dt.timestamp()) / 3600.0)
                else:
                    delta_t_campaign_h_list = [None] * len(g_mugal_list)
                sd_setup_mugal_list = [np.nan] * len(g_mugal_list)
                number_obs_list = [1] * len(g_mugal_list)
                dhf_sensor_m_list = active_obs_df['dhf_m'] + dist_m

            if obs_type == 'observed':
                self.setup_tide_correction_type = self.obs_tide_correction_type
                self.setup_reference_height_type = self.obs_reference_height_type
                self.setup_atm_pres_correction_type = self.obs_atm_pres_correction_type
                self.setup_scale_correction_type = self.obs_scale_correction_type
                self.setup_oceanload_correction_type = self.obs_oceanload_correction_type
            elif obs_type == 'reduced':
                self.setup_tide_correction_type = self.red_tide_correction_type
                self.setup_reference_height_type = self.red_reference_height_type
                self.setup_atm_pres_correction_type = self.red_atm_pres_correction_type
                self.setup_scale_correction_type = self.red_scale_correction_type
                self.setup_oceanload_correction_type = self.red_oceanload_correction_type
            self.setup_calc_method = method
            self.setup_sd_method = method_sd
            self.create_setup_obs_list()

            if method_sd == 'sd_default_per_setup':
                if verbose:
                    print(f'Use a default SD of {default_sd_mugal} µGal for all setup observations.')
                sd_g_red_mugal_list = [default_sd_mugal for item in sd_g_red_mugal_list]

            # convert to pd dataframe:
            self.setup_df = pd.DataFrame(list(zip(station_name_list,
                                                  setup_id_list,
                                                  g_mugal_list,
                                                  sd_g_red_mugal_list,
                                                  obs_epoch_list_unix,
                                                  obs_epoch_list_dt,
                                                  delta_t_h_list,
                                                  delta_t_campaign_h_list,
                                                  sd_setup_mugal_list,
                                                  number_obs_list,
                                                  dhf_sensor_m_list,
                                                  linear_scale_list)),
                                         columns=self._SETUP_DF_COLUMNS)
            self.set_reference_time(ref_delta_t_dt)  # Save reference time for `delta_t_h`, i.e. for the survey.

    def calc_drift_at_station_polyfit(self, station_name: str, degree: int = 1, obs_type: str = 'reduced', active_only: bool = True, min_number_obs: int = 1):
        """Calculate the instrumental drift based on observations at a given station using `numpy.polyfit`.

        Parameters
        ----------
        station_name : str
            Name of the station.
        degree : int, optional (default=1)
            Degree of the drift polynomial to be fitted to the observations. The degree has to be in the range between 1
             and 3.
        obs_type : str, optional, `reduced` or `observed` (default=`reduced`)
            Either used reduced observations of the originals values as observed for fitting the drfit polynomial.
        active_only : bool, optional (default=`True`)
            `True` implies that only active observations are considered.
        min_number_obs : int, optional (default=1)
            Minimum number of observations. If less observations are available, no polynomial is fitted and None is
            returned.

        Returns
        -------
        numpy.ndarray : Polynomial coefficients as determined by `numpy.polyfit`, highest power first
        """
        tmp_filter = self.obs_df['station_name'] == station_name
        if active_only:
            tmp_filter = tmp_filter & self.obs_df['keep_obs']
        obs_df_stat = self.obs_df.loc[tmp_filter].copy(deep=True)
        if len(obs_df_stat) < min_number_obs:
            return None
        obs_df_stat['hours_since_start'] = (obs_df_stat['obs_epoch'] - self.start_time) / np.timedelta64(1, 's') / 3600
        if obs_type == 'reduced':
            g_mugal = obs_df_stat['g_red_mugal'].astype(float).values
        elif obs_type == 'observed':
            g_mugal = obs_df_stat['g_obs_mugal'].astype(float).values
        else:
            raise RuntimeError(f'Unknown observation type: {obs_type}')
        t_h = obs_df_stat['hours_since_start'].values
        return np.polyfit(t_h, g_mugal, degree)

    def create_setup_obs_list(self):
        """Create list of all observations that contribute to the calculation of setup data in this Survey object.

        The list is created as pandas dataframe. It holds information whether an observation in the `obs_df` is
        active or inactive (`keep_obs` flag).
        """
        self.setup_obs_list_df = self.obs_df.loc[:, self._SETUP_OBS_LIST_DF_COLUMNS].copy(deep=True)

    @property
    def number_of_setups(self):
        """Returns the number of setups in the survey"""
        if self.obs_df is not None:
            return len(self.obs_df['setup_id'].unique())
        else:
            return None

    @property
    def number_of_observations(self):
        """Returns the total number of observations in the survey"""
        if self.obs_df is not None:
            return len(self.obs_df)
        else:
            return None

    @property
    def number_of_active_observations(self):
        """Returns the number of active observations in the survey"""
        if self.obs_df is not None:
            return len(self.obs_df[self.obs_df['keep_obs']])
        else:
            return None

    @property
    def start_time(self):
        """Returns datetime of the first observation in the survey."""
        if self.obs_df is not None:
            return self.obs_df['obs_epoch'].min()
        else:
            return None

    @property
    def start_time_hhmmss_str(self):
        """Returns the time of the first observation in hh:mm:ss format as string."""
        if self.obs_df is not None:
            return self.obs_df['obs_epoch'].min().strftime('%H:%M:%S')
        else:
            return ''

    @property
    def end_time(self):
        """Returns datetime of the last observation in the survey."""
        if self.obs_df is not None:
            return self.obs_df['obs_epoch'].max()
        else:
            return None

    @property
    def end_time_hhmmss_str(self):
        """Returns the time of the last observation in hh:mm:ss format as string."""
        if self.obs_df is not None:
            return self.obs_df['obs_epoch'].max().strftime('%H:%M:%S')
        else:
            return ''

    @property
    def duration_hhmmss_str(self):
        """Returns the timespan (Timedelta) between first and last observation in the survey in hh:mm:ss format."""
        if self.obs_df is not None:
            duration = self.obs_df['obs_epoch'].max() - self.obs_df['obs_epoch'].min()
            if duration.days == 0:
                return format_seconds_to_hhmmss(duration.seconds)
            else:
                return f'{duration.days}d ' + format_seconds_to_hhmmss(duration.seconds)
        else:
            return ''

    @property
    def is_active(self):
        """`True` indicates that the survey contains at least one active observation."""
        if self.obs_df is not None:
            return self.obs_df['keep_obs'].any()
        else:
            return False

    @property
    def observed_stations(self):
        """Returns a list of all stations observed in this survey."""
        if self.obs_df is not None:
            return self.obs_df['station_name'].unique().tolist()
        else:
            return None

    @property
    def observed_stations_str(self):
        """Returns a string with a list of all stations observed in this survey."""
        if self.obs_df is not None:
            return f', '.join(self.observed_stations)
        else:
            return None

duration_hhmmss_str property

Returns the timespan (Timedelta) between first and last observation in the survey in hh:mm:ss format.

end_time property

Returns datetime of the last observation in the survey.

end_time_hhmmss_str property

Returns the time of the last observation in hh:mm:ss format as string.

is_active property

True indicates that the survey contains at least one active observation.

number_of_active_observations property

Returns the number of active observations in the survey

number_of_observations property

Returns the total number of observations in the survey

number_of_setups property

Returns the number of setups in the survey

observed_stations property

Returns a list of all stations observed in this survey.

observed_stations_str property

Returns a string with a list of all stations observed in this survey.

start_time property

Returns datetime of the first observation in the survey.

start_time_hhmmss_str property

Returns the time of the first observation in hh:mm:ss format as string.

__init__(name, date=None, operator='', institution='', gravimeter_serial_number='', gravimeter_type='', data_file_name='', data_file_type='', obs_df=None, obs_tide_correction_type='', obs_reference_height_type='', obs_atm_pres_correction_type='', obs_scale_correction_type='', obs_oceanload_correction_type='', red_tide_correction_type='', red_reference_height_type='', red_atm_pres_correction_type='', red_scale_correction_type='', red_oceanload_correction_type='', red_tide_correction_description='', red_tide_corr_timeseries_interpol_method='', red_tide_corr_timeseries_creation_dt=None, setup_tide_correction_type='', setup_reference_height_type='', setup_atm_pres_correction_type='', setup_scale_correction_type='', setup_oceanload_correction_type='', setup_calc_method='', setup_sd_method='', keep_survey=True, setup_df=None, ref_delta_t_dt=None, setup_obs_list_df=None)

Default constructor of class Survey.

Source code in gravtools/models/survey.py 
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
def __init__(self,
             name,
             date=None,
             operator='',
             institution='',
             gravimeter_serial_number='',
             gravimeter_type='',
             data_file_name='',
             data_file_type='',
             obs_df=None,
             obs_tide_correction_type='',  # of "g_obs_mugal"
             obs_reference_height_type='',  # of "g_obs_mugal"
             obs_atm_pres_correction_type='',  # of "g_obs_mugal"
             obs_scale_correction_type='',  # of "g_obs_mugal"
             obs_oceanload_correction_type='',  # of "g_obs_mugal"
             red_tide_correction_type='',  # of "g_red_mugal"
             red_reference_height_type='',  # of "g_red_mugal"
             red_atm_pres_correction_type='',  # of "g_red_mugal"
             red_scale_correction_type='',  # of "g_red_mugal"
             red_oceanload_correction_type='',  # of "g_red_mugal"
             red_tide_correction_description='',  # of "g_red_mugal"
             red_tide_corr_timeseries_interpol_method='',  # of "g_red_mugal"
             red_tide_corr_timeseries_creation_dt=None,  # of "g_red_mugal"
             setup_tide_correction_type='',
             setup_reference_height_type='',
             setup_atm_pres_correction_type='',
             setup_scale_correction_type='',
             setup_oceanload_correction_type='',
             setup_calc_method='',
             setup_sd_method='',
             keep_survey=True,  # Flag
             setup_df=None,
             ref_delta_t_dt=None,  # Datetime object (UTC)
             setup_obs_list_df=None  #
             ):
    """Default constructor of class Survey."""

    # Check input arguments:
    # name:
    if name is not None:
        if isinstance(name, str):
            if len(name) > 0:
                self.name = name
            else:
                raise ValueError('"name" needs to be a non-empty string')
        else:
            raise TypeError('"name" needs to be a non-empty string')

    # date:
    if date is not None:
        if isinstance(date, dt.date):
            self.date = date
        else:
            raise TypeError('"date" needs to be a datetime object')
    else:
        self.date = date  # None

    # operator:
    if isinstance(operator, str):
        self.operator = operator
    else:
        raise TypeError('"operator" needs to be a string')

    # institution:
    if isinstance(institution, str):
        self.institution = institution
    else:
        raise TypeError('"institution" needs to be a string')

    # gravimeter_serial_number:
    if isinstance(gravimeter_serial_number, str):
        self.gravimeter_serial_number = gravimeter_serial_number
    else:
        raise TypeError('"gravimeter_serial_number" needs to be a string')

    # gravimeter_type:
    if isinstance(gravimeter_type, str):
        if gravimeter_type:
            if gravimeter_type in GRAVIMETER_TYPES.keys():
                self.gravimeter_type = gravimeter_type
            else:
                raise ValueError('"gravimeter_type" needs to be a key in GRAVIMETER_TYPES')
        else:
            self.gravimeter_type = gravimeter_type  # ''
    else:
        raise TypeError('"gravimeter_type" needs to be a string')

    # data_file_name:
    if isinstance(data_file_name, str):
        self.data_file_name = data_file_name
    else:
        raise TypeError('"data_file_name" needs to be a string')

    # data_file_type:
    if isinstance(data_file_type, str):
        if data_file_type:
            if data_file_type in SURVEY_DATA_SOURCE_TYPES.keys():
                self.data_file_type = data_file_type
            else:
                raise ValueError('"data_file_type" needs to be a key in SURVEY_DATA_SOURCE_TYPES')
        else:
            if self.data_file_name:  # Not empty
                raise ValueError('If a data file is specified ("data_file_name" not empty), "data_file_type" has '
                                 'to be specified also.')
            self.data_file_type = data_file_type
    else:
        raise TypeError('"data_file_type" needs to be a string')

    # obs_df:
    if obs_df is not None:
        if isinstance(obs_df, pd.DataFrame):
            # Check if obs_df contains exactly all columns defined by self._OBS_DF_COLUMNS:
            if all([item for item in obs_df.columns.isin(self._OBS_DF_COLUMNS)]) and \
                    obs_df.shape[1] == len(self._OBS_DF_COLUMNS):
                self.obs_df = obs_df
            else:
                raise ValueError('"obs_df" needs the following columns:{}'.format(', '.join(self._OBS_DF_COLUMNS)))
        else:
            raise TypeError('"obs_df" needs to be a pandas DataFrame.')
    else:
        self.obs_df = obs_df  # None

    # obs_tide_correction_type:
    if isinstance(obs_tide_correction_type, str):
        if obs_tide_correction_type:
            if obs_tide_correction_type in TIDE_CORRECTION_TYPES.keys():
                self.obs_tide_correction_type = obs_tide_correction_type
            else:
                raise ValueError('"obs_tide_correction_type" needs to be a key in TIDE_CORRECTION_TYPES '
                                 '({})'.format(', '.join(TIDE_CORRECTION_TYPES.keys())))
        else:
            self.obs_tide_correction_type = obs_tide_correction_type  # None
    else:
        raise TypeError('"obs_tide_correction_type" needs to be a string')

    # red_tide_correction_type
    if isinstance(red_tide_correction_type, str):
        if red_tide_correction_type:
            if red_tide_correction_type in TIDE_CORRECTION_TYPES.keys():
                self.red_tide_correction_type = red_tide_correction_type
            else:
                raise ValueError('"red_tide_correction_type" needs to be a key in TIDE_CORRECTION_TYPES '
                                 '({})'.format(', '.join(TIDE_CORRECTION_TYPES.keys())))
        else:
            self.red_tide_correction_type = red_tide_correction_type  # None
    else:
        raise TypeError('"red_tide_correction_type" needs to be a string')

    # obs_reference_height_type:
    if isinstance(obs_reference_height_type, str):
        if obs_reference_height_type:
            if obs_reference_height_type in REFERENCE_HEIGHT_TYPE.keys():
                self.obs_reference_height_type = obs_reference_height_type
            else:
                raise ValueError('"obs_reference_height_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                 '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
        else:
            self.obs_reference_height_type = obs_reference_height_type  # None
    else:
        raise TypeError('"obs_reference_height_type" needs to be a string')

    # red_reference_height_type:
    if isinstance(red_reference_height_type, str):
        if red_reference_height_type:
            if red_reference_height_type in REFERENCE_HEIGHT_TYPE.keys():
                self.red_reference_height_type = red_reference_height_type
            else:
                raise ValueError('"red_reference_height_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                 '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
        else:
            self.red_reference_height_type = red_reference_height_type  # None
    else:
        raise TypeError('"red_reference_height_type" needs to be a string')

    # red_tide_correction_description
    if isinstance(red_tide_correction_description, str):
        self.red_tide_correction_description = red_tide_correction_description
    else:
        raise TypeError('"red_tide_correction_description" needs to be a string')

    # red_tide_corr_timeseries_interpol_method
    if isinstance(red_tide_corr_timeseries_interpol_method, str):
        self.red_tide_corr_timeseries_interpol_method = red_tide_corr_timeseries_interpol_method
    else:
        raise TypeError('"red_tide_corr_timeseries_interpol_method" needs to be a string')

    # red_tide_corr_timeseries_creation_dt
    if red_tide_corr_timeseries_creation_dt is not None:
        if not isinstance(red_tide_corr_timeseries_creation_dt, dt.datetime):
            raise TypeError('`red_tide_corr_timeseries_creation_dt` needs to be a datetime object.')
    self.red_tide_corr_timeseries_creation_dt = red_tide_corr_timeseries_creation_dt

    # obs_atm_pres_correction_type
    if isinstance(obs_atm_pres_correction_type, str):
        if obs_atm_pres_correction_type:
            if obs_atm_pres_correction_type in ATM_PRES_CORRECTION_TYPES.keys():
                self.obs_atm_pres_correction_type = obs_atm_pres_correction_type
            else:
                raise ValueError('"obs_atm_pres_correction_type" needs to be a key in ATM_PRES_CORRECTION_TYPES '
                                 '({})'.format(', '.join(ATM_PRES_CORRECTION_TYPES.keys())))
        else:
            self.obs_atm_pres_correction_type = obs_atm_pres_correction_type  # None
    else:
        raise TypeError('"obs_atm_pres_correction_type" needs to be a string')

    # red_atm_pres_correction_type
    if isinstance(red_atm_pres_correction_type, str):
        if red_atm_pres_correction_type:
            if red_atm_pres_correction_type in ATM_PRES_CORRECTION_TYPES.keys():
                self.red_atm_pres_correction_type = red_atm_pres_correction_type
            else:
                raise ValueError('"red_atm_pres_correction_type" needs to be a key in ATM_PRES_CORRECTION_TYPES '
                                 '({})'.format(', '.join(ATM_PRES_CORRECTION_TYPES.keys())))
        else:
            self.red_atm_pres_correction_type = red_atm_pres_correction_type  # None
    else:
        raise TypeError('"red_atm_pres_correction_type" needs to be a string')

    # obs_scale_correction_type
    if isinstance(obs_scale_correction_type, str):
        if obs_scale_correction_type:
            if obs_scale_correction_type in SCALE_CORRECTION_TYPES.keys():
                self.obs_scale_correction_type = obs_scale_correction_type
            else:
                raise ValueError(
                    '"obs_scale_correction_type" needs to be a key in SCALE_CORRECTION_TYPES '
                    '({})'.format(', '.join(SCALE_CORRECTION_TYPES.keys())))
        else:
            self.obs_scale_correction_type = obs_scale_correction_type  # None
    else:
        raise TypeError('"obs_scale_correction_type" needs to be a string')

    # red_scale_correction_type
    if isinstance(red_scale_correction_type, str):
        if red_scale_correction_type:
            if red_scale_correction_type in SCALE_CORRECTION_TYPES.keys():
                self.red_scale_correction_type = red_scale_correction_type
            else:
                raise ValueError(
                    '"red_scale_correction_type" needs to be a key in SCALE_CORRECTION_TYPES '
                    '({})'.format(', '.join(SCALE_CORRECTION_TYPES.keys())))
        else:
            self.red_scale_correction_type = red_scale_correction_type  # None
    else:
        raise TypeError('"red_scale_correction_type" needs to be a string')

    # obs_oceanload_correction_type
    if isinstance(obs_oceanload_correction_type, str):
        if obs_oceanload_correction_type:
            if obs_oceanload_correction_type in OCEANLOAD_CORRECTION_TYPES.keys():
                self.obs_oceanload_correction_type = obs_oceanload_correction_type
            else:
                raise ValueError(
                    '"obs_oceanload_correction_type" needs to be a key in OCEANLOAD_CORRECTION_TYPES '
                    '({})'.format(', '.join(OCEANLOAD_CORRECTION_TYPES.keys())))
        else:
            self.obs_oceanload_correction_type = obs_oceanload_correction_type  # ''
    else:
        raise TypeError('"obs_oceanload_correction_type" needs to be a string')

    # red_oceanload_correction_type
    if isinstance(red_oceanload_correction_type, str):
        if red_oceanload_correction_type:
            if red_oceanload_correction_type in OCEANLOAD_CORRECTION_TYPES.keys():
                self.red_oceanload_correction_type = red_oceanload_correction_type
            else:
                raise ValueError(
                    '"red_oceanload_correction_type" needs to be a key in OCEANLOAD_CORRECTION_TYPES '
                    '({})'.format(', '.join(OCEANLOAD_CORRECTION_TYPES.keys())))
        else:
            self.red_oceanload_correction_type = red_oceanload_correction_type  # ''
    else:
        raise TypeError('"red_oceanload_correction_type" needs to be a string')

    # setup_tide_correction_type:
    if isinstance(setup_tide_correction_type, str):
        if setup_tide_correction_type:
            if setup_tide_correction_type in REFERENCE_HEIGHT_TYPE.keys():
                self.setup_tide_correction_type = setup_tide_correction_type
            else:
                raise ValueError('"setup_tide_correction_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                 '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
        else:
            self.setup_tide_correction_type = setup_tide_correction_type  # ''
    else:
        raise TypeError('"setup_tide_correction_type" needs to be a string')

    # setup_reference_height_type:
    if isinstance(setup_reference_height_type, str):
        if setup_reference_height_type:
            if setup_reference_height_type in REFERENCE_HEIGHT_TYPE.keys():
                self.setup_reference_height_type = setup_reference_height_type
            else:
                raise ValueError('"setup_reference_height_type" needs to be a key in REFERENCE_HEIGHT_TYPE '
                                 '({})'.format(', '.join(REFERENCE_HEIGHT_TYPE.keys())))
        else:
            self.setup_reference_height_type = setup_reference_height_type  # ''
    else:
        raise TypeError('"setup_reference_height_type" needs to be a string')

    # setup_atm_pres_correction_type:
    if isinstance(setup_atm_pres_correction_type, str):
        if setup_atm_pres_correction_type:
            if setup_atm_pres_correction_type in ATM_PRES_CORRECTION_TYPES.keys():
                self.setup_atm_pres_correction_type = setup_atm_pres_correction_type
            else:
                raise ValueError('"setup_atm_pres_correction_type" needs to be a key in ATM_PRES_CORRECTION_TYPES '
                                 '({})'.format(', '.join(ATM_PRES_CORRECTION_TYPES.keys())))
        else:
            self.setup_atm_pres_correction_type = setup_atm_pres_correction_type  # ''
    else:
        raise TypeError('"setup_atm_pres_correction_type" needs to be a string')

    # setup_scale_correction_type:
    if isinstance(setup_scale_correction_type, str):
        if setup_scale_correction_type:
            if setup_scale_correction_type in SCALE_CORRECTION_TYPES.keys():
                self.setup_scale_correction_type = setup_scale_correction_type
            else:
                raise ValueError(
                    '"setup_scale_correction_type" needs to be a key in SCALE_CORRECTION_TYPES '
                    '({})'.format(', '.join(SCALE_CORRECTION_TYPES.keys())))
        else:
            self.setup_scale_correction_type = setup_scale_correction_type  # ''
    else:
        raise TypeError('"setup_scale_correction_type" needs to be a string')

    # setup_oceanload_correction_type:
    if isinstance(setup_oceanload_correction_type, str):
        if setup_oceanload_correction_type:
            if setup_oceanload_correction_type in OCEANLOAD_CORRECTION_TYPES.keys():
                self.setup_oceanload_correction_type = setup_oceanload_correction_type
            else:
                raise ValueError(
                    '"setup_oceanload_correction_type" needs to be a key in OCEANLOAD_CORRECTION_TYPES '
                    '({})'.format(', '.join(OCEANLOAD_CORRECTION_TYPES.keys())))
        else:
            self.setup_oceanload_correction_type = setup_oceanload_correction_type  # ''
    else:
        raise TypeError('"setup_oceanload_correction_type" needs to be a string')

    # setup_calc_method:
    if isinstance(setup_calc_method, str):
        if setup_calc_method:
            if setup_calc_method in SETUP_CALC_METHODS.keys():
                self.setup_calc_method = setup_calc_method
            else:
                raise ValueError('"setup_calc_method" needs to be a key in SETUP_CALC_METHODS '
                                 '({})'.format(', '.join(SETUP_CALC_METHODS.keys())))
        else:
            self.setup_calc_method = setup_calc_method  # ''
    else:
        raise TypeError('"setup_calc_method" needs to be a string')

    # setup_sd_method:
    if isinstance(setup_sd_method, str):
        if setup_sd_method:
            if setup_sd_method in SETUP_SD_METHODS.keys():
                self.setup_sd_method = setup_sd_method
            else:
                raise ValueError('"setup_sd_method" needs to be a key in SETUP_SD_METHODS '
                                 '({})'.format(', '.join(SETUP_SD_METHODS.keys())))
        else:
            self.setup_sd_method = setup_sd_method  # ''
    else:
        raise TypeError('"setup_sd_method" needs to be a string')

    # keep_survey
    if isinstance(keep_survey, bool):
        self.keep_survey = keep_survey
    else:
        raise TypeError('"keep_survey" needs to be a bool type.')

    # setup_df:
    if setup_df is not None:
        if isinstance(setup_df, pd.DataFrame):
            # Check if setup_df contains exactly all columns defined by self._SETUP_DF_COLUMNS:
            if all([item for item in obs_df.columns.isin(self._SETUP_DF_COLUMNS)]) and \
                    obs_df.shape[1] == len(self._SETUP_DF_COLUMNS):
                self.setup_df = setup_df
            else:
                raise ValueError(
                    '"setup_df" needs the following columns:{}'.format(', '.join(self._SETUP_DF_COLUMNS)))
        else:
            raise TypeError('"setup_df" needs to be a pandas DataFrame.')
    else:
        self.setup_df = setup_df  # None

    if ref_delta_t_dt is not None:
        if not isinstance(ref_delta_t_dt, dt.datetime):
            raise TypeError('`ref_delta_t_dt` needs to be a datetime object.')
    self.ref_delta_t_dt = ref_delta_t_dt

    # setup_obs_list_df:
    if setup_obs_list_df is not None:
        if isinstance(setup_obs_list_df, pd.DataFrame):
            # Check if setup_df contains exactly all columns defined by self._SETUP_DF_COLUMNS:
            if all([item for item in obs_df.columns.isin(self._SETUP_OBS_LIST_DF_COLUMNS)]) and \
                    obs_df.shape[1] == len(self._SETUP_OBS_LIST_DF_COLUMNS):
                self.setup_obs_list_df = setup_obs_list_df
            else:
                raise ValueError(
                    '"setup_obs_list_df" needs the following columns:{}'.format(
                        ', '.join(self._SETUP_OBS_LIST_DF_COLUMNS)))
        else:
            raise TypeError('"setup_obs_list_df" needs to be a pandas DataFrame.')
    else:
        self.setup_obs_list_df = setup_obs_list_df  # None

activate_observation(obs_idx, flag_activate)

Activate or deactivate teh observation with the specified dataframe index.

Parameters:

Name Type Description Default
obs_idx int

Index of the observation within the observation dataframe (obs_df) that will be activated or deactivated.

 required
flag_activate bool

Specified whether the observation with the index obs_idx will be activated (TRUE) or deactivated (False).

 required
Source code in gravtools/models/survey.py 
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
def activate_observation(self, obs_idx, flag_activate):
    """Activate or deactivate teh observation with the specified dataframe index.

    Parameters
    ----------
    obs_idx : int
        Index of the observation within the observation dataframe (`obs_df`) that will be activated or deactivated.
    flag_activate : bool
        Specified whether the observation with the index `obs_idx` will be activated (`TRUE`) or deactivated
        (`False`).
    """
    self.obs_df.at[obs_idx, 'keep_obs'] = flag_activate

activate_setup(setup_id, flag_activate)

Activate or deactivate instrument setup with the specified ID.

Parameters:

Name Type Description Default
setup_id int

ID of the setup that will be activated or deactivated.

 required
flag_activate bool

Specified whether the setup with the ID setup_id will be activated (TRUE) or deactivated (False).

 required
Source code in gravtools/models/survey.py 
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
def activate_setup(self, setup_id, flag_activate):
    """Activate or deactivate instrument setup with the specified ID.

    Parameters
    ----------
    setup_id : int
        ID of the setup that will be activated or deactivated.
    flag_activate : bool
        Specified whether the setup with the ID `setup_id` will be activated (`TRUE`) or deactivated (`False`).
    """
    if not isinstance(flag_activate, bool):
        raise TypeError('"flag_activate" has to be a boolean variable!')
    self.obs_df.loc[self.obs_df['setup_id'] == setup_id, 'keep_obs'] = flag_activate

autselect_delta_g(threshold_mugal, n_obs=3, obs_type='reduced', setup_id=None, verbose=False)

Deactivate observations based ob the deviation of the stabilized gravity at a setup.

Notes

If a setup consists of less than n_obs observations, this autoselection function is not applied.

Parameters:

Name Type Description Default
threshold_mugal int

Observations in this survey or the specified setup are deactivated, if the observed or the reduced gravity (columns sd_g_obs_mugal or sd_g_red_mugal in :py:obj:.Survey.obs_df) deviates from the stabilized gravity at the setup by more than the given threshold. The stabilized gravity at a setup is calculated as the mean (observed or reduced) gravity of the last n_obs observations in a setup.

 required
n_obs (int, optional(default=3))

Number of observations at the end of a setup that are used to calculate the stabilized gravity as reference for deactivating observations.

 3
obs_type (str, observed or reduced(default))

Defines whether the observed (as loaded from an observation file) or the reduced observations are used as reference for this autoselection function.

 'reduced'
setup_id (int, optional(default=None))

None implies that this autoselection function is applied on all setup of this survey. Otherwise, the autoselection function is only applied on observations of the setup with the provided ID (setup_id).

 None
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False

Returns:

Name Type Description
bool Error indicator.

False, if at least one standard deviation value is None is case, reduced observations are usd as reference.
Source code in gravtools/models/survey.py 
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
def autselect_delta_g(self, threshold_mugal: int, n_obs: int = 3, obs_type: str = 'reduced', setup_id: int = None,
                      verbose: bool = False):
    """Deactivate observations based ob the deviation of the stabilized gravity at a setup.

    Notes
    -----
    If a setup consists of less than `n_obs` observations, this autoselection function is not applied.


    Parameters
    ----------
    threshold_mugal : int
        Observations in this survey or the specified setup are deactivated, if the observed or the reduced gravity
        (columns `sd_g_obs_mugal` or `sd_g_red_mugal` in :py:obj:`.Survey.obs_df`) deviates from the stabilized
        gravity at the setup by more than the given threshold. The stabilized gravity at a setup is calculated as
        the mean (observed or reduced) gravity of the last `n_obs` observations in a setup.
    n_obs : int, optional (default=3)
        Number of observations at the end of a setup that are used to calculate the stabilized gravity as reference
        for deactivating observations.
    obs_type : str, 'observed' or 'reduced' (default)
        Defines whether the observed (as loaded from an observation file) or the reduced observations are used as
        reference for this autoselection function.
    setup_id : int, optional (default=None)
        `None` implies that this autoselection function is applied on all setup of this survey. Otherwise,
        the autoselection function is only applied on observations of the setup with the provided ID (`setup_id`).
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.

    Returns
    -------
    bool : Error indicator.
        `False`, if at least one standard deviation value is `None` is case, reduced observations are usd as
        reference.
    """
    # TODO: Check, if it makes sense to keep the last n_obs observations anyway (even if they do not meet the
    #  conditions here)! Check if reduced observations are available, if required:
    if obs_type == 'reduced':
        if self.obs_df['g_red_mugal'].isna().any():
            if verbose:
                print('ERROR: At least one value in column "g_red_mugal" is None.')
            return False

    # Get list of IDs of all setups that will be handled:
    if setup_id is None:
        setup_ids = self.get_setup_ids()
    else:
        setup_ids = [setup_id]

    # Loop over all setups:
    for setup_id in setup_ids:
        filter_id = self.obs_df['setup_id'] == setup_id
        if verbose:
            print(f' - setup ID: {setup_id}')
        # Check number of observations in setup:
        if len(self.obs_df.loc[filter_id]) < (n_obs + 1):
            if verbose:
                print(f'   - Less than {n_obs} observations available: {len(self.obs_df.loc[filter_id])}')
        else:  # Enough observations in this setup
            # Calculate stabilized gravity and set up filter:
            if obs_type == 'reduced':
                g_stabilized_mugal = self.obs_df.loc[filter_id, 'g_red_mugal'].tail(n_obs).mean()
                filter_delta_g = (self.obs_df['g_red_mugal'] < (g_stabilized_mugal - threshold_mugal)) | (
                        self.obs_df['g_red_mugal'] > (g_stabilized_mugal + threshold_mugal))
            elif obs_type == 'observed':
                g_stabilized_mugal = self.obs_df.loc[filter_id, 'g_obs_mugal'].tail(n_obs).mean()
                filter_delta_g = (self.obs_df['g_obs_mugal'] < (g_stabilized_mugal - threshold_mugal)) | (
                        self.obs_df['g_obs_mugal'] > (g_stabilized_mugal + threshold_mugal))
            else:
                raise ValueError(f'Invalid value assigned to the parameter "obs_type": {obs_type}')

            # Apply filter:
            filter_all = filter_delta_g & filter_id
            if verbose:
                print(f'   - Number of removed observations: {len(self.obs_df.loc[filter_all, "keep_obs"])}')
            self.obs_df.loc[filter_all, 'keep_obs'] = False
    return True

autselect_duration(threshold_sec, setup_id=None, verbose=False)

Detect and deactivate all observations with a measurement duration smaller than the threshold.

Parameters:

Name Type Description Default
threshold_sec int

Threshold for the measurement duration.

 required
setup_id int(default=None)

None implies that this autoselection function is applied on all observations of this survey. Otherwise, the autoselection function is only applied on observations of the setup wirth the provided ID (setup_id)

 None
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Source code in gravtools/models/survey.py 
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
def autselect_duration(self, threshold_sec: int, setup_id: int = None, verbose: bool = False):
    """Detect and deactivate all observations with a measurement duration smaller than the threshold.

    Parameters
    ----------
    threshold_sec : int
        Threshold for the measurement duration.
    setup_id : int (default=None)
        `None` implies that this autoselection function is applied on all observations of this survey. Otherwise,
        the autoselection function is only applied on observations of the setup wirth the provided ID (`setup_id`)
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.
    """
    filter_duration = self.obs_df['duration_sec'] < threshold_sec
    if setup_id is not None:  # Apply on whole survey
        filter_duration = filter_duration & (self.obs_df['setup_id'] == setup_id)
    self.obs_df.loc[filter_duration, 'keep_obs'] = False
    if verbose:
        print(
            f'Removed observations due to duration threshold ({threshold_sec} sec): {filter_duration[filter_duration].count()}')

autselect_g_sd(threshold_mugal, obs_type='reduced', setup_id=None, verbose=False)

Deactivate observations with a gravity standard deviation larger than the defined threshold.

Parameters:

Name Type Description Default
threshold_mugal int

Observations in this survey or the specified setup are deactivated, if the standard deviation of the observed or the reduced gravity (columns sd_g_obs_mugal or sd_g_red_mugal in :py:obj:.Survey.obs_df) exceed the given threshold [µGal].

 required
obs_type (str, observed or reduced(default))

Defines whether the observed (as loaded from an observation file) or the reduced observations are used as reference for this autoselection function.

 'reduced'
setup_id int(default=None)

None implies that this autoselection function is applied on all observations of this survey. Otherwise, the autoselection function is only applied on observations of the setup wirth the provided ID (setup_id).

 None
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False

Returns:

Name Type Description
bool Error indicator.

False, if at least one standard deviation value is None is case, reduced observations are usd as reference.
Source code in gravtools/models/survey.py 
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
def autselect_g_sd(self, threshold_mugal: int, obs_type: str = 'reduced', setup_id: int = None,
                   verbose: bool = False):
    """Deactivate observations with a gravity standard deviation larger than the defined threshold.

    Parameters
    ----------
    threshold_mugal : int
        Observations in this survey or the specified setup are deactivated, if the standard deviation of the
        observed or the reduced gravity (columns `sd_g_obs_mugal` or `sd_g_red_mugal` in
        :py:obj:`.Survey.obs_df`) exceed the given threshold [µGal].
    obs_type : str, 'observed' or 'reduced' (default)
        Defines whether the observed (as loaded from an observation file) or the reduced observations are used as
        reference for this autoselection function.
    setup_id : int (default=None)
        `None` implies that this autoselection function is applied on all observations of this survey. Otherwise,
        the autoselection function is only applied on observations of the setup wirth the provided ID (`setup_id`).
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.

    Returns
    -------
    bool : Error indicator.
        `False`, if at least one standard deviation value is `None` is case, reduced observations are usd as
        reference.
    """
    if obs_type == 'reduced':
        if self.obs_df['sd_g_red_mugal'].isna().any():
            if verbose:
                print('ERROR: At least one value in column "sd_g_red_mugal" is None.')
            return False
        filter_g_sd = (abs(self.obs_df['sd_g_red_mugal']) > threshold_mugal)
    elif obs_type == 'observed':
        filter_g_sd = (abs(self.obs_df['sd_g_obs_mugal']) > threshold_mugal)
    else:
        raise ValueError(f'Invalid value assigned to the parameter "obs_type": {obs_type}')
    if setup_id is not None:  # Apply on whole survey
        filter_g_sd = filter_g_sd & (self.obs_df['setup_id'] == setup_id)
    self.obs_df.loc[filter_g_sd, 'keep_obs'] = False
    return True

autselect_tilt(threshold_arcsec, setup_id=None, verbose=False)

Deactivate all observations of the survey or of a setup with a tilt larger than the defined threshold.

Parameters:

Name Type Description Default
threshold_arcsec int

Observations in this survey or the specified setup are deactivated, if their tilt in X or Y direction (columns tiltx and tilty in :py:obj:.Survey.obs_df) exceeds the given threshold [arcsec].

 required
setup_id int(default=None)

None implies that this autoselection function is applied on all observations of this survey. Otherwise, the autoselection function is only applied on observations of the setup with the provided ID (setup_id)

 None
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Source code in gravtools/models/survey.py 
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
def autselect_tilt(self, threshold_arcsec: int, setup_id: int = None, verbose: bool = False):
    """Deactivate all observations of the survey or of a setup with a tilt larger than the defined threshold.

    Parameters
    ----------
    threshold_arcsec : int
        Observations in this survey or the specified setup are deactivated, if their tilt in X or Y direction
        (columns `tiltx` and `tilty` in :py:obj:`.Survey.obs_df`) exceeds the given threshold [arcsec].
    setup_id : int (default=None)
        `None` implies that this autoselection function is applied on all observations of this survey. Otherwise,
        the autoselection function is only applied on observations of the setup with the provided ID (`setup_id`)
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.
    """
    filter_tilt = (abs(self.obs_df['tiltx']) > threshold_arcsec) | (abs(self.obs_df['tilty']) > threshold_arcsec)
    if setup_id is not None:  # Apply on whole survey
        filter_tilt = filter_tilt & (self.obs_df['setup_id'] == setup_id)
    self.obs_df.loc[filter_tilt, 'keep_obs'] = False
    if verbose:
        print(
            f'Removed observations due to tilt threshold ({threshold_arcsec} asec): {filter_tilt[filter_tilt].count()}')

calc_drift_at_station_polyfit(station_name, degree=1, obs_type='reduced', active_only=True, min_number_obs=1)

Calculate the instrumental drift based on observations at a given station using numpy.polyfit.

Parameters:

Name Type Description Default
station_name str

Name of the station.

 required
degree (int, optional(default=1))

Degree of the drift polynomial to be fitted to the observations. The degree has to be in the range between 1 and 3.

 1
obs_type str, optional, `reduced` or `observed` (default=`reduced`)

Either used reduced observations of the originals values as observed for fitting the drfit polynomial.

 'reduced'
active_only bool, optional (default=`True`)

True implies that only active observations are considered.

 True
min_number_obs (int, optional(default=1))

Minimum number of observations. If less observations are available, no polynomial is fitted and None is returned.

 1

Returns:

Type Description
numpy.ndarray : Polynomial coefficients as determined by `numpy.polyfit`, highest power first
Source code in gravtools/models/survey.py 
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
def calc_drift_at_station_polyfit(self, station_name: str, degree: int = 1, obs_type: str = 'reduced', active_only: bool = True, min_number_obs: int = 1):
    """Calculate the instrumental drift based on observations at a given station using `numpy.polyfit`.

    Parameters
    ----------
    station_name : str
        Name of the station.
    degree : int, optional (default=1)
        Degree of the drift polynomial to be fitted to the observations. The degree has to be in the range between 1
         and 3.
    obs_type : str, optional, `reduced` or `observed` (default=`reduced`)
        Either used reduced observations of the originals values as observed for fitting the drfit polynomial.
    active_only : bool, optional (default=`True`)
        `True` implies that only active observations are considered.
    min_number_obs : int, optional (default=1)
        Minimum number of observations. If less observations are available, no polynomial is fitted and None is
        returned.

    Returns
    -------
    numpy.ndarray : Polynomial coefficients as determined by `numpy.polyfit`, highest power first
    """
    tmp_filter = self.obs_df['station_name'] == station_name
    if active_only:
        tmp_filter = tmp_filter & self.obs_df['keep_obs']
    obs_df_stat = self.obs_df.loc[tmp_filter].copy(deep=True)
    if len(obs_df_stat) < min_number_obs:
        return None
    obs_df_stat['hours_since_start'] = (obs_df_stat['obs_epoch'] - self.start_time) / np.timedelta64(1, 's') / 3600
    if obs_type == 'reduced':
        g_mugal = obs_df_stat['g_red_mugal'].astype(float).values
    elif obs_type == 'observed':
        g_mugal = obs_df_stat['g_obs_mugal'].astype(float).values
    else:
        raise RuntimeError(f'Unknown observation type: {obs_type}')
    t_h = obs_df_stat['hours_since_start'].values
    return np.polyfit(t_h, g_mugal, degree)

calculate_setup_data(gravimeters, obs_type='reduced', ref_delta_t_campaign_dt=None, active_obs_only_for_ref_epoch=True, method='variance_weighted_mean', method_sd='sd_from_obs_file', default_sd_mugal=100.0, verbose=False)

Accumulate all active observation within each setup and calculate a single representative pseudo observation.

Parameters:

Name Type Description Default
gravimeters Gravimeter object

Gravimeter object containing relevant information such as height differences for height corrections and scaling information.

 required
obs_type (str, observed or reduced(default))

Defines whether the observed (as loaded from an observation file) or the reduced observations from self.obs_df are used to determine the weighted mean values per setup.

 'reduced'
ref_delta_t_campaign_dt datetime object, optional (default = None)

Reference time for calculation of delta_t_campaign_h. None implies that the reference epoch is not available/defined. In the latter case delta_t_campaign_h is None for all setup observations.

 None
active_obs_only_for_ref_epoch

True implies that the relative reference epochs are determined by considering active observations only.

 True
method str, optional (default=`variance_weighted_mean`)

Select method for the calculation of setup data. variance_weighted_mean implies that setup observations (observed gravity, standard deviations and reference time) are calculated by variance weighted mean of the individual observations. individual_obs implies that the original observations are used as setup data without any aggregation.

 'variance_weighted_mean'
method_sd (str, optional(default=sd_from_obs_file))

Method for the determination of standard deviations (SD) of setup observations. sd_from_obs_file implies that SD are taken from the observation file. sd_default_per_obs and sd_default_per_setup imply that the given default SD is used, where the default SD is applied the individual observations in the first case and to setups in the second case. If applied to observations, the number of observations per setup still plays a role for weighting the setup observations in the adjustment.

 'sd_from_obs_file'
default_sd_mugal (float, optional(default=100.0))

Default standard deviation [µGal] that is used to determine the SD of setup observations when method_sd is sd_default_per_obs or sd_default_per_setup

 100.0
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Source code in gravtools/models/survey.py 
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
def calculate_setup_data(self,
                         gravimeters,
                         obs_type='reduced',
                         ref_delta_t_campaign_dt=None,
                         active_obs_only_for_ref_epoch=True,
                         method='variance_weighted_mean',
                         method_sd='sd_from_obs_file',
                         default_sd_mugal=100.0,
                         verbose=False):
    """Accumulate all active observation within each setup and calculate a single representative pseudo observation.

    Parameters
    ----------
    gravimeters : Gravimeter object
        Gravimeter object containing relevant information such as height differences for height corrections and
        scaling information.
    obs_type : str, 'observed' or 'reduced' (default)
        Defines whether the observed (as loaded from an observation file) or the reduced observations from
        `self.obs_df` are used to determine the weighted mean values per setup.
    ref_delta_t_campaign_dt : datetime object, optional (default = None)
        Reference time for calculation of `delta_t_campaign_h`. `None` implies that the reference epoch is not
        available/defined. In the latter case `delta_t_campaign_h` is `None` for all setup observations.
    active_obs_only_for_ref_epoch: bool, optional (default=True)
        `True` implies that the relative reference epochs are determined by considering active observations only.
    method : str, optional (default=`variance_weighted_mean`)
        Select method for the calculation of setup data. `variance_weighted_mean` implies that setup observations
        (observed gravity, standard deviations and reference time) are calculated by variance weighted mean of the
        individual observations. `individual_obs` implies that the original observations are used as setup data
        without any aggregation.
    method_sd : str, optional (default='sd_from_obs_file')
        Method for the determination of standard deviations (SD) of setup observations. `sd_from_obs_file` implies that
        SD are taken from the observation file. `sd_default_per_obs` and `sd_default_per_setup` imply that the
        given default SD is used, where the default SD is applied the individual observations in the first case and
        to setups in the second case. If applied to observations, the number of observations per setup still plays a
        role for weighting the setup observations in the adjustment.
    default_sd_mugal : float, optional (default=100.0)
        Default standard deviation [µGal] that is used to determine the SD of setup observations when `method_sd` is
        `sd_default_per_obs` or `sd_default_per_setup`
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.
    """

    if verbose:
        print(f'Calculate setup data for survey {self.name}')

    _VALID_OBS_TYPES = ('observed', 'reduced',)
    flag_calculate_delta_t_campaign_h = False

    self.reset_setup_data(verbose)

    # Initial checks:
    if obs_type not in _VALID_OBS_TYPES:
        raise AssertionError(f'Invalid observation type: {obs_type} (valid: "reduced" or "observed").')
    if method not in SETUP_CALC_METHODS:
        raise AssertionError(f'Invalid method: {method} (valid: "variance_weighted_mean" or "individual_obs").')
    if self.obs_df is None:
        raise AssertionError('Observation dataframe is empty!')

    # Get all active observations:
    tmp_filter = self.obs_df['keep_obs']
    active_obs_df = self.obs_df[tmp_filter].copy(deep=True)

    # Modify SD according to input options:
    if method_sd == 'sd_from_obs_file':
        pass  # keep SD
    elif method_sd == 'sd_default_per_obs':
        if verbose:
            print(f'Use default SD of {default_sd_mugal} µGal for weighting observations instead of SD from '
                  f'observation files.')
        active_obs_df['sd_g_red_mugal'] = default_sd_mugal
        active_obs_df['sd_g_obs_mugal'] = default_sd_mugal

    # Check, if at least one observation is active:
    if len(active_obs_df) == 0:
        if verbose:
            print(f'No active observations in survey {self.name}')
    else:

        # Check, if reduced data is available:
        if obs_type == 'reduced':
            if active_obs_df['g_red_mugal'].isnull().any() or active_obs_df['sd_g_red_mugal'].isnull().any():
                raise AssertionError('Reduced observations (g and sd) are missing!')

        # Check input
        if ref_delta_t_campaign_dt is None:  # No reference time for the campaign defined
            flag_calculate_delta_t_campaign_h = False
        elif isinstance(ref_delta_t_campaign_dt, dt.datetime):  # Input is OK!
            flag_calculate_delta_t_campaign_h = True
        else:
            raise TypeError('`ref_delta_t_campaign_dt` needs to be a datetime object!')
        # - SD == 0? => This would create a divided by zero error!
        if obs_type == 'reduced':
            tmp_filter = active_obs_df['sd_g_red_mugal'] <= 0.0
        elif obs_type == 'observed':
            tmp_filter = active_obs_df['sd_g_obs_mugal'] <= 0.0
        if tmp_filter.any():
            error_str = active_obs_df.loc[tmp_filter, ['station_name', 'obs_epoch']].to_string()
            raise AssertionError(f'The SD of the following observations ({obs_type}) in the survey {self.name}'
                                 f' is <= 0.0 µGal (invalid!):\n{error_str}')

        # Determine reference time for the survey:
        if active_obs_only_for_ref_epoch:
            ref_delta_t_dt = active_obs_df['obs_epoch'].min()  # First observation epoch in survey (active only)
        else:
            ref_delta_t_dt = self.obs_df['obs_epoch'].min()  # First observation epoch (also inactive obs)

        dist_m = gravimeters.get_height_offset(self.gravimeter_type, self.gravimeter_serial_number)

        # Loop over setups:
        if method == 'variance_weighted_mean':
            # Initialize columns lists for creating dataframe:
            station_name_list = []
            setup_id_list = []
            g_mugal_list = []
            sd_g_red_mugal_list = []
            obs_epoch_list_unix = []
            obs_epoch_list_dt = []
            delta_t_h_list = []
            delta_t_campaign_h_list = []
            sd_setup_mugal_list = []
            number_obs_list = []
            dhf_sensor_m_list = []
            linear_scale_list = []

            setup_ids = active_obs_df['setup_id'].unique()
            for setup_id in setup_ids:
                tmp_filter = active_obs_df['setup_id'] == setup_id
                if obs_type == 'observed':
                    g_mugal = active_obs_df.loc[tmp_filter, 'g_obs_mugal'].to_numpy()
                    sd_g_mugal = active_obs_df.loc[tmp_filter, 'sd_g_obs_mugal'].to_numpy()
                elif obs_type == 'reduced':
                    g_mugal = active_obs_df.loc[tmp_filter, 'g_red_mugal'].to_numpy()
                    sd_g_mugal = active_obs_df.loc[tmp_filter, 'sd_g_red_mugal'].to_numpy()
                weights = 1 / sd_g_mugal ** 2
                g_setup_mugal = np.sum(g_mugal * weights) / np.sum(weights)
                sd_g_setup_mugal = np.sqrt(1 / np.sum(weights))
                if len(active_obs_df.loc[tmp_filter, 'station_name'].unique()) > 1:
                    raise AssertionError(
                        f'Setup with ID "{setup_id}" in survey "{self.name}" contains '
                        f'{len(active_obs_df.loc[tmp_filter, "station_name"].unique())} stations (only 1 allowed)!'
                    )

                # Standard deviation of active observations within setup:
                # - If less than 2 active observations in setup => Calculation not possible => NaN
                if len(g_mugal) >= 2:
                    sd_setup_mugal_list.append(g_mugal.std(ddof=1))  # degree of freedom = (len(g_mugal) - 1)
                else:
                    sd_setup_mugal_list.append(np.nan)

                number_obs_list.append(len(g_mugal))  # Number of observations

                # Get vertical distance between sensor height and control point:
                dhf_sensor_m_list.append(active_obs_df.loc[tmp_filter, 'dhf_m'].values[0] + dist_m)

                # Get linear scale factor
                unique_linear_scale_factor_of_setup = active_obs_df.loc[tmp_filter, 'linear_scale'].unique()
                # - Check whether a single scale factor was used for the setup:
                if unique_linear_scale_factor_of_setup.shape[0] == 1:
                    linear_scale_list.append(unique_linear_scale_factor_of_setup[0])
                else:
                    linear_scale_list.append(np.nan)
                    if verbose:
                        print(
                            f'WARNING: In setup {setup_id} of survey {self.name} the linear scale factor is not unique!')

                # observation epoch (UNIX timestamps in full seconds):
                obs_epochs_series = active_obs_df.loc[tmp_filter, 'obs_epoch']
                unix_obs_epochs = to_unix_seconds(obs_epochs_series)
                unix_setup_epoch = np.sum(unix_obs_epochs * weights) / np.sum(weights)

                # Reference epoch as datetime object (TZ=<UTC>):
                dt_setup_epoch = dt.datetime.utcfromtimestamp(unix_setup_epoch)
                dt_setup_epoch = dt_setup_epoch.replace(tzinfo=dt.timezone.utc)  # TZ = <UTC>

                station_name_list.append(active_obs_df.loc[tmp_filter, 'station_name'].unique()[0])
                setup_id_list.append(setup_id)
                g_mugal_list.append(g_setup_mugal)
                sd_g_red_mugal_list.append(sd_g_setup_mugal)
                obs_epoch_list_unix.append(unix_setup_epoch)
                obs_epoch_list_dt.append(dt_setup_epoch)
                delta_t_h_list.append((unix_setup_epoch - ref_delta_t_dt.timestamp()) / 3600.0)
                if flag_calculate_delta_t_campaign_h:
                    delta_t_campaign_h_list.append(
                        (unix_setup_epoch - ref_delta_t_campaign_dt.timestamp()) / 3600.0)
                else:
                    delta_t_campaign_h_list.append(None)
        elif method == 'individual_obs':
            station_name_list = active_obs_df['station_name'].to_list()
            setup_id_list = active_obs_df['setup_id'].to_list()
            if obs_type == 'observed':
                g_mugal_list = active_obs_df['g_obs_mugal'].to_list()
                sd_g_red_mugal_list = active_obs_df['sd_g_obs_mugal'].to_list()
            elif obs_type == 'reduced':
                g_mugal_list = active_obs_df['g_red_mugal'].to_list()
                sd_g_red_mugal_list = active_obs_df['sd_g_red_mugal'].to_list()

            obs_epoch_unix_array = to_unix_seconds(active_obs_df['obs_epoch'])
            obs_epoch_list_unix = list(obs_epoch_unix_array)
            obs_epoch_list_dt = pd.to_datetime(obs_epoch_unix_array, unit='s').tz_localize('utc').to_list()

            delta_t_h_list = list((obs_epoch_unix_array - ref_delta_t_dt.timestamp()) / 3600.0)
            if flag_calculate_delta_t_campaign_h:
                delta_t_campaign_h_list = list(
                    (obs_epoch_unix_array - ref_delta_t_campaign_dt.timestamp()) / 3600.0)
            else:
                delta_t_campaign_h_list = [None] * len(g_mugal_list)
            sd_setup_mugal_list = [np.nan] * len(g_mugal_list)
            number_obs_list = [1] * len(g_mugal_list)
            dhf_sensor_m_list = active_obs_df['dhf_m'] + dist_m

        if obs_type == 'observed':
            self.setup_tide_correction_type = self.obs_tide_correction_type
            self.setup_reference_height_type = self.obs_reference_height_type
            self.setup_atm_pres_correction_type = self.obs_atm_pres_correction_type
            self.setup_scale_correction_type = self.obs_scale_correction_type
            self.setup_oceanload_correction_type = self.obs_oceanload_correction_type
        elif obs_type == 'reduced':
            self.setup_tide_correction_type = self.red_tide_correction_type
            self.setup_reference_height_type = self.red_reference_height_type
            self.setup_atm_pres_correction_type = self.red_atm_pres_correction_type
            self.setup_scale_correction_type = self.red_scale_correction_type
            self.setup_oceanload_correction_type = self.red_oceanload_correction_type
        self.setup_calc_method = method
        self.setup_sd_method = method_sd
        self.create_setup_obs_list()

        if method_sd == 'sd_default_per_setup':
            if verbose:
                print(f'Use a default SD of {default_sd_mugal} µGal for all setup observations.')
            sd_g_red_mugal_list = [default_sd_mugal for item in sd_g_red_mugal_list]

        # convert to pd dataframe:
        self.setup_df = pd.DataFrame(list(zip(station_name_list,
                                              setup_id_list,
                                              g_mugal_list,
                                              sd_g_red_mugal_list,
                                              obs_epoch_list_unix,
                                              obs_epoch_list_dt,
                                              delta_t_h_list,
                                              delta_t_campaign_h_list,
                                              sd_setup_mugal_list,
                                              number_obs_list,
                                              dhf_sensor_m_list,
                                              linear_scale_list)),
                                     columns=self._SETUP_DF_COLUMNS)
        self.set_reference_time(ref_delta_t_dt)  # Save reference time for `delta_t_h`, i.e. for the survey.

check_obs_df(verbose=True)

Check, whether the observations DataFrame (obs_df) is valid and try to add missing columns.

This method carried out the following checks:

  • Check the columns as specified in :py:obj:.Survey._OBS_DF_COLUMNS?

  • Does obs_df have all required columns?

  • If columns defined in :py:obj:.Survey._OBS_DF_INIT_COL_IF_MISSING are missing, they are added with the defined initial value.

Parameters:

Name Type Description Default
verbose (bool, optional(default=False))

If True, messages are printed in the command line interface.

 True

Returns:

Name Type Description
is_valid bool

True, if obs_df is valid.
error_msg str

Error Message. Empty if no errors occurred.
Source code in gravtools/models/survey.py 
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
def check_obs_df(self, verbose=True) -> tuple[bool, str]:
    """Check, whether the observations DataFrame (`obs_df`) is valid and try to add missing columns.

    This method carried out the following checks:

    - Check the columns as specified in :py:obj:`.Survey._OBS_DF_COLUMNS`?

      - Does `obs_df` have all required columns?

      - If columns defined in :py:obj:`.Survey._OBS_DF_INIT_COL_IF_MISSING` are missing, they are added with the
        defined initial value.

    Parameters
    ----------
    verbose : bool, optional (default=False)
        If True, messages are printed in the command line interface.

    Returns
    -------
    is_valid : bool
        True, if `obs_df` is valid.
    error_msg : str
        Error Message. Empty if no errors occurred.
    """
    is_valid = True
    error_msg = ''

    # Invalid columns?
    invalid_cols = list(set(self.obs_df.columns) - set(self._OBS_DF_COLUMNS))
    if len(invalid_cols) > 0:
        is_valid = False
        error_msg = f'The following columns in the observation dataframe of survey "{self.name}" are not valid: {", ".join(invalid_cols)}. '
        if verbose:
            print(error_msg)

    # Missing columns?
    invalid_cols = list(set(self._OBS_DF_COLUMNS) - set(self.obs_df.columns))
    if len(invalid_cols) > 0:
        # Add columns with the default values, if defined in _OBS_DF_INIT_COL_IF_MISSING:
        for invalid_col in invalid_cols:
            if invalid_col in self._OBS_DF_INIT_COL_IF_MISSING:
                self.obs_df[invalid_col] = self._OBS_DF_INIT_COL_IF_MISSING[invalid_col]
                if verbose:
                    print(f'Added column "{invalid_col}" with default value "'
                          f'{self._OBS_DF_INIT_COL_IF_MISSING[invalid_col]}" in observation dataframe of survey "'
                          f'{self.name}".')
        # Check again:
        self.obs_df = self._obs_df_reorder_columns(self.obs_df)
        invalid_cols = list(set(self._OBS_DF_COLUMNS) - set(self.obs_df.columns))
        if len(invalid_cols) > 0:
            is_valid = False
            error_msg_tmp = (f'The following columns in the observation dataframe of survey "'
                             f'{self.name}" are missing: {", ".join(invalid_cols)}. ')
            error_msg = error_msg + error_msg_tmp
            if verbose:
                print(error_msg_tmp)

    return is_valid, error_msg

create_setup_obs_list()

Create list of all observations that contribute to the calculation of setup data in this Survey object.

The list is created as pandas dataframe. It holds information whether an observation in the obs_df is active or inactive (keep_obs flag).

Source code in gravtools/models/survey.py 
2515
2516
2517
2518
2519
2520
2521
def create_setup_obs_list(self):
    """Create list of all observations that contribute to the calculation of setup data in this Survey object.

    The list is created as pandas dataframe. It holds information whether an observation in the `obs_df` is
    active or inactive (`keep_obs` flag).
    """
    self.setup_obs_list_df = self.obs_df.loc[:, self._SETUP_OBS_LIST_DF_COLUMNS].copy(deep=True)

from_bev_obs_file(filename, keep_survey=True, verbose=False) classmethod

Constructor that generates and populates the survey object from an observation file in the legacy BEV format.

Notes

Format of the legacy BEV observation files: - Line 1: Scaled values? ('Y'=True, 'N'=False) - Line 2: Instrument ID (e.g. 5 fpr CG5) and institution - Line 3: Degree of the drift polynomial to be fitted - Line 4: Date (YYYY MM DD) - Line 5: Timezone (UTC, MEZ, OEZ) - Line 6 bis n: Station name(x-xxx-xx), epoch (hh.mm), g [mGal], dhb [cm] (hh.h), dhf [cm] (hh.h) - Line n+1: 'end'

The observation epochs are represented by timezone aware datetime objects with TZ=. The TZ is changed if necessary when loading data from any source.

Parameters:

Name Type Description Default
filename str

Name (and path) of an observation in the legacy BEV format.

 required
keep_survey (bool, optional(default=True))

If False, this survey is excluded from further processing.

 True
verbose (bool, optional(default=False))

If True, status messages are printed.

 False

Returns:

Type Description
py:obj:`.Survey`

Contains all information of a specific survey independent of the data source.
Source code in gravtools/models/survey.py 
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
@classmethod
def from_bev_obs_file(cls, filename, keep_survey=True, verbose=False):
    """Constructor that generates and populates the survey object from an observation file in the legacy BEV format.

    Notes
    -----
    Format of the legacy BEV observation files:
    - Line 1: Scaled values? ('Y'=True, 'N'=False)
    - Line 2: Instrument ID (e.g. 5 fpr CG5) and institution
    - Line 3: Degree of the drift polynomial to be fitted
    - Line 4: Date (YYYY MM DD)
    - Line 5: Timezone (UTC, MEZ, OEZ)
    - Line 6 bis n: Station name(x-xxx-xx), epoch (hh.mm), g [mGal], dhb [cm] (hh.h), dhf [cm] (hh.h)
    - Line n+1: 'end'

    The observation epochs are represented by timezone aware datetime objects with TZ=<UTC>. The TZ is changed
    if necessary when loading data from any source.

    Parameters
    ----------
    filename : str
        Name (and path) of an observation in the legacy BEV format.
    keep_survey : bool, optional (default=True)
        If False, this survey is excluded from further processing.
    verbose : bool, optional (default=False)
        If True, status messages are printed.

    Returns
    -------
    :py:obj:`.Survey`
        Contains all information of a specific survey independent of the data source.
    """
    survey_name = os.path.split(filename)[1]

    if verbose:
        print(f'Read observations from file: {filename}.')

    # Read header lines:
    num_of_header_lines = 5
    with open(filename) as myfile:
        head = [next(myfile) for x in range(num_of_header_lines)]
    # scaling = head[0][:-1] == 'Y'  # Keep for documentation
    gravimeter_id = head[1].split()[0]
    institution = head[1].split()[1]
    # polynomial_degree = int(head[2][:-1])  # Keep for documentation
    date_str = head[3][:-1]
    timezone_str = head[4][:-1]

    survey_date = dt.datetime.strptime(date_str, '%Y %m %d').date()

    # Read observations (fixed width file):
    widths = (
        11,  # Station name
        5,  # Time
        9,  # g [mGal]
        7,  # dhb [cm]
        6,  # dhf [cm]
    )
    column_names = (
        'station_name',
        'time_hh.mm',
        'g_mgal',
        'dhb_cm',
        'dhf_cm',
    )
    df = pd.read_fwf(filename, widths=widths, header=None, names=column_names, skiprows=5, skipfooter=1,
                     dtype={'time_hh.mm': object})

    # Prepare and initialize DataFrame:
    df['obs_epoch'] = pd.to_datetime(date_str + ' ' + df['time_hh.mm'] + ' ' + timezone_str,
                                     format='%Y %m %d %H.%M %Z')

    # Check timezone of observation epoch and convert it to UTC, if necessary:
    if df['obs_epoch'].dt.tz is None:  # TZ unaware => set TZ to <UTC>
        df['obs_epoch'] = df['obs_epoch'].dt.tz_localize('UTC')
    else:
        if df['obs_epoch'].dt.tz != dt.timezone.utc:  # Change TZ to <UTC>
            df['obs_epoch'] = df['obs_epoch'].dt.tz_convert('UTC')

    df['setup_id'] = df.apply(lambda row: make_setup_id(row['obs_epoch'], survey_name), axis=1)

    df['g_obs_mugal'] = df['g_mgal'] * 1e3
    df['dhb_m'] = df['dhb_cm'] * 1e-2
    df['dhf_m'] = df['dhf_cm'] * 1e-2

    df['keep_obs'] = True

    # Drop columns:
    obs_df = cls._obs_df_drop_columns(df)

    # Add all missing columns (init as None):
    obs_df = cls._obs_df_add_columns(obs_df)

    # Change column order:
    obs_df = cls._obs_df_reorder_columns(obs_df)

    # Get tide correction type:
    try:
        obs_tide_correction_type = BEV_GRAVIMETER_TIDE_CORR_LOOKUP[gravimeter_id]
    except KeyError:
        obs_tide_correction_type = 'unknown'
        if verbose:
            print(f'Warning: For gravimeter ID "{gravimeter_id}" the tide correction type is unknown '
                  f'(not specified in settings.BEV_GRAVIMETER_TIDE_CORR_LOOKUP). '
                  f'It is set to "{obs_tide_correction_type}".')

    # Use default values:
    gravimeter_serial_number = DEFAULT_GRAVIMETER_SERIAL_NUMBER
    gravimeter_type = DEFAULT_GRAVIMETER_TYPE

    return cls(name=survey_name,
               date=survey_date,
               operator='',
               institution=institution,
               gravimeter_type=gravimeter_type,
               gravimeter_serial_number=gravimeter_serial_number,
               data_file_name=os.path.split(filename)[1],  # Filename only, without path
               data_file_type='bev_obs_file',
               obs_df=obs_df,
               obs_tide_correction_type=obs_tide_correction_type,
               obs_reference_height_type='sensor_height',
               obs_atm_pres_correction_type='no_atm_pres_corr',
               obs_scale_correction_type='no_scale',
               red_tide_correction_type='',  # Not specified
               red_reference_height_type='',  # Not specified
               red_atm_pres_correction_type='',  # Not specified
               red_scale_correction_type='',  # Not specified
               keep_survey=keep_survey,
               )

from_cg5_obs_file(filename, keep_survey=True) classmethod

Constructor that generates and populates the survey object directly from a CG5 observation file.

Parameters:

Name Type Description Default
filename str

Name (and path) of a CG-5 observation file (text format).

 required
keep_survey (bool, optional(default=True))

If False, this survey is excluded from further processing.

 True

Returns:

Type Description
py:obj:`.Survey`

Contains all information of a specific survey independent of the data source.
Source code in gravtools/models/survey.py 
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
@classmethod
def from_cg5_obs_file(cls, filename, keep_survey=True):
    """Constructor that generates and populates the survey object directly from a CG5 observation file.

    Parameters
    ----------
    filename : str
        Name (and path) of a CG-5 observation file (text format).
    keep_survey : bool, optional (default=True)
        If False, this survey is excluded from further processing.

    Returns
    -------
    :py:obj:`.Survey`
        Contains all information of a specific survey independent of the data source.
    """
    cg5_survey = CG5Survey(filename)
    return cls.from_cg5_survey(cg5_survey, keep_survey=keep_survey)

from_cg5_survey(cg5_survey, keep_survey=True) classmethod

Constructor that generates and populates the survey object from a CG5Survey class object.

Notes

The observation epochs are represented by timezone aware datetime objects with TZ=. The TZ is changed if necessary when loading data from any source.

Parameters:

Name Type Description Default
cg5_survey :py:obj:`gravtools.CG5_utils.cg5_survey.CG5Survey`

Objects of the class CG5Survey contain all data from a CG-5 observation files.

 required
keep_survey (bool, optional(default=True))

If False, this survey is excluded from further processing.

 True

Returns:

Type Description
py:obj:`.Survey`

Contains all information of a specific survey independent of the data source.
Source code in gravtools/models/survey.py 
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
@classmethod
def from_cg5_survey(cls, cg5_survey, keep_survey: bool = True):
    """Constructor that generates and populates the survey object from a CG5Survey class object.

    Notes
    -----
    The observation epochs are represented by timezone aware datetime objects with TZ=<UTC>. The TZ is changed
    if necessary when loading data from any source.

    Parameters
    ----------
    cg5_survey : :py:obj:`gravtools.CG5_utils.cg5_survey.CG5Survey`
        Objects of the class CG5Survey contain all data from a CG-5 observation files.
    keep_survey : bool, optional (default=True)
        If False, this survey is excluded from further processing.

    Returns
    -------
    :py:obj:`.Survey`
        Contains all information of a specific survey independent of the data source.
    """

    # Check input arguments:
    if not isinstance(cg5_survey, CG5Survey):
        raise TypeError('"cg5_survey" has to be a CG5Survey object.')

    # Parse and check data from CG5Survey:
    # Get date from date and time:
    if cg5_survey.survey_parameters.date_time is not None:
        survey_date = cg5_survey.survey_parameters.date_time.date()
    else:
        survey_date = None

    # obs_df:
    if cg5_survey.obs_df is not None:
        # Refactor observation dataframe:
        obs_df = cg5_survey.obs_df.sort_values('obs_epoch').copy(
            deep=True)  # deep copy => No struggles with references

        # Add missing columns (initialized with default values):
        obs_df['g_obs_mugal'] = obs_df['g_mgal'] * 1e3
        obs_df['sd_g_obs_mugal'] = obs_df['sd_mgal'] * 1e3
        obs_df['sd_g_obs_mugal'] = obs_df['sd_mgal'] * 1e3
        obs_df['tide'] = obs_df['tide'] * 1e3
        obs_df['keep_obs'] = True

        # Check timezone of observation epoch and convert it to UTC, if necessary:
        if obs_df['obs_epoch'].dt.tz is None:  # TZ unaware => set TZ to <UTC>
            obs_df['obs_epoch'] = obs_df['obs_epoch'].dt.tz_localize('UTC')  # dtype: datetime64[ns, UTC]
        elif obs_df['obs_epoch'].dt.tz != dt.timezone.utc:  # Change TZ to <UTC>
            obs_df['obs_epoch'] = obs_df['obs_epoch'].dt.tz_convert('UTC')  # dtype: datetime64[ns, UTC]

        # Rename columns:
        obs_df.rename(columns={'terrain': 'corr_terrain',
                               'tide': 'corr_tide_mugal', },
                      inplace=True)

        # Drop columns that are not needed any more:
        # - all columns that are not in _OBS_DF_COLUMNS
        obs_df = cls._obs_df_drop_columns(obs_df)

        # Add all missing columns (init as None):
        obs_df = cls._obs_df_add_columns(obs_df)

        # Change column order:
        obs_df = cls._obs_df_reorder_columns(obs_df)

        # Check, if all columns are there:
        # if not all(obs_df.columns.values == cls._OBS_DF_COLUMNS):
        if not all([item for item in obs_df.columns.isin(cls._OBS_DF_COLUMNS)]):
            raise RuntimeError('Columns missing in "obs_df"')
    else:
        obs_df = None  # If no observations are available, initialize as None

    if cg5_survey.options.tide_correction is None:
        obs_tide_correction_type = 'unknown'  # e.g. "CG-5 OPTIONS" block in observation file missing
    else:
        if cg5_survey.options.tide_correction:
            obs_tide_correction_type = 'instrumental_corr'  # built-in tide correction of the CG5
        else:
            obs_tide_correction_type = 'no_tide_corr'

    return cls(name=cg5_survey.survey_parameters.survey_name,
               date=survey_date,
               operator=cg5_survey.survey_parameters.operator,
               institution=cg5_survey.survey_parameters.client,
               gravimeter_type=DEFAULT_GRAVIMETER_TYPE_CG5_SURVEY,
               gravimeter_serial_number=cg5_survey.survey_parameters.instrument_sn,
               data_file_name=os.path.split(cg5_survey.obs_filename)[1],  # Filename only, without path
               data_file_type='cg5_obs_file_txt',
               obs_df=obs_df,
               obs_tide_correction_type=obs_tide_correction_type,
               obs_reference_height_type='sensor_height',
               obs_atm_pres_correction_type='no_atm_pres_corr',
               obs_scale_correction_type='no_scale',
               obs_oceanload_correction_type='no_oceanload_corr',
               red_tide_correction_type='',  # Not specified
               red_reference_height_type='',  # Not specified
               red_atm_pres_correction_type='',  # Not specified
               red_scale_correction_type='',  # Not specified
               keep_survey=keep_survey,
               )

from_cg6_survey(cg6_survey, error_type='sd', location_type='user', keep_survey=True, pres_in_column='', dhb_in_column='') classmethod

Construct that generates a Survey object based on a CG6Survey object.

Parameters:

Name Type Description Default
cg6_survey :py:obj:`gravtools.CG6_utils.cg6_survey.CG6Survey`

Objects of the class CG6Survey containing all data from CG-6 observation files.

 required
error_type (str(sd or se), optional(default=sd))

'sd' indicates that the standard deviation values are loaded from the CG6 observation files whereas 'se' indicates that the standard error are used instead.

 'sd'
location_type (str(user or gps), optional(default=user))

The CG6 gravimeter provides two sets of geolocation data (latitude, longitude, height): "user" (from predefined station file or from GPS) and "GPS" (from the GPS module). user indicates that the first set is user for locating the observations throughout the analysis process and gps indicates that the latter set is used.

 'user'
keep_survey (bool, optional(default=True))

If False, this survey is excluded from further processing.

 True
pres_in_column (str, optional(default=line))

In situ measurements of the atmospheric pressure [hPa] are provided in the column with the given name in the observation dataframe in the CG6Survey object. An empty string indicates that no pressure values are provided. In the latter case the atm_pres_hpa column in obs_df in initialized with numpy.nan.

 ''
dhb_in_column (bool, optional(default=True))

In situ measurements of the height difference [m] between the instrument and the ground (dhb) are provided in the column with the given name in the observation dataframe in the CG6Survey object. An empty string indicates that no height differences are provided. In the latter case the dhb_m column in obs_df in initialized with numpy.nan.

 ''

Returns:

Type Description
py:obj:`.Survey`

Contains all information of a specific survey independent of the data source.
Source code in gravtools/models/survey.py 
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
@classmethod
def from_cg6_survey(cls, cg6_survey, error_type: str = 'sd', location_type: str = 'user', keep_survey: bool = True,
                    pres_in_column: str = '', dhb_in_column: str = ''):
    """Construct that generates a Survey object based on a CG6Survey object.

    Parameters
    ----------
    cg6_survey : :py:obj:`gravtools.CG6_utils.cg6_survey.CG6Survey`
        Objects of the class CG6Survey containing all data from CG-6 observation files.
    error_type : str ('sd' or 'se'), optional (default = 'sd')
        'sd' indicates that the standard deviation values are loaded from the CG6 observation files whereas 'se'
        indicates that the standard error are used instead.
    location_type : str ('user' or 'gps'), optional (default = 'user')
        The CG6 gravimeter provides two sets of geolocation data (latitude, longitude, height):
        "user" (from predefined station file or from GPS) and "GPS" (from the GPS module). `user` indicates that
        the first set is user for locating the observations throughout the analysis process and `gps` indicates
        that the latter set is used.
    keep_survey : bool, optional (default=True)
        If False, this survey is excluded from further processing.
    pres_in_column : str, optional (default='line')
        In situ measurements of the atmospheric pressure [hPa] are provided in the column with the given name in the
        observation dataframe in the `CG6Survey` object. An empty string indicates that no pressure values are
        provided. In the latter case the `atm_pres_hpa` column in `obs_df` in initialized with `numpy.nan`.
    dhb_in_column : bool, optional (default=True)
        In situ measurements of the height difference [m] between the instrument and the ground (dhb) are provided
        in the column with the given name in the observation dataframe in the `CG6Survey` object. An empty string
        indicates that no height differences are provided. In the latter case the `dhb_m` column in `obs_df` in
        initialized with `numpy.nan`.

    Returns
    -------
    :py:obj:`.Survey`
        Contains all information of a specific survey independent of the data source.
    """
    # Check input arguments:
    if not isinstance(cg6_survey, CG6Survey):
        raise TypeError('"cg6_survey" has to be a CG6Survey object.')

    if cg6_survey.tidal_corr:
        obs_tide_correction_type = 'instrumental_corr'  # built-in tide correction of the CG-6 (multiple options)
    else:
        obs_tide_correction_type = 'no_tide_corr'

    if cg6_survey.ocean_loading_corr:
        obs_oceanload_correction_type = 'instrumental_corr'
    else:
        obs_oceanload_correction_type = 'no_oceanload_corr'

    # Prepare obs_df:
    obs_df_cg6 = cg6_survey.obs_df.sort_values('ref_time').copy(deep=True)

    # Check timezone of observation epoch and convert it to UTC, if necessary:
    if obs_df_cg6['ref_time'].dt.tz is None:  # TZ unaware => set TZ to <UTC>
        # obs_df_cg6.loc[:, 'ref_time'] = obs_df_cg6['ref_time'].dt.tz_localize('UTC')  # Causes a FutureWarning: https://github.com/pandas-dev/pandas/issues/55317
        obs_df_cg6['ref_time'] = obs_df_cg6['ref_time'].dt.tz_localize('UTC')
    elif obs_df_cg6['ref_time'].dt.tz != dt.timezone.utc:  # Change TZ to <UTC>
        # obs_df_cg6.loc[:, 'ref_time'] = obs_df_cg6['ref_time'].dt.tz_convert('UTC')  # Causes a FutureWarning: https://github.com/pandas-dev/pandas/issues/55317
        obs_df_cg6['ref_time'] = obs_df_cg6['ref_time'].dt.tz_convert('UTC')

    obs_df = pd.DataFrame()
    obs_df['station_name'] = obs_df_cg6['station']
    obs_df['setup_id'] = obs_df_cg6['setup_id']

    if 'line' in [pres_in_column, dhb_in_column]:
        obs_df['loop_id'] = None
    else:
        obs_df['loop_id'] = obs_df_cg6['line']
    if location_type == 'user':
        obs_df['lon_deg'] = obs_df_cg6['user_lon_deg']
        obs_df['lat_deg'] = obs_df_cg6['user_lat_deg']
        obs_df['alt_m'] = obs_df_cg6['user_height_m']
    elif location_type == 'gps':
        obs_df['lon_deg'] = obs_df_cg6['gps_lon_deg']
        obs_df['lat_deg'] = obs_df_cg6['gps_lat_deg']
        obs_df['alt_m'] = obs_df_cg6['gps_h_m']
    else:
        raise RuntimeError(f'location_type "{location_type}" is invalid!')
    obs_df['obs_epoch'] = obs_df_cg6['ref_time']
    obs_df['g_obs_mugal'] = obs_df_cg6['g_corr_mugal']
    if error_type == 'sd':
        obs_df['sd_g_obs_mugal'] = obs_df_cg6['sd_mugal']
    elif error_type == 'se':
        obs_df['sd_g_obs_mugal'] = obs_df_cg6['se_mugal']
    else:
        raise RuntimeError(f'Invalid error type "{error_type}" when loading survey {cg6_survey.survey_name}')
    obs_df['corr_terrain'] = np.nan  # Not available
    obs_df['corr_tide_mugal'] = obs_df_cg6['corr_tide_mugal']
    obs_df['temp'] = obs_df_cg6['sensor_temp_mk']
    obs_df['tiltx'] = obs_df_cg6['tilt_x_arcsec']
    obs_df['tilty'] = obs_df_cg6['tilt_y_arcsec']
    obs_df['dhf_m'] = obs_df_cg6['instr_height_m']
    if dhb_in_column != 'no_data':
        if dhb_in_column in obs_df_cg6.columns:
            try:
                obs_df['dhb_m'] = obs_df_cg6[dhb_in_column].astype(float)
            except ValueError:
                raise ValueError(f'Cannot convert values in column "{dhb_in_column}" to float (dhb).')
        else:
            raise RuntimeError(f'Invalid column name: {dhb_in_column}.')
    else:
        obs_df['dhb_m'] = np.nan
    obs_df['keep_obs'] = True
    obs_df['duration_sec'] = obs_df_cg6['duration']
    if pres_in_column != 'no_data':
        if pres_in_column in obs_df_cg6.columns:
            try:
                obs_df['atm_pres_hpa'] = obs_df_cg6[pres_in_column].astype(float)
            except ValueError:
                raise ValueError(f'Cannot convert values in column "{pres_in_column}" to float (pressure).')
        else:
            raise RuntimeError(f'Invalid column name: {pres_in_column}.')
    else:
        obs_df['atm_pres_hpa'] = np.nan
    obs_df['corr_oceanload_instrument_mugal'] = obs_df_cg6['corr_oceanload_mugal']

    # Drop columns that are not needed any more:
    # - all columns that are not in _OBS_DF_COLUMNS
    obs_df = cls._obs_df_drop_columns(obs_df)

    # Add all missing columns (init as None):
    obs_df = cls._obs_df_add_columns(obs_df)

    # Change column order:
    obs_df = cls._obs_df_reorder_columns(obs_df)

    # Check, if all columns are there:
    if not all([item for item in obs_df.columns.isin(cls._OBS_DF_COLUMNS)]):
        raise RuntimeError('Columns missing in "obs_df"')

    return cls(name=cg6_survey.survey_name,
               date=obs_df_cg6.ref_time[0].date(),
               operator=cg6_survey.operator,
               institution='',  # Not available
               gravimeter_type=DEFAULT_GRAVIMETER_TYPE_CG6_SURVEY,
               gravimeter_serial_number=cg6_survey.serial_number,
               data_file_name=os.path.split(cg6_survey.obs_filename)[1],  # Filename only, without path
               data_file_type=cg6_survey.obs_file_type,
               obs_df=obs_df,
               obs_tide_correction_type=obs_tide_correction_type,
               obs_reference_height_type='sensor_height',
               obs_atm_pres_correction_type='no_atm_pres_corr',
               obs_scale_correction_type='no_scale',
               obs_oceanload_correction_type=obs_oceanload_correction_type,
               red_tide_correction_type='',  # Not specified
               red_reference_height_type='',  # Not specified
               red_atm_pres_correction_type='',  # Not specified
               red_scale_correction_type='',  # Not specified
               red_oceanload_correction_type='',  # Not specified
               keep_survey=keep_survey,
               )

get_number_of_observations()

Returns the number of observations of the current survey.

Returns:

Type Description
int

Number of observations.
Source code in gravtools/models/survey.py 
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
def get_number_of_observations(self) -> int:
    """Returns the number of observations of the current survey.

    Returns
    -------
    int
        Number of observations.
    """
    if self.obs_df is None:
        return 0
    else:
        return len(self.obs_df)

get_obs_df_column_index(column_name) classmethod

Returns the column index for specific column name for the obs_df dataframe.

Parameters:

Name Type Description Default
column_name str

Name of the columns for which the column index is returned.

 required

Returns:

Name Type Description
int Column index

Index of the column with the name column_name.
Source code in gravtools/models/survey.py 
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
@classmethod
def get_obs_df_column_index(cls, column_name: str) -> int:
    """Returns the column index for specific column name for the obs_df dataframe.

    Parameters
    ----------
    column_name: str
        Name of the columns for which the column index is returned.

    Returns
    -------
    int : Column index
        Index of the column with the name `column_name`.
    """
    return cls._OBS_DF_COLUMNS.index(column_name)

get_obs_df_column_name(col_index) classmethod

Return the name of the observation dataframe column with the specified index.

Parameters:

Name Type Description Default
col_index int

Column index for the observation dataframe.

 required

Returns:

Name Type Description
str Column name.

Name of the column with index col_index
Source code in gravtools/models/survey.py 
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
@classmethod
def get_obs_df_column_name(cls, col_index):
    """Return the name of the observation dataframe column with the specified index.

    Parameters
    ----------
    col_index : int
        Column index for the observation dataframe.

    Returns
    -------
    str : Column name.
        Name of the column with index `col_index`
    """
    return cls._OBS_DF_COLUMNS[col_index]

get_setup_df_column_name(col_index) classmethod

Return the name of the setup dataframe column with the specified index.

Parameters:

Name Type Description Default
col_index int

Column index for the setup dataframe.

 required

Returns:

Name Type Description
str Column name.

Name of the column with index col_index
Source code in gravtools/models/survey.py 
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
@classmethod
def get_setup_df_column_name(cls, col_index):
    """Return the name of the setup dataframe column with the specified index.

    Parameters
    ----------
    col_index : int
        Column index for the setup dataframe.

    Returns
    -------
    str : Column name.
        Name of the column with index `col_index`
    """
    return cls._SETUP_DF_COLUMNS[col_index]

get_setup_ids()

Return the IDs of all setups in this survey

Returns list : List of all setup IDs.

Source code in gravtools/models/survey.py 
2193
2194
2195
2196
2197
2198
2199
def get_setup_ids(self) -> list:
    """Return the IDs of all setups in this survey

    Returns
    list : List of all setup IDs.
    """
    return self.obs_df.setup_id.unique().tolist()

get_tidal_corrections_from_longman1959()

Derive tidal corrections for all observations in this survey using the Longman (1959) model.

Evaluates the Longman (1959) tidal model at the geographic position and UTC epoch of each observation in :py:obj:.Survey.obs_df. The tidal effect is evaluated at the middle of each gravity reading (obs_epoch + duration_sec / 2) rather than at the start epoch, which is the convention adopted throughout GravTools.

The following columns of :py:obj:.Survey.obs_df are required and must not contain NaN values: obs_epoch, duration_sec, lon_deg, lat_deg, alt_m.

Notes

The returned corrections must be added to the raw gravity readings in order to remove (reduce) the tidal signal.

Returns:

Type Description
Series

Tidal corrections [µGal] indexed by the integer row index of :py:obj:.Survey.obs_df. Positive values indicate that the Earth tide increases the measured gravity at that epoch; adding the correction removes the tidal contribution from the reading.

Raises:

Type Description
RuntimeError

If any of the required coordinate or duration columns (lon_deg, lat_deg, alt_m) contain NaN values, indicating that station coordinates are missing.
Source code in gravtools/models/survey.py 
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
def get_tidal_corrections_from_longman1959(self) -> pd.Series:
    """Derive tidal corrections for all observations in this survey using the Longman (1959) model.

    Evaluates the Longman (1959) tidal model at the geographic position and UTC epoch of each
    observation in :py:obj:`.Survey.obs_df`. The tidal effect is evaluated at the **middle** of
    each gravity reading (``obs_epoch + duration_sec / 2``) rather than at the start epoch, which
    is the convention adopted throughout GravTools.

    The following columns of :py:obj:`.Survey.obs_df` are required and must not contain ``NaN``
    values: ``obs_epoch``, ``duration_sec``, ``lon_deg``, ``lat_deg``, ``alt_m``.

    Notes
    -----
    The returned corrections must be **added** to the raw gravity readings in order to remove
    (reduce) the tidal signal.

    Returns
    -------
    pandas.Series
        Tidal corrections [µGal] indexed by the integer row index of :py:obj:`.Survey.obs_df`.
        Positive values indicate that the Earth tide increases the measured gravity at that epoch;
        adding the correction removes the tidal contribution from the reading.

    Raises
    ------
    RuntimeError
        If any of the required coordinate or duration columns (``lon_deg``, ``lat_deg``,
        ``alt_m``) contain ``NaN`` values, indicating that station coordinates are missing.
    """
    tmp_df = self.obs_df[['obs_epoch', 'duration_sec', 'lon_deg', 'lat_deg', 'alt_m']].copy(
        deep=True)
    # Check availability of input data:
    if tmp_df['lon_deg'].isna().any() or tmp_df['lat_deg'].isna().any() or tmp_df['alt_m'].isna().any():
        raise RuntimeError(f'Failed to calculate tidal corrections according to Longman (1959) due to missing station coordinates!')
    # Shift obs reference epoch from start to the middle of the gravity reading
    # (= evaluation time for the tide model):
    tmp_df['obs_epoch'] = tmp_df['obs_epoch'] + pd.to_timedelta(tmp_df['duration_sec'], 'sec') / 2
    # Remove TZ info for longman evaluation:
    tmp_df['obs_epoch'] = tmp_df['obs_epoch'].dt.tz_localize(None)
    tmp_df['tmp_index'] = tmp_df.index
    tmp_df = tmp_df.set_index('obs_epoch')
    tmp_df = gravtools.tides.longman1959.solve_tide_df(tmp_df, lat='lat_deg', lon='lon_deg', alt='alt_m')
    tmp_df['longman_tide_corr_mugal'] = tmp_df['g0'] * 1e3  # Convert from mGal to µGal
    tmp_df = tmp_df.set_index('tmp_index')  # Restore numerical index
    return tmp_df['longman_tide_corr_mugal']

get_tidal_corrections_from_timeseries(correction_time_series, interpolation_method)

Derives tidal corrections for observations from time series data.

Notes

The derived corrections have to be ADDED to the observations in order to reduce tidal effects!

Parameters:

Name Type Description Default
correction_time_series `CorrectionTimeSeries` object, optional (default=None)

Correction time series object that contains time series of tidal corrections for stations in surveys. This argument is required, if tidal corrections should be derived from time series data, i.e. if self.target_tide_corr = from_time_series.

 required
interpolation_method (str, optional(default=''))

Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are obtained from other sources or models, this attribute is irrelevant and has to be empty!

 required

Returns:

Type Description
`pandas.Series`: Interpolated value for the given interpolation times.
Source code in gravtools/models/survey.py 
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
def get_tidal_corrections_from_timeseries(self, correction_time_series, interpolation_method: str) -> np.ndarray:
    """Derives tidal corrections for observations from time series data.

    Notes
    -----
    The derived corrections have to be ADDED to the observations in order to reduce tidal effects!

    Parameters
    ----------
    correction_time_series : `CorrectionTimeSeries` object, optional (default=None)
        Correction time series object that contains time series of tidal corrections for stations in surveys. This
        argument is required, if tidal corrections should be derived from time series data, i.e. if
        `self.target_tide_corr = from_time_series`.
    interpolation_method : str, optional (default='')
        Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are
        obtained from other sources or models, this attribute is irrelevant and has to be empty!

    Returns
    -------
    `pandas.Series`: Interpolated value for the given interpolation times.
    """
    # Check, if time series data is available for all stations in the survey:
    # - Survey:
    if self.name not in correction_time_series.surveys:
        raise RuntimeError(f'No correction time series data available for survey "{self.name}".')
    # - Stations in Survey:
    missing_stations = list(
        set(correction_time_series.surveys[self.name].station_names) - set(self.observed_stations))
    if len(missing_stations) > 0:
        raise RuntimeError(
            f'No correction time series data available for the stations: ' + ', '.join(missing_stations))

    # Prep. input observation dataframe: Keep required columns only:
    tmp_df = self.obs_df[['station_name', 'obs_epoch', 'duration_sec']].copy(deep=True)
    # Shift obs reference epoch from start to the middle of the gravity reading
    # (= evaluation time for the tide model):
    tmp_df['obs_epoch'] = tmp_df['obs_epoch'] + pd.to_timedelta(tmp_df['duration_sec'], 'sec') / 2
    tmp_df.drop(columns=['duration_sec'], inplace=True)
    tmp_df['ts_tide_corr_mugal'] = np.nan

    # Loop over stations, interpolate corrections and add them to tmp_df:
    # - Check temporal data availability (scipy.interpolate.interp1 raises an error anyway)
    # - consider interpolation_method
    # - consider the model type (correction or effect)
    # - consider the units => µGal
    for station in self.observed_stations:
        tmp_filter = tmp_df['station_name'] == station
        obs_epochs_dt64 = tmp_df.loc[tmp_filter, 'obs_epoch'].to_numpy()
        interp = correction_time_series.surveys[self.name].stations[station].tidal_correction.interpolate(
            interp_times=obs_epochs_dt64,
            kind=interpolation_method,
            return_correction=True)
        interp_mugal = convert_to_mugal(interp,
                                        correction_time_series.surveys[self.name].stations[
                                            station].tidal_correction.unit)
        tmp_df.loc[tmp_filter, 'ts_tide_corr_mugal'] = interp_mugal
    tide_corr_timeseries_mugal = tmp_df['ts_tide_corr_mugal'].to_numpy()
    return tide_corr_timeseries_mugal

init_missing_attributes(verbose=True)

Initialize attributes defined in _SURVEY_ATTRIBUTES_INIT, if they are missing the current Survey instance.

Notes

This method is useful to establish downward compatibility between the current GravTools version and campaign data (pkl files) created/saved with previous version.

Parameters:

Name Type Description Default
verbose (bool, optional(default=False))

If True, messages are printed in the command line interface.

 True
Source code in gravtools/models/survey.py 
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
def init_missing_attributes(self, verbose=True):
    """Initialize attributes defined in `_SURVEY_ATTRIBUTES_INIT`, if they are missing the current Survey instance.

    Notes
    -----
    This method is useful to establish downward compatibility between the current GravTools version and campaign
    data (pkl files) created/saved with previous version.

    Parameters
    ----------
    verbose : bool, optional (default=False)
        If True, messages are printed in the command line interface.
    """
    attributes = dir(self)
    for attribute, init_value in self._SURVEY_ATTRIBUTES_INIT.items():
        if attribute not in attributes:
            setattr(self, attribute, init_value)
            if verbose:
                print(
                    f'Added attribute "{attribute}" (init. value: "{init_value}") to Survey object of survey "{self.name}".')

obs_df_drop_redundant_columns()

Drop all columns of obs_df that are not listed in self._OBS_DF_COLUMNS

Source code in gravtools/models/survey.py 
1363
1364
1365
1366
def obs_df_drop_redundant_columns(self):
    """Drop all columns of obs_df that are not listed in self._OBS_DF_COLUMNS"""
    columns_to_be_dropped = list(set(self.obs_df.columns) - set(self._OBS_DF_COLUMNS))
    self.obs_df.drop(columns=columns_to_be_dropped, inplace=True)

obs_df_populate_locations_from_stations(stations, verbose=False)

Populates the longitude, latitude and height columns with values from a Station object.

Parameters:

Name Type Description Default
stations :py:obj:`.Station` object

Station data (datum- and non-datum-stations).

 required
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Notes
  • Only update data for stations with data available from sources other than the gravimeter observation file! The data from the observation file has been added anyway.
Source code in gravtools/models/survey.py 
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
def obs_df_populate_locations_from_stations(self, stations, verbose=False):
    """Populates the longitude, latitude and height columns with values from a Station object.

    Parameters
    ----------
    stations : :py:obj:`.Station` object
        Station data (datum- and non-datum-stations).

    verbose : bool, optional (default=False)
        If True, status messages are printed to the command line.

    Notes
    -----
    - Only update data for stations with data available from sources other than the gravimeter observation file!
      The data from the observation file has been added anyway.
    """
    if verbose:
        print(f'Survey "{self.name}": Get locations for observation and heights from station data')
    tmp_filter = stations.stat_df['source_type'] != 'obs_file'
    if not tmp_filter.any():
        if verbose:
            print(f' - No station data available.')
        return

    # Merge stations Dataframe and observations DataFrame  by the station names:
    tmp_stat_df = stations.stat_df.loc[tmp_filter, ['station_name', 'long_deg', 'lat_deg', 'height_m']].copy(
        deep=True)
    tmp_stat_df = tmp_stat_df.rename(
        columns={'long_deg': 'tmp_lon_deg', 'lat_deg': 'tmp_lat_deg', 'height_m': 'tmp_alt_m'})
    self.obs_df = self.obs_df.merge(tmp_stat_df, on='station_name', how='left')
    tmp_filter = ~self.obs_df['tmp_lat_deg'].isna() & ~self.obs_df['tmp_lat_deg'].isna() & ~self.obs_df[
        'tmp_alt_m'].isna()
    self.obs_df.loc[tmp_filter, 'lon_deg'] = self.obs_df.loc[tmp_filter, 'tmp_lon_deg']
    self.obs_df.loc[tmp_filter, 'lat_deg'] = self.obs_df.loc[tmp_filter, 'tmp_lat_deg']
    self.obs_df.loc[tmp_filter, 'alt_m'] = self.obs_df.loc[tmp_filter, 'tmp_alt_m']

    # Drop columns that are not required and check for validity:
    self.obs_df_drop_redundant_columns()
    self.obs_df = self._obs_df_reorder_columns(self.obs_df)
    valid_flag, error_msg = self.check_obs_df(verbose=verbose)
    if not valid_flag:
        raise RuntimeError(error_msg)

obs_df_populate_vg_from_stations(stations, verbose=False)

Populates the vertical gradient columns of the observation DataFrame with values from a Station object.

Parameters:

Name Type Description Default
stations :py:obj:`.Station` object

Station data (datum- and non-datum-stations).

 required
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Notes

If an observed station is not present in the station object, or the station has no vertical gradient in the station object, the default vertical gradient is assigned to the observation.

Source code in gravtools/models/survey.py 
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
def obs_df_populate_vg_from_stations(self, stations, verbose=False):
    """Populates the vertical gradient columns of the observation DataFrame with values from a Station object.

    Parameters
    ----------
    stations : :py:obj:`.Station` object
        Station data (datum- and non-datum-stations).

    verbose : bool, optional (default=False)
        If True, status messages are printed to the command line.

    Notes
    -----
    If an observed station is not present in the station object, or the station has no vertical gradient in the
    station object, the default vertical gradient is assigned to the observation.

    """
    # Merge stations Dataframe (`stat_df`) and observations DataFrame (`obs_df`) by the station names:
    self.obs_df = self.obs_df.merge(stations.stat_df[['station_name', 'vg_mugalm']], on='station_name',
                                    how='left', suffixes=('_x', ''))

    # Populate all missing VGs with the default value:
    self.obs_df.loc[self.obs_df['vg_mugalm'].isna(), 'vg_mugalm'] = VG_DEFAULT

    # Drop columns that are not required and check for validity:
    self.obs_df_drop_redundant_columns()
    self.obs_df = self._obs_df_reorder_columns(self.obs_df)
    valid_flag, error_msg = self.check_obs_df(verbose=verbose)
    if not valid_flag:
        raise RuntimeError(error_msg)

reduce_observations(target_ref_height=None, target_tide_corr=None, target_atm_pres_corr=None, target_scale_corr=None, target_oceanload_corr=None, atm_pres_admittance=ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT, tide_corr_timeseries_interpol_method='', correction_time_series=None, gravimeters=None, verbose=False)

Reduce the observed gravity values by applying the selected corrections.

The following corrections can be applied:

  • Reference height: Using the vertical gravity gradient at the measurement points (from station data file) and the vertical distances between instrument top, sensor height, ground and control point, the observations are reduced to the selected reference height. Information on the reference height of the input data (usually sensor height, as observed) and the target reference height are required.

  • Tidal correction: Observations are reduced due tidal gravitational attraction (caused by sun and moon). The applied model to determine the corrections for each observation, dependent on the location and time, can be selected. Information on the tidal corrections that were already applied on the input data is required

  • Atmospheric pressure variations: This correction is based on normal air pressure (ISO model), measured pressure at site and an admittance factor (default: 0.3).

  • Linear gravimeter scale factor: A priori linear scale factor are applied on the uncorrected gravity readings. The scale factors are instrument and time dependent and can be loaded from dedicated gravimeter files.

Notes
  • For the reduction of the reference height vertical gravity gradients are required!

Parameters:

Name Type Description Default
target_ref_height string, specifying the target reference height type (default = `None`).

The target reference height type has to be listed in :py:obj:gravtools.settings.REFERENCE_HEIGHT_TYPE. Default is None indicating that the reference heights of the input data are not changed.

 None
target_tide_corr str, specifying the tidal correction type to be applied (default = `None`).

The target tidal correction type specifies what kind of tidal correction will be applied. Valid types have to be listed in :py:obj:gravtools.settings.TIDE_CORRECTION_TYPES. Default is None indicating that the tidal corrections are not considered here (tidal corrections are inherited from input data).

 None
target_atm_pres_corr str, optional (default = `None`)

Specifying the atmospheric pressure correction type to be applied to all surveys. Valid types to be listed in :py:obj:gravtools.settings.ATM_PRES_CORRECTION_TYPES. Default is None indicating that the respective corrections of the input data are not changed.

 None
target_oceanload_corr str, optional (default = `None`)

Specifying the ocean-loading correction type to be applied to all surveys (if available). Valid types to be listed in :py:obj:gravtools.settings.OCEANLOAD_CORRECTION_TYPES. Default is None indicating that the respective corrections of the input data are not changed.

 None
target_scale_corr str, optional (default = `None`)

Specifies the scale correction type to be applied on all observations of this survey. Vali types are listed in :py:obj:gravtools.settings.SCALE_CORRECTION_TYPES. The default value None indicates that the respective corrections of the input data will not be changed.

 None
atm_pres_admittance float, optional (default = `settings.ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT`)

Admittance factor for the determination of pressure corrections based on the difference between measured and normal air pressure. The default value is taken from settings.ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT.

 ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT
tide_corr_timeseries_interpol_method (str, optional(default=''))

Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are obtained from other sources or models, this attribute is irrelevant and has to be empty!

 ''
correction_time_series `CorrectionTimeSeries` object, optional (default=None)

Correction time series object that contains time series of tidal corrections for stations in surveys. This argument is required, if tidal corrections should be derived from time series data, i.e. if self.target_tide_corr = from_time_series.

 None
gravimeters Gravimeter object, optional (default=`None`)

Gravimeter object containing relevant information such as height differences for height corrections and scaling information.

 None
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Source code in gravtools/models/survey.py 
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
def reduce_observations(self,
                        target_ref_height: str = None,
                        target_tide_corr: str = None,
                        target_atm_pres_corr: str = None,
                        target_scale_corr: str = None,
                        target_oceanload_corr: str = None,
                        atm_pres_admittance: float = ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT,
                        tide_corr_timeseries_interpol_method='',
                        correction_time_series=None,
                        gravimeters=None,
                        verbose: bool = False,
                        ) -> [bool, str]:
    """Reduce the observed gravity values by applying the selected corrections.

    The following corrections can be applied:

    - Reference height: Using the vertical gravity gradient at the measurement points (from station data file) and
      the vertical distances between instrument top, sensor height, ground and control point, the observations are
      reduced to the selected reference height. Information on the reference height of the input data (usually
      sensor height, as observed) and the target reference height are required.

    - Tidal correction: Observations are reduced due tidal gravitational attraction (caused by sun and moon).
      The applied model to determine the corrections for each observation, dependent on the location and time, can
      be selected. Information on the tidal corrections that were already applied on the input data is required

    - Atmospheric pressure variations: This correction is based on normal air pressure (ISO model), measured
      pressure at site and an admittance factor (default: 0.3).

    - Linear gravimeter scale factor: A priori linear scale factor are applied on the uncorrected gravity readings.
      The scale factors are instrument and time dependent and can be loaded from dedicated gravimeter files.

    Notes
    -----
    - For the reduction of the reference height vertical gravity gradients are required!

    Parameters
    ----------
    target_ref_height : string, specifying the target reference height type (default = `None`).
        The target reference height type has to be listed in :py:obj:`gravtools.settings.REFERENCE_HEIGHT_TYPE`.
        Default is `None` indicating that the reference heights of the input data are not changed.
    target_tide_corr : str, specifying the tidal correction type to be applied (default = `None`).
        The target tidal correction type specifies what kind of tidal correction will be applied. Valid types have
        to be listed in :py:obj:`gravtools.settings.TIDE_CORRECTION_TYPES`. Default is `None` indicating that the
        tidal corrections are not considered here (tidal corrections are inherited from input data).
    target_atm_pres_corr : str, optional (default = `None`)
        Specifying the atmospheric pressure correction type to be applied to all surveys. Valid types to be listed
        in :py:obj:`gravtools.settings.ATM_PRES_CORRECTION_TYPES`. Default is `None` indicating that the respective
        corrections of the input data are not changed.
    target_oceanload_corr : str, optional (default = `None`)
        Specifying the ocean-loading correction type to be applied to all surveys (if available). Valid types to be
        listed in :py:obj:`gravtools.settings.OCEANLOAD_CORRECTION_TYPES`. Default is `None` indicating that the
        respective corrections of the input data are not changed.
    target_scale_corr : str, optional (default = `None`)
        Specifies the scale correction type to be applied on all observations of this survey. Vali types are listed
        in :py:obj:`gravtools.settings.SCALE_CORRECTION_TYPES`. The default value `None` indicates that the
        respective corrections of the input data will not be changed.
    atm_pres_admittance : float, optional (default = `settings.ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT`)
        Admittance factor for the determination of pressure corrections based on the difference between measured and
        normal air pressure. The default value is taken from `settings.ATM_PRES_CORRECTION_ADMITTANCE_DEFAULT`.
    tide_corr_timeseries_interpol_method : str, optional (default='')
        Interpolation method used to calculate tidal corrections from time series data. If tidal corrections are
        obtained from other sources or models, this attribute is irrelevant and has to be empty!
    correction_time_series : `CorrectionTimeSeries` object, optional (default=None)
        Correction time series object that contains time series of tidal corrections for stations in surveys. This
        argument is required, if tidal corrections should be derived from time series data, i.e. if
        `self.target_tide_corr = from_time_series`.
    gravimeters : Gravimeter object, optional (default=`None`)
        Gravimeter object containing relevant information such as height differences for height corrections and
        scaling information.
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.
    """
    # Init.:
    tide_corr_timeseries_interpol_method_out = ''

    # Changes for compatibility to GravTools versions before 0.2.7:
    if self.obs_tide_correction_type == 'cg5_longman1959':
        self.obs_tide_correction_type = 'instrumental_corr'

    # Create a copy auf obs_df in order prevent problems with manipulation assigned py reference variables:
    obs_df = self.obs_df.copy(deep=True)

    # Initialize pandas series for reduced data by copying the observation data as loaded from the input file:
    g_red_mugal = obs_df['g_obs_mugal'].copy(deep=True)
    sd_g_red_mugal = obs_df['sd_g_obs_mugal']

    # Check whether field for reduced data are initialized correctly:
    flag_all_field_are_nan = all([obs_df['g_red_mugal'].isna().all(),
                                  obs_df['sd_g_red_mugal'].isna().all(),
                                  obs_df['corr_tide_red_mugal'].isna().all()
                                  ])
    flag_no_field_is_nan = all([
        all(~obs_df['g_red_mugal'].isna().values),
        all(~obs_df['sd_g_red_mugal'].isna().values),
        all(~obs_df['corr_tide_red_mugal'].isna().values)])
    if not (flag_all_field_are_nan or flag_no_field_is_nan):
        error_msg = 'In "obs_df" the columns "g_red_mugal", "sd_g_red_mugal" and "corr_tide_red_mugal" are not ' \
                    'initialized consistently! '
        raise RuntimeError(f'Survey "{self.name}":' + error_msg)

    if verbose:
        print(f'## Calculate reduced observations by applying the specified corrections:')

    # 0.) Scale correction:
    if (target_scale_corr is None) or (target_scale_corr == 'no_scale'):
        if verbose:
            print(f'No scaling correction applied.')
    elif target_scale_corr == 'linear_scale':
        if verbose:
            print(f'Apply linear scaling correction')

        # Remove instrumental tidal corrections first:
        if self.obs_tide_correction_type == 'instrumental_corr':
            g_red_mugal = g_red_mugal - obs_df['corr_tide_mugal']  # Undo instrumental corrections => No tide corr!
        elif self.obs_tide_correction_type == 'no_tide_corr':
            pass  # Already OK!
        else:
            raise RuntimeError(f'Not able to remove tidal corrections for the calculation of uncorrected '
                               f'observations in survey {self.name}. Tidal corrections '
                               f'{self.obs_tide_correction_type} cannot be removed properly.')

        # Apply scaling:
        tmp_g_df = pd.DataFrame({'epoch_dt': obs_df['obs_epoch'], 'g': g_red_mugal})
        tmp_g_df = gravimeters.apply_linear_scale(gravimeter_type=self.gravimeter_type,
                                                  serial_number=self.gravimeter_serial_number,
                                                  gravity_df=tmp_g_df,
                                                  verbose=True)
        g_red_mugal = tmp_g_df['g_scaled']
        linear_scale = tmp_g_df['linear_scale']

        # Add instrumental tidal corrections again:
        if self.obs_tide_correction_type == 'instrumental_corr':
            g_red_mugal = g_red_mugal + obs_df['corr_tide_mugal']
    else:
        raise RuntimeError(f'Unknown scaling correction type: {target_scale_corr}')

    # 1.) Check reference heights:
    if verbose:
        print(
            f'Reduction of reference heights to "{target_ref_height}" ({REFERENCE_HEIGHT_TYPE[target_ref_height]}):')

    if target_ref_height is None:  # Do nothing
        if verbose:
            print(f' - Reference heights are not changed!')
    else:
        # Check if the target reference height type is valid:
        if target_ref_height not in REFERENCE_HEIGHT_TYPE:
            raise ValueError(f'"{target_ref_height}" is an unknown reference height type.')

        # Check if reduction is necessary:
        if self.obs_reference_height_type == target_ref_height:
            if verbose:
                print(f' - Observations are already referenced to: {target_ref_height}')
        else:
            # Check, if VG are available in obs_df:
            if obs_df.vg_mugalm.isna().any():
                error_msg = f'For the following stations the vertical gravity gradient is not available: ' \
                            f'{", ".join(obs_df[obs_df.vg_mugalm.isna()].station_name.unique())}. ' \
                            f'Without vertical gradient the observed gravity cannot be reduced to another height ' \
                            f'level! '
                raise RuntimeError(f'Survey "{self.name}":' + error_msg)

            # Reduction:
            # Distance between instrument top and sensor level:
            dst_m = gravimeters.get_height_offset(self.gravimeter_type, self.gravimeter_serial_number)
            if self.obs_reference_height_type == 'sensor_height':
                if target_ref_height == 'control_point':
                    # + dst_m + dhf_m
                    g_red_mugal = g_red_mugal + (dst_m + obs_df['dhf_m']) * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'instrument_top':
                    # + dst_m
                    g_red_mugal = g_red_mugal + dst_m * obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'ground':
                    # + dst_m + dhb_m
                    g_red_mugal = g_red_mugal + (dst_m + obs_df['dhb_m']) * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
            elif self.obs_reference_height_type == 'instrument_top':
                if target_ref_height == 'sensor_height':
                    # - dst_m
                    g_red_mugal = g_red_mugal - dst_m * obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'ground':
                    # + dhb_m
                    g_red_mugal = g_red_mugal + obs_df['dhb_m'] * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'control_point':
                    # + dhf_m
                    g_red_mugal = g_red_mugal + obs_df['dhf_m'] * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
            elif self.obs_reference_height_type == 'ground':
                if target_ref_height == 'instrument_top':
                    # - dhb_m - dst_m + dst_m = - dhb_m
                    g_red_mugal = g_red_mugal - obs_df['dhb_m'] * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'sensor_height':
                    # - dhb_m - dst_m
                    g_red_mugal = g_red_mugal - (obs_df['dhb_m'] + dst_m) * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'control_point':
                    # - dhb_m - dst_m + dhf_m + dst_m = dhf_m - dhb_m
                    g_red_mugal = g_red_mugal + \
                                  (obs_df['dhf_m'] - obs_df['dhb_m']) * obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
            elif self.obs_reference_height_type == 'control_point':
                if target_ref_height == 'instrument_top':
                    # - dhf_m - dst_m + dst_m = - dhf_m
                    g_red_mugal = g_red_mugal - obs_df['dhf_m'] * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'ground':
                    # - dhf_m - dst_m + dst_m + dhb_m = dhb_m - dhf_m
                    g_red_mugal = g_red_mugal + \
                                  (obs_df['dhb_m'] - obs_df['dhf_m']) * obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
                elif target_ref_height == 'sensor_height':
                    # - dhf_m - dst_m
                    g_red_mugal = g_red_mugal - (obs_df['dhf_m'] + dst_m) * \
                                  obs_df['vg_mugalm']
                    # sd_g_red_mugal = sd_g_red_mugal  # Keep SD
            if verbose:
                print('...done!')

    # 2.) Check tidal corrections:
    if target_tide_corr is None:  # Do nothing
        if verbose:
            print(f'Tidal corrections are not changed!')
    else:
        # Check if the target tidal correction type is valid:
        if target_tide_corr not in TIDE_CORRECTION_TYPES:
            error_msg = f'"{target_tide_corr}" is invalid!'
            raise RuntimeError(f'Survey "{self.name}":' + error_msg)
        tide_correction_description = TIDE_CORRECTION_TYPES[target_tide_corr]
        if verbose:
            print(f'Tidal corrections "{target_tide_corr}" ({tide_correction_description}):')
        # Check if reduction is necessary and/or possible:
        # - If time series data is used, corrections have to be calculated anyway, because the time series
        #   may have changed since their last determination!
        if (self.obs_tide_correction_type == target_tide_corr) & (target_tide_corr != 'from_time_series'):
            if verbose:
                print(f' - Observations are already reduced by: {target_tide_corr}')
            if target_tide_corr == 'no_tide_corr':
                corr_tide_red_mugal = obs_df['corr_tide_mugal'].copy(deep=True)
                corr_tide_red_mugal[:] = 0
            else:
                corr_tide_red_mugal = obs_df['corr_tide_mugal']

        elif self.obs_tide_correction_type == 'unknown':
            error_msg = 'Unknown tidal corrections at input data!'
            raise RuntimeError(f'Survey "{self.name}":' + error_msg)
        else:
            if self.obs_tide_correction_type == 'no_tide_corr':
                if target_tide_corr == 'instrumental_corr':
                    g_red_mugal = g_red_mugal + obs_df['corr_tide_mugal']
                    corr_tide_red_mugal = obs_df['corr_tide_mugal']
                elif target_tide_corr == 'longman1959':
                    corr_tide_red_mugal = self.get_tidal_corrections_from_longman1959()
                    g_red_mugal = g_red_mugal + corr_tide_red_mugal
                elif target_tide_corr == 'from_time_series':
                    corr_tide_red_mugal = self.get_tidal_corrections_from_timeseries(
                        correction_time_series=correction_time_series,
                        interpolation_method=tide_corr_timeseries_interpol_method)
                    g_red_mugal = g_red_mugal + corr_tide_red_mugal
                    tide_corr_timeseries_interpol_method_out = tide_corr_timeseries_interpol_method

            elif self.obs_tide_correction_type == 'instrumental_corr':
                g_red_mugal = g_red_mugal - obs_df[
                    'corr_tide_mugal']  # Undo instrumental corrections => No tide corr!
                if target_tide_corr == 'no_tide_corr':
                    corr_tide_red_mugal = obs_df['corr_tide_mugal'].copy(deep=True)
                    corr_tide_red_mugal[:] = 0
                elif target_tide_corr == 'longman1959':
                    corr_tide_red_mugal = self.get_tidal_corrections_from_longman1959()
                    g_red_mugal = g_red_mugal + corr_tide_red_mugal
                elif target_tide_corr == 'from_time_series':
                    corr_tide_red_mugal = self.get_tidal_corrections_from_timeseries(
                        correction_time_series=correction_time_series,
                        interpolation_method=tide_corr_timeseries_interpol_method)
                    g_red_mugal = g_red_mugal + corr_tide_red_mugal
                    tide_corr_timeseries_interpol_method_out = tide_corr_timeseries_interpol_method

            elif self.obs_tide_correction_type == 'longman1959':
                # This should never be the case!
                g_red_mugal = g_red_mugal - obs_df[
                    'corr_tide_red_mugal']  # Undo corrections => No tide corr!
                if target_tide_corr == 'no_tide_corr':
                    corr_tide_red_mugal = obs_df['corr_tide_mugal'].copy(deep=True)
                    corr_tide_red_mugal[:] = 0
                elif target_tide_corr == 'instrumental_corr':
                    g_red_mugal = g_red_mugal + obs_df['corr_tide_mugal']
                    corr_tide_red_mugal = obs_df['corr_tide_mugal']
                elif target_tide_corr == 'from_time_series':
                    corr_tide_red_mugal = self.get_tidal_corrections_from_timeseries(
                        correction_time_series=correction_time_series,
                        interpolation_method=tide_corr_timeseries_interpol_method)
                    g_red_mugal = g_red_mugal + corr_tide_red_mugal
                    tide_corr_timeseries_interpol_method_out = tide_corr_timeseries_interpol_method
            else:
                raise RuntimeError(f'Tidal corrections of observation data ("{self.obs_tide_correction_type}") not '
                                   f'supported!')
            if verbose:
                print('...done!')

    # 3.) Check atmospheric pressure corrections:
    if target_atm_pres_corr is None:  # Do nothing
        if verbose:
            print(f'Atmospheric pressure corrections are not changed!')
    else:
        # Check if the target correction type is valid:
        if target_atm_pres_corr not in ATM_PRES_CORRECTION_TYPES:
            error_msg = f'"{target_atm_pres_corr}" is invalid!'
            raise RuntimeError(f'Survey "{self.name}":' + error_msg)
        if verbose:
            print(
                f'Atmospheric pressure corrections "{target_atm_pres_corr}" ({ATM_PRES_CORRECTION_TYPES[target_atm_pres_corr]}):')

        # Check, if an admittance factor is available:
        if atm_pres_admittance is None:
            error_msg = (f'The admittance factor for the determination of atmospheric pressure corrections is not'
                         f'available (is None).')
            raise RuntimeError(f'Survey "{self.name}":' + error_msg)

        if self.obs_atm_pres_correction_type == 'no_atm_pres_corr':
            if target_atm_pres_corr == 'no_atm_pres_corr':
                corr_atm_pres_red_mugal = None
                norm_atm_pres_hpa = np.nan
            if target_atm_pres_corr == 'iso_2533_1975':
                height_m = obs_df['alt_m']
                atm_pres_hpa = obs_df['atm_pres_hpa']
                corr_atm_pres_red_mugal, norm_atm_pres_hpa = atmosphere_correction.pressure_correction_iso_pandas_series(
                    height_m,
                    atm_pres_hpa,
                    admittance=atm_pres_admittance)
                # Apply non-NaN values only:
                tmp_filter = ~corr_atm_pres_red_mugal.isna()
                g_red_mugal.loc[tmp_filter] = g_red_mugal.loc[tmp_filter] - corr_atm_pres_red_mugal.loc[tmp_filter]
                if verbose:
                    num_with_p_corr = len(tmp_filter.loc[tmp_filter])
                    number_of_obs = len(tmp_filter)
                    if num_with_p_corr != number_of_obs:
                        print(
                            f'WARNING: Pressure corrections are available for {num_with_p_corr} of {number_of_obs} observations in survey {self.name} only, probably due to missing pressure observations.')

        # This case should not be possible wit the current instruments since they are not capable to calculate
        # atmospheric corrections and provide them along with the observation data in the input files!
        # elif self.obs_atm_pres_correction_type == 'iso_2533_1975':
        #     # Undo the corrections...
        #     if target_atm_pres_corr == 'no_atm_pres_corr':
        #         corr_atm_pres_red_mugal = 0

        else:
            raise RuntimeError(f'Atmosphere pressure corrections of observation data '
                               f'("{self.obs_atm_pres_correction_type}") not supported!')
        if verbose:
            print('...done!')

    # 4.) Check ocean-loading corrections:
    if target_oceanload_corr is None:  # Do nothing
        if verbose:
            print(f'Ocean loading corrections are not changed!')
    else:
        # Check if the target correction type is valid:
        if target_oceanload_corr not in OCEANLOAD_CORRECTION_TYPES:
            error_msg = f'"{target_oceanload_corr}" is invalid!'
            raise RuntimeError(f'Survey "{self.name}":' + error_msg)
        if verbose:
            print(
                f'Ocean-loading corrections "{target_oceanload_corr}" ({OCEANLOAD_CORRECTION_TYPES[target_oceanload_corr]}):')

        if self.obs_oceanload_correction_type == 'no_oceanload_corr':
            if target_oceanload_corr == 'no_oceanload_corr':
                if verbose:
                    print(f' - Observations are already reduced by: {target_oceanload_corr}')
                corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal'].copy(deep=True)
                corr_oceanload_red_mugal[:] = 0  # Set to zero
            if target_oceanload_corr == 'instrumental_corr':
                # Check correction data availability:
                if np.isnan(obs_df['corr_oceanload_instrument_mugal']).all():
                    corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal'].copy(deep=True)
                    corr_oceanload_red_mugal[:] = 0  # Set to zero
                else:  # corrections available
                    corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal']
                    g_red_mugal = g_red_mugal + corr_oceanload_red_mugal  # TODO: correct sign?
        elif self.obs_oceanload_correction_type == 'instrumental_corr':
            if target_oceanload_corr == 'no_oceanload_corr':
                corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal'].copy(deep=True)
                corr_oceanload_red_mugal[:] = 0  # Set to zero
                g_red_mugal = g_red_mugal - obs_df['corr_oceanload_instrument_mugal']  # TODO: correct sign?
            if target_oceanload_corr == 'instrumental_corr':
                if verbose:
                    print(f' - Observations are already reduced by: {target_oceanload_corr}')
                corr_oceanload_red_mugal = obs_df['corr_oceanload_instrument_mugal']
        else:
            raise RuntimeError(f'Ocean-loading corrections of observation data '
                               f'("{self.obs_oceanload_correction_type}") not supported!')

    # 5.) Apply changes, if no exceptions were raised:
    self.red_tide_correction_type = target_tide_corr
    self.red_reference_height_type = target_ref_height
    self.red_atm_pres_correction_type = target_atm_pres_corr
    self.red_oceanload_correction_type = target_oceanload_corr
    self.red_tide_correction_description = tide_correction_description
    self.red_tide_corr_timeseries_interpol_method = tide_corr_timeseries_interpol_method_out
    self.obs_df['g_red_mugal'] = g_red_mugal
    self.obs_df['sd_g_red_mugal'] = sd_g_red_mugal
    if target_tide_corr is not None:
        self.obs_df['corr_tide_red_mugal'] = corr_tide_red_mugal
    if target_atm_pres_corr is not None:
        self.obs_df['corr_atm_pres_red_mugal'] = corr_atm_pres_red_mugal
        self.obs_df['norm_atm_pres_hpa'] = norm_atm_pres_hpa
    if target_oceanload_corr is not None:
        self.obs_df['corr_oceanload_red_mugal'] = corr_oceanload_red_mugal
    self.red_scale_correction_type = target_scale_corr
    if target_scale_corr == 'linear_scale':
        self.obs_df['linear_scale'] = linear_scale
    else:
        self.obs_df['linear_scale'] = np.nan

reset_setup_data(verbose=False)

Deletes the setup data.

Parameters:

Name Type Description Default
verbose (bool, optional(default=False))

If True, status messages are printed to the command line.

 False
Source code in gravtools/models/survey.py 
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
def reset_setup_data(self, verbose=False):
    """Deletes the setup data.

    Parameters
    ----------
    verbose : bool, optional (default=False)
        If `True`, status messages are printed to the command line.
    """
    if self.setup_df is None:
        if verbose:
            print('Nothing to delete. Setup data is empty.')
    else:
        if verbose:
            print('Setup data deleted.')
        self.setup_df = None
        self.setup_reference_height_type = ''
        self.setup_tide_correction_type = ''
        self.setup_atm_pres_correction_type = '',
        self.setup_scale_correction_type = '',
        self.setup_oceanload_correction_type = '',
        self.setup_calc_method = ''
        self.setup_obs_list_df = None

set_reference_time(ref_delta_t_dt)

Set reference time for the determination of relative time spans, e.g. for the drift polynomial.

Parameters:

Name Type Description Default
ref_delta_t_dt datetime object

Reference time epoch w.r.t. UTC.

 required
Source code in gravtools/models/survey.py 
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
def set_reference_time(self, ref_delta_t_dt):
    """Set reference time for the determination of relative time spans, e.g. for the drift polynomial.

    Parameters
    ----------
    ref_delta_t_dt : datetime object
        Reference time epoch w.r.t. UTC.
    """
    if isinstance(ref_delta_t_dt, dt.datetime):
        self.ref_delta_t_dt = ref_delta_t_dt
    else:
        raise ValueError('`ref_delta_t_dt` needs to be a datetime object.')