/usr/lib/python2.7/dist-packages/aplpy/regions.py is in python-aplpy 1.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | from __future__ import absolute_import, print_function, division
from astropy.extern import six
from astropy import log
from astropy import wcs
from .decorators import auto_refresh
class Regions:
"""
Regions sub-class of APLpy.
Used for overplotting various shapes and annotations on APLpy
fitsfigures.
Example:
# DS9 region file called "test.reg"
# (the coordinates are around l=28 in the Galactic Plane)
# Filename: test.fits
fk5
box(18:42:48.262,-04:01:17.91,505.668",459.714",0) # color=red dash=1
point(18:42:51.797,-03:59:44.82) # point=x color=red dash=1
point(18:42:50.491,-04:03:09.39) # point=box color=red dash=1
# vector(18:42:37.433,-04:02:10.77,107.966",115.201) vector=1 color=red dash=1
ellipse(18:42:37.279,-04:02:11.92,26.4336",40.225",0) # color=red dash=1
polygon(18:42:59.016,-03:58:22.06,18:42:58.219,-03:58:11.30,18:42:57.403,-03:58:35.86,18:42:58.094,-03:58:57.69,18:42:59.861,-03:58:41.60,18:42:59.707,-03:58:23.21) # color=red dash=1
point(18:42:52.284,-04:00:02.80) # point=diamond color=red dash=1
point(18:42:46.561,-03:58:01.57) # point=circle color=red dash=1
point(18:42:42.615,-03:58:25.84) # point=cross color=red dash=1
point(18:42:42.946,-04:01:44.74) # point=arrow color=red dash=1
point(18:42:41.961,-03:57:26.16) # point=boxcircle color=red dash=1
# text(18:42:41.961,-03:57:26.16) text={This is text} color=red
Code:
import aplpy
import regions
ff = aplpy.FITSFigure("test.fits")
ff.show_grayscale()
ff.show_regions('test.reg')
"""
@auto_refresh
def show_regions(self, region_file, layer=False, **kwargs):
"""
Overplot regions as specified in the region file.
Parameters
----------
region_file: string or pyregion.ShapeList
Path to a ds9 regions file or a ShapeList already read
in by pyregion.
layer: str, optional
The name of the layer
kwargs
Additional keyword arguments, e.g. zorder, will be passed to the
ds9 call and onto the patchcollections.
"""
PC, TC = ds9(region_file, wcs.WCS(self._header).sub([wcs.WCSSUB_CELESTIAL]), **kwargs)
# ffpc = self._ax1.add_collection(PC)
PC.add_to_axes(self._ax1)
TC.add_to_axes(self._ax1)
if layer:
region_set_name = layer
else:
self._region_counter += 1
region_set_name = 'region_set_' + str(self._region_counter)
self._layers[region_set_name] = PC
self._layers[region_set_name + "_txt"] = TC
def ds9(region_file, header, zorder=3, **kwargs):
"""
Wrapper to return a PatchCollection given a ds9 region file
and a fits header.
zorder - defaults to 3 so that regions are on top of contours
"""
try:
import pyregion
except:
raise ImportError("The pyregion package is required to load region files")
# read region file
if isinstance(region_file, six.string_types):
rr = pyregion.open(region_file)
elif isinstance(region_file, pyregion.ShapeList):
rr = region_file
else:
raise Exception("Invalid type for region_file: %s - should be string or pyregion.ShapeList" % type(region_file))
# convert coordinates to image coordinates
rrim = rr.as_imagecoord(header)
# pyregion and aplpy both correct for the FITS standard origin=1,1
# need to avoid double-correcting. Also, only some items in `coord_list`
# are pixel coordinates, so which ones should be corrected depends on the
# shape.
for r in rrim:
if r.name == 'polygon':
correct = range(len(r.coord_list))
elif r.name == 'line':
correct = range(4)
elif r.name in ['rotbox', 'box', 'ellipse', 'annulus', 'circle', 'panda', 'pie', 'epanda', 'text', 'point', 'vector']:
correct = range(2)
else:
log.warning("Unknown region type '{0}' - please report to the developers")
correct = range(2)
for i in correct:
r.coord_list[i] += 1
if 'text_offset' in kwargs:
text_offset = kwargs['text_offset']
del kwargs['text_offset']
else:
text_offset = 5.0
# grab the shapes to overplot
pp, aa = rrim.get_mpl_patches_texts(text_offset=text_offset)
PC = ArtistCollection(pp, **kwargs) # preserves line style (dashed)
TC = ArtistCollection(aa, **kwargs)
PC.set_zorder(zorder)
TC.set_zorder(zorder)
return PC, TC
class ArtistCollection():
"""
Matplotlib collections can't handle Text.
This is a barebones collection for text objects
that supports removing and making (in)visible
"""
def __init__(self, artistlist):
"""
Pass in a list of matplotlib.text.Text objects
(or possibly any matplotlib Artist will work)
"""
self.artistlist = artistlist
def remove(self):
for T in self.artistlist:
T.remove()
def add_to_axes(self, ax):
for T in self.artistlist:
ax.add_artist(T)
def get_visible(self):
visible = True
for T in self.artistlist:
if not T.get_visible():
visible = False
return visible
def set_visible(self, visible=True):
for T in self.artistlist:
T.set_visible(visible)
def set_zorder(self, zorder):
for T in self.artistlist:
T.set_zorder(zorder)
|