/usr/lib/python3/dist-packages/photutils/aperture/rectangle.py is in python3-photutils 0.4-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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | # Licensed under a 3-clause BSD style license - see LICENSE.rst
from __future__ import (absolute_import, division, print_function,
unicode_literals)
import math
import numpy as np
from astropy.coordinates import SkyCoord
from .core import PixelAperture, SkyAperture
from .bounding_box import BoundingBox
from .mask import ApertureMask
from ..geometry import rectangular_overlap_grid
from ..utils.wcs_helpers import assert_angle, assert_angle_or_pixel
__all__ = ['RectangularMaskMixin', 'RectangularAperture',
'RectangularAnnulus', 'SkyRectangularAperture',
'SkyRectangularAnnulus']
class RectangularMaskMixin(object):
"""
Mixin class to create masks for rectangular or rectangular-annulus
aperture objects.
"""
def to_mask(self, method='exact', subpixels=5):
"""
Return a list of `~photutils.ApertureMask` objects, one for each
aperture position.
Parameters
----------
method : {'exact', 'center', 'subpixel'}, optional
The method used to determine the overlap of the aperture on
the pixel grid. Not all options are available for all
aperture types. Note that the more precise methods are
generally slower. The following methods are available:
* ``'exact'`` (default):
The the exact fractional overlap of the aperture and
each pixel is calculated. The returned mask will
contain values between 0 and 1.
* ``'center'``:
A pixel is considered to be entirely in or out of the
aperture depending on whether its center is in or out
of the aperture. The returned mask will contain
values only of 0 (out) and 1 (in).
* ``'subpixel'``:
A pixel is divided into subpixels (see the
``subpixels`` keyword), each of which are considered
to be entirely in or out of the aperture depending on
whether its center is in or out of the aperture. If
``subpixels=1``, this method is equivalent to
``'center'``. The returned mask will contain values
between 0 and 1.
subpixels : int, optional
For the ``'subpixel'`` method, resample pixels by this factor
in each dimension. That is, each pixel is divided into
``subpixels ** 2`` subpixels.
Returns
-------
mask : list of `~photutils.ApertureMask`
A list of aperture mask objects.
"""
use_exact, subpixels = self._translate_mask_mode(method, subpixels,
rectangle=True)
if hasattr(self, 'w'):
w = self.w
h = self.h
elif hasattr(self, 'w_out'): # annulus
w = self.w_out
h = self.h_out
h_in = self.w_in * self.h_out / self.w_out
else:
raise ValueError('Cannot determine the aperture radius.')
masks = []
for bbox, edges in zip(self.bounding_boxes, self._centered_edges):
ny, nx = bbox.shape
mask = rectangular_overlap_grid(edges[0], edges[1], edges[2],
edges[3], nx, ny, w, h,
self.theta, 0, subpixels)
# subtract the inner circle for an annulus
if hasattr(self, 'w_in'):
mask -= rectangular_overlap_grid(edges[0], edges[1], edges[2],
edges[3], nx, ny, self.w_in,
h_in, self.theta, 0,
subpixels)
masks.append(ApertureMask(mask, bbox))
return masks
class RectangularAperture(RectangularMaskMixin, PixelAperture):
"""
Rectangular aperture(s), defined in pixel coordinates.
Parameters
----------
positions : array_like or `~astropy.units.Quantity`
Pixel coordinates of the aperture center(s) in one of the
following formats:
* single ``(x, y)`` tuple
* list of ``(x, y)`` tuples
* ``Nx2`` or ``2xN`` `~numpy.ndarray`
* ``Nx2`` or ``2xN`` `~astropy.units.Quantity` in pixel units
Note that a ``2x2`` `~numpy.ndarray` or
`~astropy.units.Quantity` is interpreted as ``Nx2``, i.e. two
rows of (x, y) coordinates.
w : float
The full width of the aperture. For ``theta=0`` the width side
is along the ``x`` axis.
h : float
The full height of the aperture. For ``theta=0`` the height
side is along the ``y`` axis.
theta : float
The rotation angle in radians of the width (``w``) side from the
positive ``x`` axis. The rotation angle increases
counterclockwise.
Raises
------
ValueError : `ValueError`
If either width (``w``) or height (``h``) is negative.
"""
def __init__(self, positions, w, h, theta):
if w < 0 or h < 0:
raise ValueError("'w' and 'h' must be nonnegative.")
self.positions = self._sanitize_positions(positions)
self.w = float(w)
self.h = float(h)
self.theta = float(theta)
self._params = ['w', 'h', 'theta']
@property
def bounding_boxes(self):
"""
A list of minimal bounding boxes (`~photutils.BoundingBox`), one
for each position, enclosing the exact rectangular apertures.
"""
w2 = self.w / 2.
h2 = self.h / 2.
cos_theta = math.cos(self.theta)
sin_theta = math.sin(self.theta)
dx1 = abs(w2 * cos_theta - h2 * sin_theta)
dy1 = abs(w2 * sin_theta + h2 * cos_theta)
dx2 = abs(w2 * cos_theta + h2 * sin_theta)
dy2 = abs(w2 * sin_theta - h2 * cos_theta)
dx = max(dx1, dx2)
dy = max(dy1, dy2)
xmin = self.positions[:, 0] - dx
xmax = self.positions[:, 0] + dx
ymin = self.positions[:, 1] - dy
ymax = self.positions[:, 1] + dy
return [BoundingBox._from_float(x0, x1, y0, y1)
for x0, x1, y0, y1 in zip(xmin, xmax, ymin, ymax)]
def area(self):
return self.w * self.h
def plot(self, origin=(0, 0), indices=None, ax=None, fill=False,
**kwargs):
import matplotlib.patches as mpatches
plot_positions, ax, kwargs = self._prepare_plot(
origin, indices, ax, fill, **kwargs)
hw = self.w / 2.
hh = self.h / 2.
sint = math.sin(self.theta)
cost = math.cos(self.theta)
dx = (hh * sint) - (hw * cost)
dy = -(hh * cost) - (hw * sint)
plot_positions = plot_positions + np.array([dx, dy])
theta_deg = self.theta * 180. / np.pi
for position in plot_positions:
patch = mpatches.Rectangle(position, self.w, self.h, theta_deg,
**kwargs)
ax.add_patch(patch)
def to_sky(self, wcs, mode='all'):
"""
Convert the aperture to a `SkyRectangularAperture` object
defined in celestial coordinates.
Parameters
----------
wcs : `~astropy.wcs.WCS`
The world coordinate system (WCS) transformation to use.
mode : {'all', 'wcs'}, optional
Whether to do the transformation including distortions
(``'all'``; default) or only including only the core WCS
transformation (``'wcs'``).
Returns
-------
aperture : `SkyRectangularAperture` object
A `SkyRectangularAperture` object.
"""
sky_params = self._to_sky_params(wcs, mode=mode)
return SkyRectangularAperture(**sky_params)
class RectangularAnnulus(RectangularMaskMixin, PixelAperture):
"""
Rectangular annulus aperture(s), defined in pixel coordinates.
Parameters
----------
positions : array_like or `~astropy.units.Quantity`
Pixel coordinates of the aperture center(s) in one of the
following formats:
* single ``(x, y)`` tuple
* list of ``(x, y)`` tuples
* ``Nx2`` or ``2xN`` `~numpy.ndarray`
* ``Nx2`` or ``2xN`` `~astropy.units.Quantity` in pixel units
Note that a ``2x2`` `~numpy.ndarray` or
`~astropy.units.Quantity` is interpreted as ``Nx2``, i.e. two
rows of (x, y) coordinates.
w_in : float
The inner full width of the aperture. For ``theta=0`` the width
side is along the ``x`` axis.
w_out : float
The outer full width of the aperture. For ``theta=0`` the width
side is along the ``x`` axis.
h_out : float
The outer full height of the aperture. The inner full height is
calculated as:
.. math:: h_{in} = h_{out}
\\left(\\frac{w_{in}}{w_{out}}\\right)
For ``theta=0`` the height side is along the ``y`` axis.
theta : float
The rotation angle in radians of the width side from the
positive ``x`` axis. The rotation angle increases
counterclockwise.
Raises
------
ValueError : `ValueError`
If inner width (``w_in``) is greater than outer width
(``w_out``).
ValueError : `ValueError`
If either the inner width (``w_in``) or the outer height
(``h_out``) is negative.
"""
def __init__(self, positions, w_in, w_out, h_out, theta):
if not (w_out > w_in):
raise ValueError("'w_out' must be greater than 'w_in'")
if w_in < 0 or h_out < 0:
raise ValueError("'w_in' and 'h_out' must be non-negative")
self.positions = self._sanitize_positions(positions)
self.w_in = float(w_in)
self.w_out = float(w_out)
self.h_out = float(h_out)
self.h_in = self.w_in * self.h_out / self.w_out
self.theta = float(theta)
self._params = ['w_in', 'w_out', 'h_out', 'theta']
@property
def bounding_boxes(self):
"""
A list of minimal bounding boxes (`~photutils.BoundingBox`), one
for each position, enclosing the rectangular apertures for the
"exact" case.
"""
w2 = self.w_out / 2.
h2 = self.h_out / 2.
cos_theta = math.cos(self.theta)
sin_theta = math.sin(self.theta)
dx1 = abs(w2 * cos_theta - h2 * sin_theta)
dy1 = abs(w2 * sin_theta + h2 * cos_theta)
dx2 = abs(w2 * cos_theta + h2 * sin_theta)
dy2 = abs(w2 * sin_theta - h2 * cos_theta)
dx = max(dx1, dx2)
dy = max(dy1, dy2)
xmin = self.positions[:, 0] - dx
xmax = self.positions[:, 0] + dx
ymin = self.positions[:, 1] - dy
ymax = self.positions[:, 1] + dy
return [BoundingBox._from_float(x0, x1, y0, y1)
for x0, x1, y0, y1 in zip(xmin, xmax, ymin, ymax)]
def area(self):
return self.w_out * self.h_out - self.w_in * self.h_in
def plot(self, origin=(0, 0), indices=None, ax=None, fill=False,
**kwargs):
import matplotlib.patches as mpatches
plot_positions, ax, kwargs = self._prepare_plot(
origin, indices, ax, fill, **kwargs)
sint = math.sin(self.theta)
cost = math.cos(self.theta)
theta_deg = self.theta * 180. / np.pi
hw_inner = self.w_in / 2.
hh_inner = self.h_in / 2.
dx_inner = (hh_inner * sint) - (hw_inner * cost)
dy_inner = -(hh_inner * cost) - (hw_inner * sint)
positions_inner = plot_positions + np.array([dx_inner, dy_inner])
hw_outer = self.w_out / 2.
hh_outer = self.h_out / 2.
dx_outer = (hh_outer * sint) - (hw_outer * cost)
dy_outer = -(hh_outer * cost) - (hw_outer * sint)
positions_outer = plot_positions + np.array([dx_outer, dy_outer])
for i, position_inner in enumerate(positions_inner):
patch_inner = mpatches.Rectangle(position_inner,
self.w_in, self.h_in,
theta_deg, **kwargs)
patch_outer = mpatches.Rectangle(positions_outer[i],
self.w_out, self.h_out,
theta_deg, **kwargs)
path = self._make_annulus_path(patch_inner, patch_outer)
patch = mpatches.PathPatch(path, **kwargs)
ax.add_patch(patch)
def to_sky(self, wcs, mode='all'):
"""
Convert the aperture to a `SkyRectangularAnnulus` object
defined in celestial coordinates.
Parameters
----------
wcs : `~astropy.wcs.WCS`
The world coordinate system (WCS) transformation to use.
mode : {'all', 'wcs'}, optional
Whether to do the transformation including distortions
(``'all'``; default) or only including only the core WCS
transformation (``'wcs'``).
Returns
-------
aperture : `SkyRectangularAnnulus` object
A `SkyRectangularAnnulus` object.
"""
sky_params = self._to_sky_params(wcs, mode=mode)
return SkyRectangularAnnulus(**sky_params)
class SkyRectangularAperture(SkyAperture):
"""
Rectangular aperture(s), defined in sky coordinates.
Parameters
----------
positions : `~astropy.coordinates.SkyCoord`
Celestial coordinates of the aperture center(s). This can be
either scalar coordinates or an array of coordinates.
w : `~astropy.units.Quantity`
The full width of the aperture, either in angular or pixel
units. For ``theta=0`` the width side is along the North-South
axis.
h : `~astropy.units.Quantity`
The full height of the aperture, either in angular or pixel
units. For ``theta=0`` the height side is along the East-West
axis.
theta : `~astropy.units.Quantity`
The position angle (in angular units) of the width side. For a
right-handed world coordinate system, the position angle
increases counterclockwise from North (PA=0).
"""
def __init__(self, positions, w, h, theta):
if isinstance(positions, SkyCoord):
self.positions = positions
else:
raise TypeError('positions must be a SkyCoord instance')
assert_angle_or_pixel('w', w)
assert_angle_or_pixel('h', h)
assert_angle('theta', theta)
if w.unit.physical_type != h.unit.physical_type:
raise ValueError("'w' and 'h' should either both be angles or "
"in pixels")
self.w = w
self.h = h
self.theta = theta
self._params = ['w', 'h', 'theta']
def to_pixel(self, wcs, mode='all'):
"""
Convert the aperture to a `RectangularAperture` object defined
in pixel coordinates.
Parameters
----------
wcs : `~astropy.wcs.WCS`
The world coordinate system (WCS) transformation to use.
mode : {'all', 'wcs'}, optional
Whether to do the transformation including distortions
(``'all'``; default) or only including only the core WCS
transformation (``'wcs'``).
Returns
-------
aperture : `RectangularAperture` object
A `RectangularAperture` object.
"""
pixel_params = self._to_pixel_params(wcs, mode=mode)
return RectangularAperture(**pixel_params)
class SkyRectangularAnnulus(SkyAperture):
"""
Rectangular annulus aperture(s), defined in sky coordinates.
Parameters
----------
positions : `~astropy.coordinates.SkyCoord`
Celestial coordinates of the aperture center(s). This can be
either scalar coordinates or an array of coordinates.
w_in : `~astropy.units.Quantity`
The inner full width of the aperture, either in angular or pixel
units. For ``theta=0`` the width side is along the North-South
axis.
w_out : `~astropy.units.Quantity`
The outer full width of the aperture, either in angular or pixel
units. For ``theta=0`` the width side is along the North-South
axis.
h_out : `~astropy.units.Quantity`
The outer full height of the aperture, either in angular or
pixel units. The inner full height is calculated as:
.. math:: h_{in} = h_{out}
\\left(\\frac{w_{in}}{w_{out}}\\right)
For ``theta=0`` the height side is along the East-West axis.
theta : `~astropy.units.Quantity`
The position angle (in angular units) of the width side. For a
right-handed world coordinate system, the position angle
increases counterclockwise from North (PA=0).
"""
def __init__(self, positions, w_in, w_out, h_out, theta):
if isinstance(positions, SkyCoord):
self.positions = positions
else:
raise TypeError('positions must be a SkyCoord instance')
assert_angle_or_pixel('w_in', w_in)
assert_angle_or_pixel('w_out', w_out)
assert_angle_or_pixel('h_out', h_out)
assert_angle('theta', theta)
if w_in.unit.physical_type != w_out.unit.physical_type:
raise ValueError("w_in and w_out should either both be angles or "
"in pixels")
if w_out.unit.physical_type != h_out.unit.physical_type:
raise ValueError("w_out and h_out should either both be angles "
"or in pixels")
self.w_in = w_in
self.w_out = w_out
self.h_out = h_out
self.theta = theta
self._params = ['w_in', 'w_out', 'h_out', 'theta']
def to_pixel(self, wcs, mode='all'):
"""
Convert the aperture to a `RectangularAnnulus` object defined in
pixel coordinates.
Parameters
----------
wcs : `~astropy.wcs.WCS`
The world coordinate system (WCS) transformation to use.
mode : {'all', 'wcs'}, optional
Whether to do the transformation including distortions
(``'all'``; default) or only including only the core WCS
transformation (``'wcs'``).
Returns
-------
aperture : `RectangularAnnulus` object
A `RectangularAnnulus` object.
"""
pixel_params = self._to_pixel_params(wcs, mode=mode)
return RectangularAnnulus(**pixel_params)
|