Skip to content

Commit

Permalink
Merge pull request #93 from pllim/translator-direct-call
Browse files Browse the repository at this point in the history 
FEAT: Support sky regions and allow direct call to translator function
  • Loading branch information
@astrofrog
astrofrog authored Jun 16, 2023
2 parents 845652a + 3e4a7ab commit 4682152
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 66 deletions.
148 changes: 85 additions & 63 deletions glue_astronomy/translators/regions.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@
PointPixelRegion, PixCoord, EllipsePixelRegion,
AnnulusPixelRegion, CircleAnnulusPixelRegion)

__all__ = ["range_to_rect", "AstropyRegionsHandler"]
__all__ = ["range_to_rect", "roi_subset_state_to_region", "AstropyRegionsHandler"]

GLUE_LT_1_10 = Version(glue_version) < Version('1.10')
GLUE_LT_1_10_1 = Version(glue_version) < Version('1.10.1.dev') # remove .dev after it is released
GLUE_LT_1_11 = Version(glue_version) < Version('1.11')


def range_to_rect(data, ori, low, high):
Expand Down Expand Up @@ -54,9 +53,54 @@ def range_to_rect(data, ori, low, high):
return RectanglePixelRegion(PixCoord(xcen, ycen), width, height)


def roi_subset_state_to_region(subset_state, to_sky=False):
"""Translate the given ``RoiSubsetState`` containing ROI
that is compatible with 2D spatial regions to proper
``regions`` shape. If ``to_sky=True`` is given, it will
return sky region from attached data WCS, otherwise it returns
pixel region.
"""
roi = subset_state.roi

if isinstance(roi, (RectangularROI, EllipticalROI)):
angle = roi.theta * u.radian

if GLUE_LT_1_11 and isinstance(roi, (CircularROI, EllipticalROI)):
reg_cen = PixCoord(*roi.get_center())
elif isinstance(roi, PolygonalROI):
reg_cen = PixCoord(roi.vx, roi.vy)
else:
reg_cen = PixCoord(*roi.center())

if isinstance(roi, RectangularROI):
reg = RectanglePixelRegion(reg_cen, roi.width(), roi.height(), angle=angle)
elif isinstance(roi, PolygonalROI):
reg = PolygonPixelRegion(reg_cen)
elif isinstance(roi, CircularROI):
reg = CirclePixelRegion(reg_cen, roi.radius)
elif isinstance(roi, EllipticalROI):
reg = EllipsePixelRegion(reg_cen, roi.radius_x * 2, roi.radius_y * 2, angle=angle)
elif isinstance(roi, PointROI):
reg = PointPixelRegion(reg_cen)
elif not GLUE_LT_1_11:
from glue.core.roi import CircularAnnulusROI
if isinstance(roi, CircularAnnulusROI):
reg = CircleAnnulusPixelRegion(
center=reg_cen, inner_radius=roi.inner_radius, outer_radius=roi.outer_radius)
else:
raise NotImplementedError(f"ROIs of type {roi.__class__.__name__} are not yet supported") # noqa: E501
else:
raise NotImplementedError(f"ROIs of type {roi.__class__.__name__} are not yet supported")

if to_sky:
reg = reg.to_sky(subset_state.xatt.parent.coords)

return reg


def _is_annulus(subset_state):
# There is a new way to make annulus in newer glue.
if not GLUE_LT_1_10_1:
if not GLUE_LT_1_11:
from glue.core.roi import CircularAnnulusROI
res1 = (isinstance(subset_state, RoiSubsetState) and
isinstance(subset_state.roi, CircularAnnulusROI))
Expand Down Expand Up @@ -96,7 +140,7 @@ def _annulus_to_subset_state(reg, data):
ycen = reg.center.y

