AMAROC-841 exclude instead of keep ceilos

docs/source/changes.rst

@@ -23,7 +23,7 @@ you still want to use as many ceilometers as possible to infer the amount.
 - If you use different ceilometer models and know that you want to calculate the
 height only from hits of a specific ceilometer model to avoid implementing
 complicated correction factors.
-To this end, the parameter ``CEILOS_FOR_BASE_HEIGHT_CALC`` was implemented in
+To this end, the parameter ``EXCLUDE_FOR_BASE_HEIGHT_CALC`` was implemented in
 this version. The default value is an empty list. In order to activate the
-filtering, it is sufficient to enter the ceilometer IDs of the ceilos to keep
-for the base height calculation.
+filtering, it is sufficient to enter the ceilometer IDs of the ceilos to exclude
+from the base height calculation.

src/ampycloud/data.py

@@ -529,9 +529,9 @@ def _calculate_sligrolay_base_height(
         for ind, cid in enumerate(cluster_ids):
             # Which hits are in this sli/gro/lay ?
             in_sligrolay = self.data[which[:-1]+'_id'] == cid
-            if self.prms['CEILOS_FOR_BASE_HEIGHT_CALC'] != []:
+            if self.prms['EXCLUDE_FOR_BASE_HEIGHT_CALC'] != []:
                 in_sligrolay_filtered = in_sligrolay * self.data['ceilo'].apply(
-                    lambda x: x in self.prms['CEILOS_FOR_BASE_HEIGHT_CALC']
+                    lambda x: x not in self.prms['EXCLUDE_FOR_BASE_HEIGHT_CALC']
                 )
                 # We require a minimum of hits by the filtered ceilos that belong to the layer
                 # of interest. Otherwise fall back to using all ceilos for the calculation.

src/ampycloud/prms/ampycloud_default_prms.yml

@@ -38,12 +38,12 @@ BASE_LVL_HEIGHT_PERC: 5
 # Set to 100 to use all the points.
 BASE_LVL_LOOKBACK_PERC: 100
 
-# If ceilo Ids are set, for any given layer/ group/ slice, only ceilos with the corresponding ID
-# will be used for base height calculation. If the selection results in an empty layer/ group/
+# If ceilo Ids are set, for any given layer/ group/ slice, ceilos with the corresponding ID
+# will be excluded from the base height calculation. If the selection results in an empty layer/ group/
 # slice, we go back to using all ceilo hits and ignore the selection. Use this switch if you want
-# to localize the height caclulation or if you only want ceilometers from a specific type in the
+# to localize the height caclulation or if you want to exclude ceilometers of a specific type in the
 # height calculation.
-CEILOS_FOR_BASE_HEIGHT_CALC: []
+EXCLUDE_FOR_BASE_HEIGHT_CALC: []
 
 # LOWESS parameters used to fit Slice/Groups/Layers height trends
 LOWESS:

test/ampycloud/test_data.py

@@ -438,7 +438,7 @@ def test_localized_base_height_calculation():
 
     mock_layer = _mock_layer_from_two_ceilos_with_narrow_stds_and_close_hits(100, 200)
     chunk_filtered = CeiloChunk(
-        mock_layer, prms={'CEILOS_FOR_BASE_HEIGHT_CALC': 'ceilo1'}
+        mock_layer, prms={'EXCLUDE_FOR_BASE_HEIGHT_CALC': 'ceilo2'}
     )
     chunk_filtered.find_slices()
     chunk_filtered.find_groups()
@@ -461,7 +461,7 @@ def test_localized_base_hgt_calc_fallback():
 
     mock_layer = _mock_layer_from_two_ceilos_with_narrow_stds_and_close_hits(2, 200)
     chunk_filtered = CeiloChunk(
-        mock_layer, prms={'CEILOS_FOR_BASE_HEIGHT_CALC': 'ceilo1'}
+        mock_layer, prms={'EXCLUDE_FOR_BASE_HEIGHT_CALC': 'ceilo2'}
     )
     chunk_filtered.find_slices()
     chunk_filtered.find_groups()