Small change to the beamb plugin that allows for specifying DBLIMIT and BBLIMIT in... jenkins-beamb-67
authorulf.nordh <a002011@c21601.ad.smhi.se>
Thu, 15 Aug 2019 11:06:55 +0000 (13:06 +0200)
committerulf.nordh <a002011@c21601.ad.smhi.se>
Thu, 15 Aug 2019 11:06:55 +0000 (13:06 +0200)
pybeamb/beamb_defines.py [new file with mode: 0644]
pybeamb/beamb_quality_plugin.py

diff --git a/pybeamb/beamb_defines.py b/pybeamb/beamb_defines.py
new file mode 100644 (file)
index 0000000..74469ca
--- /dev/null
@@ -0,0 +1,44 @@
+'''
+Copyright (C) 2005 - Swedish Meteorological and Hydrological Institute (SMHI)
+
+This file is part of RAVE.
+
+RAVE is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+RAVE 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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with RAVE.  If not, see <http://www.gnu.org/licenses/>.
+
+'''
+## Contains some parameters used by beamb_quality_plugin.py
+
+## @file
+## @author Ulf E. Nordh, SMHI
+## @date 2019-06-10
+#
+# This file will be imported by beamb_quality_plugin.py.
+
+
+##
+# The limit of the Gaussian approximation of main lobe
+#
+BEAMBLOCKAGE_DBLIMIT = -6.0
+
+##
+# The threshold for correcting beamblockage, must be between 0.0 and 1.0, if set to 1.0,
+# no masking with nodata will be done i.e correction will be done for all blockage up to 1.0
+# with 1.0 excluded due to that the underlying C-code cannot deal with 1.0 (division by zero). An attempt to set
+# the parameter smaller than 0.0 or larger than 1.0 will cause the restore function to abort.
+#
+BEAMBLOCKAGE_BBLIMIT = 0.7
+
+
+if __name__ == "__main__":
+    print(__doc__)
index 0d310fe..1dbbc9a 100644 (file)
@@ -34,20 +34,15 @@ import _polarscan
 import _polarvolume
 import _beamblockage
 
-logger = rave_pgf_logger.create_logger()
-
-##
-# The limit of the Gaussian approximation of main lobe
-#
-BEAMBLOCKAGE_DBLIMIT=-6.0
+# The plugin needs to have access to the two parameters below, stated in beamb_defines.py. Earlier
+# these parameters were given directly in the plugin but for convenience reasons e.g. when using 
+# other than default values and e.g. making re-installations it is better to have the parameters
+# specified in a separate file. If the data in beamb_defines.py is not changed, the plugin will
+# run with the default parameters which are BEAMBLOCKAGE_DBLIMIT = -6.0 and
+# BEAMBLOCKAGE_BBLIMIT = 1.0, the latter means that no masking with nodata will be done.
+from beamb_defines import BEAMBLOCKAGE_DBLIMIT, BEAMBLOCKAGE_BBLIMIT 
 
-##
-# The threshold for correcting beamblockage, must be between 0.0 and 1.0, if set to 1.0,
-# no masking with nodata will be done i.e correction will be done for all blockage up to 1.0
-# with 1.0 excluded due to that the underlying C-code cannot deal with 1.0 (division by zero). An attempt to set
-# the parameter smaller than 0.0 or larger than 1.0 will cause the restore function to abort.
-#
-BEAMBLOCKAGE_BBLIMIT= 1.0 
+logger = rave_pgf_logger.create_logger()
 
 ##
 # The beam blockage quality plugin
@@ -66,12 +61,12 @@ class beamb_quality_plugin(rave_quality_plugin):
   _cachedir = None
   
   ##
-  # The default beam blockage Gaussian approximation main lobe. Defaults to BEAMBLOCKAGE_DBLIMIT
+  # The default beam blockage Gaussian approximation main lobe. Defaults to -6.0 if not changed in beamb_defines.py.
   #
   _dblimit = BEAMBLOCKAGE_DBLIMIT
 
   ##
-  # The default percent beam blockage (divided by 100). Defaults to BEAMBLOCKAGE_BBLIMIT.
+  # The default percent beam blockage (divided by 100). Defaults 1.0 if not changed in beamb_defines.py.
   #
   _bblimit = BEAMBLOCKAGE_BBLIMIT