Improvements to Container classes

ctapipe/core/__init__.py

@@ -4,7 +4,7 @@
 """
 
 from .component import Component, non_abstract_children
-from .container import Container, Field, Map
+from .container import Container, Field, DeprecatedField, Map
 from .provenance import Provenance, get_module_version
 from .tool import Tool, ToolConfigurationError
 
@@ -13,6 +13,7 @@
     'Container',
     'Tool',
     'Field',
+    'DeprecatedField',
     'Map',
     'Provenance',
     'ToolConfigurationError',

ctapipe/core/container.py

@@ -28,12 +28,18 @@ def __init__(self, default, description="", unit=None, ucd=None):
         self.ucd = ucd
 
     def __repr__(self):
-        desc = f'{self.description}'
+        desc = f"{self.description}"
         if self.unit is not None:
-            desc += f' [{self.unit}]'
+            desc += f" [{self.unit}]"
         return desc
 
 
+class DeprecatedField(Field):
+    """ used to mark which fields may be removed in next version """
+
+    pass
+
+
 class ContainerMeta(type):
     """
     The MetaClass for the Containers
@@ -47,27 +53,24 @@ class ContainerMeta(type):
     """
 
     def __new__(cls, name, bases, dct):
-        field_names = [
-            k for k, v in dct.items()
-            if isinstance(v, Field)
-        ]
-        dct['__slots__'] = tuple(field_names + ['meta', 'prefix'])
-        dct['fields'] = {}
+        field_names = [k for k, v in dct.items() if isinstance(v, Field)]
+        dct["__slots__"] = tuple(field_names + ["meta", "prefix"])
+        dct["fields"] = {}
 
         # inherit fields from baseclasses
         for b in bases:
             if issubclass(b, Container):
                 for k, v in b.fields.items():
-                    dct['fields'][k] = v
+                    dct["fields"][k] = v
 
         for k in field_names:
-            dct['fields'][k] = dct.pop(k)
+            dct["fields"][k] = dct.pop(k)
 
         new_cls = type.__new__(cls, name, bases, dct)
 
         # if prefix was not set as a class variable, build a default one
-        if 'container_prefix' not in dct:
-            new_cls.container_prefix = name.lower().replace('container', '')
+        if "container_prefix" not in dct:
+            new_cls.container_prefix = name.lower().replace("container", "")
 
         return new_cls
 
@@ -142,10 +145,10 @@ def __setitem__(self, key, value):
 
     def items(self, add_prefix=False):
         """Generator over (key, value) pairs for the items"""
-        if not add_prefix or self.prefix == '':
+        if not add_prefix or self.prefix == "":
             return ((k, getattr(self, k)) for k in self.fields.keys())
 
-        return ((self.prefix + '_' + k, getattr(self, k)) for k in self.fields.keys())
+        return ((self.prefix + "_" + k, getattr(self, k)) for k in self.fields.keys())
 
     def keys(self):
         """Get the keys of the container"""
@@ -176,13 +179,14 @@ def as_dict(self, recursive=False, flatten=False, add_prefix=False):
             for key, val in self.items(add_prefix=add_prefix):
                 if isinstance(val, Container) or isinstance(val, Map):
                     if flatten:
-                        d.update({
-                            f"{key}_{k}": v
-                            for k, v in val.as_dict(
-                                recursive,
-                                add_prefix=add_prefix
-                            ).items()
-                        })
+                        d.update(
+                            {
+                                f"{key}_{k}": v
+                                for k, v in val.as_dict(
+                                    recursive, add_prefix=add_prefix
+                                ).items()
+                            }
+                        )
                     else:
                         d[key] = val.as_dict(
                             recursive=recursive, flatten=flatten, add_prefix=add_prefix
@@ -220,7 +224,7 @@ def __repr__(self):
             if isinstance(getattr(self, name), Map):
                 extra = "[*]"
             desc = "{:>30s}: {}".format(name + extra, repr(item))
-            lines = wrap(desc, 80, subsequent_indent=' ' * 32)
+            lines = wrap(desc, 80, subsequent_indent=" " * 32)
             text.extend(lines)
         return "\n".join(text)
 
@@ -239,17 +243,17 @@ def as_dict(self, recursive=False, flatten=False, add_prefix=False):
             for key, val in self.items():
                 if isinstance(val, Container) or isinstance(val, Map):
                     if flatten:
-                        d.update({
-                            f"{key}_{k}": v
-                            for k, v in val.as_dict(
-                                recursive, add_prefix=add_prefix
-                            ).items()
-                        })
+                        d.update(
+                            {
+                                f"{key}_{k}": v
+                                for k, v in val.as_dict(
+                                    recursive, add_prefix=add_prefix
+                                ).items()
+                            }
+                        )
                     else:
                         d[key] = val.as_dict(
-                            recursive=recursive,
-                            flatten=flatten,
-                            add_prefix=add_prefix,
+                            recursive=recursive, flatten=flatten, add_prefix=add_prefix
                         )
                     continue
                 d[key] = val

ctapipe/core/traits.py

@@ -3,7 +3,6 @@
 from traitlets import (
     Bool,
     CaselessStrEnum,
-    CRegExp,
     Dict,
     Enum,
     Float,
@@ -15,6 +14,8 @@
     TraitType,
     Unicode,
     observe,
+    Set,
+    CRegExp,
 )
 from traitlets.config import boolean_flag as flag
 
@@ -30,6 +31,7 @@
     "Long",
     "List",
     "Bool",
+    "Set",
     "CRegExp",
     "Dict",
     "flag",
@@ -43,20 +45,21 @@
 
 
 class Path(TraitType):
+    """
+    A path Trait for input/output files.
+
+    Parameters
+    ----------
+    exists: boolean or None
+        If True, path must exist, if False path must not exist
+
+    directory_ok: boolean
+        If False, path must not be a directory
+    file_ok: boolean
+        If False, path must not be a file
+    """
+
     def __init__(self, exists=None, directory_ok=True, file_ok=True):
-        """
-        A path Trait for input/output files.
-
-        Parameters
-        ----------
-        exists: boolean or None
-            If True, path must exist, if False path must not exist
-
-        directory_ok: boolean
-            If False, path must not be a directory
-        file_ok: boolean
-            If False, path must not be a file
-        """
         super().__init__()
         self.exists = exists
         self.directory_ok = directory_ok

ctapipe/image/concentration.py

@@ -4,34 +4,34 @@
 
 
 def concentration(geom, image, hillas_parameters):
-    '''
+    """
     Calculate concentraion values.
 
     Concentrations are ratios of the amount of light in certain
     areas to the full intensity of the image.
 
     These features are usefull for g/h separation and energy estimation.