# There is a new way to make annulus in newer glue.
if not GLUE_LT_1_10_1:
if not GLUE_LT_1_11:
from glue.core.roi import CircularAnnulusROI
sbst = RoiSubsetState(data.pixel_component_ids[1], data.pixel_component_ids[0],
CircularAnnulusROI(xc=xcen, yc=ycen,
Expand All @@ -112,6 +156,17 @@ def _annulus_to_subset_state(reg, data):
return sbst


def _get_xy_pix_att_from_subset(subset):
data = subset.data
if data.pixel_component_ids[0].axis == 0:
x_pix_att = data.pixel_component_ids[1]
y_pix_att = data.pixel_component_ids[0]
else:
x_pix_att = data.pixel_component_ids[0]
y_pix_att = data.pixel_component_ids[1]
return x_pix_att, y_pix_att


@subset_state_translator('astropy-regions')
class AstropyRegionsHandler:

Expand All @@ -124,91 +179,55 @@ def to_object(self, subset):
subset : `glue.core.subset.Subset`
The subset to convert to a Region object
"""
data = subset.data

if data.pixel_component_ids[0].axis == 0:
x_pix_att = data.pixel_component_ids[1]
y_pix_att = data.pixel_component_ids[0]
else:
x_pix_att = data.pixel_component_ids[0]
y_pix_att = data.pixel_component_ids[1]

subset_state = subset.subset_state

if isinstance(subset_state, RoiSubsetState):

roi = subset_state.roi
angle = getattr(roi, 'theta', 0) * u.radian
if isinstance(roi, RectangularROI):
xcen = 0.5 * (roi.xmin + roi.xmax)
ycen = 0.5 * (roi.ymin + roi.ymax)
width = roi.xmax - roi.xmin
height = roi.ymax - roi.ymin
return RectanglePixelRegion(PixCoord(xcen, ycen), width, height, angle=angle)
elif isinstance(roi, PolygonalROI):
return PolygonPixelRegion(PixCoord(roi.vx, roi.vy))
elif isinstance(roi, CircularROI):
xcen, ycen = roi.get_center() if GLUE_LT_1_10 else roi.center()
return CirclePixelRegion(PixCoord(xcen, ycen), roi.get_radius())
elif isinstance(roi, EllipticalROI):
return EllipsePixelRegion(
PixCoord(roi.xc, roi.yc), roi.radius_x * 2, roi.radius_y * 2, angle=angle)
elif isinstance(roi, PointROI):
return PointPixelRegion(PixCoord(*roi.center()))
elif isinstance(roi, RangeROI):
return range_to_rect(data, roi.ori, roi.min, roi.max)

if isinstance(roi, RangeROI):
return range_to_rect(subset.data, roi.ori, roi.min, roi.max)

elif isinstance(roi, AbstractMplRoi):
temp_sub = Subset(data)
temp_sub = Subset(subset.data)
x_pix_att, y_pix_att = _get_xy_pix_att_from_subset(subset)
temp_sub.subset_state = RoiSubsetState(x_pix_att, y_pix_att, roi.roi())
try:
return self.to_object(temp_sub)
except NotImplementedError:
raise NotImplementedError("ROIs of type {0} are not yet supported"
.format(roi.__class__.__name__))

# There is a new way to make annulus in newer glue.
elif not GLUE_LT_1_10_1:
from glue.core.roi import CircularAnnulusROI
if isinstance(roi, CircularAnnulusROI):
return CircleAnnulusPixelRegion(
center=PixCoord(x=roi.xc, y=roi.yc),
inner_radius=roi.inner_radius,
outer_radius=roi.outer_radius)
else:
raise NotImplementedError("ROIs of type {0} are not yet supported"
.format(roi.__class__.__name__))
raise NotImplementedError(
f"ROIs of type {roi.__class__.__name__} are not yet supported")

else:
raise NotImplementedError("ROIs of type {0} are not yet supported"
.format(roi.__class__.__name__))
return roi_subset_state_to_region(subset_state)

elif isinstance(subset_state, RangeSubsetState):
x_pix_att, y_pix_att = _get_xy_pix_att_from_subset(subset)
if subset_state.att == x_pix_att:
return range_to_rect(data, 'x', subset_state.lo, subset_state.hi)
return range_to_rect(subset.data, 'x', subset_state.lo, subset_state.hi)
elif subset_state.att == y_pix_att:
return range_to_rect(data, 'y', subset_state.lo, subset_state.hi)
return range_to_rect(subset.data, 'y', subset_state.lo, subset_state.hi)
else:
raise ValueError('Range subset state att should be either x or y pixel coordinate')

elif isinstance(subset_state, MultiRangeSubsetState):
x_pix_att, y_pix_att = _get_xy_pix_att_from_subset(subset)
if subset_state.att == x_pix_att:
ori = 'x'
elif subset_state.att == y_pix_att:
ori = 'y'
else:
message = 'Multirange subset state att should be either x or y pixel coordinate'
raise ValueError(message)
raise ValueError('Multirange subset state att should be either x or y '
'pixel coordinate')
if len(subset_state.pairs) == 0:
message = 'Multirange subset state should contain at least one range'
raise ValueError(message)
region = range_to_rect(data, ori, subset_state.pairs[0][0], subset_state.pairs[0][1])
raise ValueError('Multirange subset state should contain at least one range')
region = range_to_rect(
subset.data, ori, subset_state.pairs[0][0], subset_state.pairs[0][1])
for pair in subset_state.pairs[1:]:
region = region | range_to_rect(data, ori, pair[0], pair[1])
region = region | range_to_rect(subset.data, ori, pair[0], pair[1])
return region

elif isinstance(subset_state, PixelSubsetState):
return PointPixelRegion(PixCoord(*subset_state.get_xy(data, 1, 0)))
return PointPixelRegion(PixCoord(*subset_state.get_xy(subset.data, 1, 0)))

elif isinstance(subset_state, AndState):
if _is_annulus(subset_state):
Expand All @@ -217,28 +236,31 @@ def to_object(self, subset):
inner_radius=subset_state.state2.state1.roi.radius,
outer_radius=subset_state.state1.roi.radius)
else:
data = subset.data
temp_sub1 = Subset(data=data)
temp_sub1.subset_state = subset_state.state1
temp_sub2 = Subset(data=data)
temp_sub2.subset_state = subset_state.state2
return self.to_object(temp_sub1) & self.to_object(temp_sub2)

elif isinstance(subset_state, OrState):
data = subset.data
temp_sub1 = Subset(data=data)
temp_sub1.subset_state = subset_state.state1
temp_sub2 = Subset(data=data)
temp_sub2.subset_state = subset_state.state2
return self.to_object(temp_sub1) | self.to_object(temp_sub2)

elif isinstance(subset_state, XorState):
data = subset.data
temp_sub1 = Subset(data=data)
temp_sub1.subset_state = subset_state.state1
temp_sub2 = Subset(data=data)
temp_sub2.subset_state = subset_state.state2
return self.to_object(temp_sub1) ^ self.to_object(temp_sub2)

elif isinstance(subset_state, MultiOrState):
temp_sub = Subset(data=data)
temp_sub = Subset(data=subset.data)
temp_sub.subset_state = subset_state.states[0]
region = self.to_object(temp_sub)
for state in subset_state.states[1:]:
Expand All @@ -247,5 +269,5 @@ def to_object(self, subset):
return region

else:
raise NotImplementedError("Subset states of type {0} are not supported"
.format(subset_state.__class__.__name__))
raise NotImplementedError(
f"Subset states of type {subset_state.__class__.__name__} are not supported")
13 changes: 10 additions & 3 deletions glue_astronomy/translators/tests/test_regions.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
from numpy.testing import assert_allclose, assert_array_equal, assert_equal
from packaging.version import Version

from regions import (RectanglePixelRegion, PolygonPixelRegion, CirclePixelRegion,
from regions import (RectanglePixelRegion, RectangleSkyRegion,
PolygonPixelRegion, CirclePixelRegion,
EllipsePixelRegion, PointPixelRegion, CompoundPixelRegion,
CircleAnnulusPixelRegion, PixCoord)

Expand All @@ -19,13 +20,16 @@
from glue.viewers.image.pixel_selection_subset_state import PixelSubsetState
from glue import __version__ as glue_version

from glue_astronomy.translators.regions import _annulus_to_subset_state, GLUE_LT_1_10_1
from glue_astronomy.translators.regions import (_annulus_to_subset_state, GLUE_LT_1_11,
roi_subset_state_to_region)
from glue_astronomy.translators.tests.test_nddata import WCS_CELESTIAL


class TestAstropyRegions:

def setup_method(self, method):
self.data = Data(flux=np.ones((128, 256))) # ny, nx
self.data.coords = WCS_CELESTIAL
self.dc = DataCollection([self.data])

def test_rectangular_roi(self):
Expand All @@ -45,6 +49,9 @@ def test_rectangular_roi(self):
assert_allclose(reg.width, 2.5)
assert_allclose(reg.height, 3.5)

reg_sky = roi_subset_state_to_region(subset_state, to_sky=True)
assert isinstance(reg_sky, RectangleSkyRegion)

def test_polygonal_roi(self):

xv = [1.3, 2, 3, 1.5, 0.5]
Expand Down Expand Up @@ -313,7 +320,7 @@ def test_circular_annulus(self):
subset_state = _annulus_to_subset_state(reg_orig, self.data)

# There is a new way to make annulus in newer glue.
if not GLUE_LT_1_10_1:
if not GLUE_LT_1_11:
from glue.core.roi import CircularAnnulusROI
assert (isinstance(subset_state, RoiSubsetState) and
isinstance(subset_state.roi, CircularAnnulusROI))
Expand Down

0 comments on commit 4682152

Please sign in to comment.