add serialization to regions for json formatted catalog

- supports new region versions e.g., QuadTreeRegion
- added region comparison using to_dict method in regions

Author: wsavran

csep/core/catalogs.py

@@ -24,6 +24,7 @@
 from csep.utils.file import get_file_extension
 from csep.utils.plots import plot_catalog
 
+
 class AbstractBaseCatalog(LoggingMixin):
     """
     Abstract catalog base class for PyCSEP catalogs. This class should not and cannot be used on its own. This just
@@ -148,13 +149,17 @@ def from_dict(cls, adict, **kwargs):
         This needs to handle reading in region information at some point.
         """
 
+        region_loader = {
+            'CartesianGrid2D': regions.CartesianGrid2D
+        }
+
         # could these be class values? can be changed later.
-        exclude = ['_catalog']
+        exclude = ['_catalog', 'region']
         time_members = ['date_accessed', 'start_time', 'end_time']
         catalog = adict.get('catalog', None)
-
         out = cls(data=catalog, **kwargs)
 
+        # here we are looping over the items in the class and finding the associated value in the dict
         for k, v in out.__dict__.items():
             if k not in exclude:
                 if k not in time_members:
@@ -164,6 +169,13 @@ def from_dict(cls, adict, **kwargs):
                         pass
                 else:
                     setattr(out, k, _none_or_datetime(adict[k]))
+            else:
+                if k == 'region':
+                    # tries to read class id from
+                    class_id = adict[k].get('class_id', None)
+                    if class_id is None:
+                        class_id = 'CartesianGrid2D'
+                    setattr(out, k, region_loader[class_id].from_dict(adict[k]))
         return out
 
     @classmethod

csep/core/regions.py

@@ -555,6 +555,9 @@ def __init__(self, polygons, dh, name='cartesian2d', mask=None):
         self.xs = xs
         self.ys = ys
 
+    def __eq__(self, other):
+        return self.to_dict() == other.to_dict()
+
     @property
     def num_nodes(self):
         """ Number of polygons in region """
@@ -650,13 +653,36 @@ def to_dict(self):
         adict = {
             'name': str(self.name),
             'dh': float(self.dh),
-            'polygons': [{'lat': float(poly.origin[1]), 'lon': float(poly.origin[0])} for poly in self.polygons]
+            'polygons': [{'lat': float(poly.origin[1]), 'lon': float(poly.origin[0])} for poly in self.polygons],
+            'class_id': self.__class__.__name__
         }
         return adict
 
     @classmethod
     def from_dict(cls, adict):
-        raise NotImplementedError("Todo!")
+        """ Creates a region object from a dictionary """
+        origins = adict.get('polygons', None)
+        dh = adict.get('dh', None)
+        magnitudes = adict.get('magnitudes', None)
+        name = adict.get('name', 'CartesianGrid2D')
+
+        if origins is None:
+            raise AttributeError("cannot create region object without origins")
+        if dh is None:
+            raise AttributeError("cannot create region without dh")
+        if origins is not None:
+            try:
+                origins = numpy.array([[adict['lon'], adict['lat']] for adict in origins])
+            except:
+                raise TypeError('origins must be numpy array like.')
+        if magnitudes is not None:
+            try:
+                magnitudes = numpy.array(magnitudes)
+            except:
+                raise TypeError('magnitudes must be numpy array like.')
+
+        out = cls.from_origins(origins, dh=dh, magnitudes=magnitudes, name=name)
+        return out
 
     @classmethod
     def from_origins(cls, origins, dh=None, magnitudes=None, name=None):

tests/test_spatial.py

@@ -120,6 +120,9 @@ def test_get_index_of_good(self):
         test_idx = self.cart_grid.get_index_of([test[0]], [test[1]])
         numpy.testing.assert_allclose(test_idx, 0)
 
+    def test_to_from_dict(self):
+        self.assertEqual(self.cart_grid, CartesianGrid2D.from_dict(self.cart_grid.to_dict()))
+
 class TestCatalogBinning(unittest.TestCase):
 
     def setUp(self):
@@ -226,7 +229,6 @@ def test_bin_spatial_magnitudes(self):
         self.assertEqual(test_result[0, 1], 1)
         self.assertEqual(test_result[9, 0], 1)
 
-
     def test_global_region_binning(self):
 
         gr = global_region()