-    '''
+    """
 
     h = hillas_parameters
 
     delta_x = geom.pix_x - h.x
     delta_y = geom.pix_y - h.y
 
     # sort pixels by distance to cog
-    cog_pixels = np.argsort(delta_x**2 + delta_y**2)
+    cog_pixels = np.argsort(delta_x ** 2 + delta_y ** 2)
     conc_cog = np.sum(image[cog_pixels[:3]]) / h.intensity
 
     longi, trans = camera_to_shower_coordinates(geom.pix_x, geom.pix_y, h.x, h.y, h.psi)
 
     # get all pixels inside the hillas ellipse
-    mask_core = (longi**2 / h.length**2) + (trans**2 / h.width**2) <= 1.0
+    mask_core = (longi ** 2 / h.length ** 2) + (trans ** 2 / h.width ** 2) <= 1.0
     conc_core = image[mask_core].sum() / h.intensity
 
     concentration_pixel = image.max() / h.intensity
 
     return ConcentrationContainer(
-        concentration_cog=conc_cog,
-        concentration_core=conc_core,
-        concentration_pixel=concentration_pixel,
+        cog=conc_cog,
+        core=conc_core,
+        pixel=concentration_pixel,
     )

ctapipe/image/leakage.py

@@ -6,11 +6,11 @@
 from ..io.containers import LeakageContainer
 
 
-__all__ = ['leakage']
+__all__ = ["leakage"]
 
 
 def leakage(geom, image, cleaning_mask):
-    '''
+    """
     Calculating the leakage-values for a given image.
     Image must be cleaned for example with tailcuts_clean.
     Leakage describes how strong a shower is on the edge of a telescope.
@@ -27,7 +27,7 @@ def leakage(geom, image, cleaning_mask):
     Returns
     -------
     LeakageContainer
-    '''
+    """
     border1 = geom.get_border_pixel_mask(1)
     border2 = geom.get_border_pixel_mask(2)
 
@@ -43,8 +43,8 @@ def leakage(geom, image, cleaning_mask):
     size = np.sum(image[cleaning_mask])
 
     return LeakageContainer(
-        leakage1_pixel=leakage_pixel1 / geom.n_pixels,
-        leakage2_pixel=leakage_pixel2 / geom.n_pixels,
-        leakage1_intensity=leakage_intensity1 / size,
-        leakage2_intensity=leakage_intensity2 / size,
+        pixels_width_1=leakage_pixel1 / geom.n_pixels,
+        pixels_width_2=leakage_pixel2 / geom.n_pixels,
+        intensity_width_1=leakage_intensity1 / size,
+        intensity_width_2=leakage_intensity2 / size,
     )

ctapipe/image/tests/test_concentration.py

@@ -10,9 +10,9 @@ def test_concentration():
 
     conc = concentration(geom, image, hillas)
 
-    assert 0.1 <= conc.concentration_cog <= 0.3
-    assert 0.05 <= conc.concentration_pixel <= 0.2
-    assert 0.3 <= conc.concentration_core <= 0.6
+    assert 0.1 <= conc.cog <= 0.3
+    assert 0.05 <= conc.pixel <= 0.2
+    assert 0.3 <= conc.core <= 0.6
 
 
 if __name__ == '__main__':

ctapipe/image/tests/test_leakage.py

@@ -15,7 +15,7 @@ def test_leakage():
     ratio1 = np.sum(geom.get_border_pixel_mask(1)) / geom.n_pixels
     ratio2 = np.sum(geom.get_border_pixel_mask(2)) / geom.n_pixels
 
-    assert l.leakage1_intensity == ratio1
-    assert l.leakage2_intensity == ratio2
-    assert l.leakage1_pixel == ratio1
-    assert l.leakage2_pixel == ratio2
+    assert l.intensity_width_1 == ratio1
+    assert l.intensity_width_2 == ratio2
+    assert l.pixels_width_1 == ratio1
+    assert l.pixels_width_2 == ratio2