Merge pull request #286 from cdeil/repr_params

Change _repr_params to _fields, including center

docs/crtf.rst

@@ -59,5 +59,5 @@ read from a file in addition to doing the region serialisation and parsing.
     >>> write_crtf(regions, filename)
     >>> regions = read_crtf(filename)
     >>> regions
-    [<CircleSkyRegion(<SkyCoord (FK5: equinox=J2000.000): (ra, dec) in deg
+    [<CircleSkyRegion(center=<SkyCoord (FK5: equinox=J2000.000): (ra, dec) in deg
         (42., 43.)>, radius=3.0 deg)>]

docs/ds9.rst

@@ -46,7 +46,7 @@ read from a file in addition to doing the region serialisation and parsing.
     >>> write_ds9(regions, filename)
     >>> regions = read_ds9(filename)
     >>> regions
-    [<CircleSkyRegion(<SkyCoord (FK5: equinox=J2000.000): (ra, dec) in deg
+    [<CircleSkyRegion(center=<SkyCoord (FK5: equinox=J2000.000): (ra, dec) in deg
         (245.347655, 24.429081)>, radius=3.0 deg)>]
 
 The ``visual`` metadata includes items used for display, e.g.:

regions/core/compound.py

@@ -29,7 +29,7 @@ class CompoundPixelRegion(PixelRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('region1', 'region2', 'operator')
     region1 = CompoundRegionPix('region1')
     region2 = CompoundRegionPix('region2')
 
@@ -49,7 +49,6 @@ def __init__(self, region1, region2, operator, meta=None, visual=None):
         else:
             self.visual = RegionVisual()
         self._operator = operator
-        self._repr_params = ('region1', 'region2', 'operator')
 
     @property
     def operator(self):
@@ -204,6 +203,7 @@ class CompoundSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
+    _params = ('region1', 'region2', 'operator')
     region1 = CompoundRegionSky('region1')
     region2 = CompoundRegionSky('region2')
 
@@ -223,8 +223,6 @@ def __init__(self, region1, region2, operator, meta=None, visual=None):
             self.visual = RegionVisual()
         self._operator = operator
 
-        self._repr_params = ('region1', 'region2', 'operator')
-
     @property
     def operator(self):
         return self._operator

regions/core/core.py

@@ -69,13 +69,7 @@ class Region(object):
 
     def copy(self, **changes):
         """Make an independent (deep) copy."""
-        fields = []
-        if hasattr(self, "center"):
-            fields.append("center")
-        if hasattr(self, "vertices"):
-            fields.append("vertices")
-        fields.extend(self._repr_params)
-        fields.extend(["meta", "visual"])
+        fields = list(self._params) + ["meta", "visual"]
 
         for field in fields:
             if field not in changes:
@@ -84,12 +78,9 @@ def copy(self, **changes):
         return self.__class__(**changes)
 
     def __repr__(self):
-        if hasattr(self, 'center'):
-            params = [repr(self.center)]
-        else:
-            params = []
-        if self._repr_params is not None:
-            for key in self._repr_params:
+        params = []
+        if self._params is not None:
+            for key in self._params:
                 params.append('{0}={1}'.format(key.replace("_", " "),
                                                getattr(self, key)))
         params = ', '.join(params)
@@ -98,11 +89,9 @@ def __repr__(self):
 
     def __str__(self):
         cls_info = [('Region', self.__class__.__name__)]
-        if hasattr(self, 'center'):
-            cls_info.append(('center', self.center))
-        if self._repr_params is not None:
+        if self._params is not None:
             params_value = [(x.replace("_", " "), getattr(self, x))
-                            for x in self._repr_params]
+                            for x in self._params]
             cls_info += params_value
         fmt = ['{0}: {1}'.format(key, val) for key, val in cls_info]
 

regions/io/fits/read.py

@@ -42,7 +42,7 @@ class FITSRegionParser(object):
     >>> shapes = parser.shapes
     >>> regions = shapes.to_regions()
     >>> regions[5]
-    <PointPixelRegion(PixCoord(x=341.0, y=345.0))>
+    <PointPixelRegion(center=PixCoord(x=341.0, y=345.0))>
     """
 
     valid_columns = ['X', 'Y', 'SHAPE', 'COMPONENT', 'R', 'ROTANG']

regions/shapes/annulus.py

@@ -124,6 +124,7 @@ class CircleAnnulusPixelRegion(AnnulusPixelRegion):
     """
     _component_class = CirclePixelRegion
 
+    _params = ("center", "inner_radius", "outer_radius")
     center = ScalarPix("center")
     inner_radius = ScalarLength("inner_radius")
     outer_radius = ScalarLength("outer_radius")
@@ -134,7 +135,6 @@ def __init__(self, center, inner_radius, outer_radius, meta=None, visual=None):
         self.outer_radius = outer_radius
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ("inner_radius", "outer_radius")
 
     @property
     def _inner_region(self):
@@ -171,7 +171,7 @@ class CircleAnnulusSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ("center", "inner_radius", "outer_radius")
     center = ScalarSky("center")
     inner_radius = QuantityLength("inner_radius")
     outer_radius = QuantityLength("outer_radius")
@@ -182,7 +182,6 @@ def __init__(self, center, inner_radius, outer_radius, meta=None, visual=None):
         self.outer_radius = outer_radius
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ("inner_radius", "outer_radius")
 
     def to_pixel(self, wcs):
         center, scale, _ = skycoord_to_pixel_scale_angle(self.center, wcs)
@@ -201,7 +200,14 @@ class AsymmetricAnnulusPixelRegion(AnnulusPixelRegion):
 
     Used for ellipse and rectangle annuli below.
     """
-
+    _params = (
+        "center",
+        "inner_width",
+        "inner_height",
+        "outer_width",
+        "outer_height",
+        "angle",
+    )
     center = ScalarPix("center")
     inner_width = ScalarLength("inner_width")
     outer_width = ScalarLength("outer_width")
@@ -228,13 +234,6 @@ def __init__(
         self.angle = angle
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = (
-            "inner_width",
-            "inner_height",
-            "outer_width",
-            "outer_height",
-            "angle",
-        )
 
     @property
     def _inner_region(self):
@@ -277,7 +276,14 @@ class AsymmetricAnnulusSkyRegion(SkyRegion):
 
     Used for ellipse and rectangle annuli below.
     """
-
+    _params = (
+        "center",
+        "inner_width",
+        "inner_height",
+        "outer_width",
+        "outer_height",
+        "angle",
+    )
     center = ScalarSky("center")
     inner_width = QuantityLength("inner_width")
     outer_width = QuantityLength("outer_width")
@@ -304,13 +310,6 @@ def __init__(
         self.angle = angle
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = (
-            "inner_width",
-            "inner_height",
-            "outer_width",
-            "outer_height",
-            "angle",
-        )
 
     def to_pixel_args(self, wcs):
         center, scale, north_angle = skycoord_to_pixel_scale_angle(self.center, wcs)

regions/shapes/circle.py

@@ -53,7 +53,7 @@ class CirclePixelRegion(PixelRegion):
         plt.ylim(0, 15)
         ax.set_aspect('equal')
     """
-
+    _params = ('center', 'radius')
     center = ScalarPix('center')
     radius = ScalarLength('radius')
 
@@ -62,7 +62,6 @@ def __init__(self, center, radius, meta=None, visual=None):
         self.radius = radius
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('radius',)
 
     @property
     def area(self):
@@ -183,7 +182,7 @@ class CircleSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('center', 'radius')
     center = ScalarSky('center')
     radius = QuantityLength("radius")
 
@@ -192,7 +191,6 @@ def __init__(self, center, radius, meta=None, visual=None):
         self.radius = radius
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('radius',)
 
     def to_pixel(self, wcs):
         center, scale, _ = skycoord_to_pixel_scale_angle(self.center, wcs)

regions/shapes/ellipse.py

@@ -63,7 +63,7 @@ class EllipsePixelRegion(PixelRegion):
         ax.add_patch(patch)
 
     """
-
+    _params = ('center', 'width', 'height', 'angle')
     center = ScalarPix('center')
     width = ScalarLength('width')
     height = ScalarLength('height')
@@ -77,7 +77,6 @@ def __init__(self, center, width, height, angle=0. * u.deg, meta=None,
         self.angle = angle
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('width', 'height', 'angle')
 
     @property
     def area(self):
@@ -255,7 +254,7 @@ class EllipseSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('center', 'width', 'height', 'angle')
     center = ScalarSky('center')
     width = QuantityLength('width')
     height = QuantityLength('height')
@@ -268,7 +267,6 @@ def __init__(self, center, width, height, angle=0. * u.deg, meta=None, visual=No
         self.angle = angle
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('width', 'height', 'angle')
 
     def to_pixel(self, wcs):
         center, scale, north_angle = skycoord_to_pixel_scale_angle(self.center, wcs)

regions/shapes/line.py

@@ -52,7 +52,7 @@ class LinePixelRegion(PixelRegion):
         plt.ylim(0, 30)
         ax.set_aspect('equal')
     """
-
+    _params = ('start', 'end')
     start = ScalarPix('start')
     end = ScalarPix('end')
 
@@ -61,7 +61,6 @@ def __init__(self, start, end, meta=None, visual=None):
         self.end = end
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('start', 'end')
 
     @property
     def area(self):
@@ -170,7 +169,7 @@ class LineSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('start', 'end')
     start = ScalarSky('start')
     end = ScalarSky('end')
 
@@ -179,7 +178,6 @@ def __init__(self, start, end, meta=None, visual=None):
         self.end = end
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('start', 'end')
 
     def contains(self, skycoord, wcs):
         if self.meta.get('include', True):

regions/shapes/point.py

@@ -49,14 +49,13 @@ class PointPixelRegion(PixelRegion):
         ax.set_aspect('equal')
 
     """
-
+    _params = ('center',)
     center = ScalarPix('center')
 
     def __init__(self, center, meta=None, visual=None):
         self.center = center
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = tuple()
 
     @property
     def area(self):
@@ -149,14 +148,13 @@ class PointSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('center',)
     center = ScalarSky('center')
 
     def __init__(self, center, meta=None, visual=None):
         self.center = center
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = tuple()
 
     def contains(self, skycoord, wcs):
         if self.meta.get('include', True):

regions/shapes/polygon.py

@@ -48,14 +48,13 @@ class PolygonPixelRegion(PixelRegion):
         plt.ylim(50, 80)
         ax.set_aspect('equal')
     """
-
+    _params = ('vertices',)
     vertices = OneDPix('vertices')
 
     def __init__(self, vertices, meta=None, visual=None):
         self.vertices = vertices
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('vertices',)
 
     @property
     def area(self):
@@ -182,14 +181,13 @@ class PolygonSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('vertices',)
     vertices = OneDSky('vertices')
 
     def __init__(self, vertices, meta=None, visual=None):
         self.vertices = vertices
         self.meta = meta or RegionMeta()
         self.visual = visual or RegionVisual()
-        self._repr_params = ('vertices',)
 
     def to_pixel(self, wcs):
         x, y = skycoord_to_pixel(self.vertices, wcs)

regions/shapes/rectangle.py

@@ -62,7 +62,7 @@ class RectanglePixelRegion(PixelRegion):
         plt.ylim(0, 20)
         ax.set_aspect('equal')
     """
-
+    _params = ('center', 'width', 'height', 'angle')
     center = ScalarPix('center')
     width = ScalarLength('width')
     height = ScalarLength('height')
@@ -75,7 +75,6 @@ def __init__(self, center, width, height, angle=0 * u.deg, meta=None, visual=Non
         self.angle = angle
         self.meta = meta or {}
         self.visual = visual or {}
-        self._repr_params = ('width', 'height', 'angle')
 
     @property
     def area(self):
@@ -282,7 +281,7 @@ class RectangleSkyRegion(SkyRegion):
     visual : `~regions.RegionVisual` object, optional
         A dictionary which stores the visual meta attributes of this region.
     """
-
+    _params = ('center', 'width', 'height', 'angle')
     center = ScalarSky('center')
     width = QuantityLength('width')
     height = QuantityLength('height')
@@ -295,7 +294,6 @@ def __init__(self, center, width, height, angle=0 * u.deg, meta=None, visual=Non
         self.angle = angle
         self.meta = meta or {}
         self.visual = visual or {}
-        self._repr_params = ('width', 'height', 'angle')
 
     def to_pixel(self, wcs):
         center, scale, north_angle = skycoord_to_pixel_scale_angle(self.center, wcs)