/
beam.py
818 lines (663 loc) · 27.3 KB
/
beam.py
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
from astropy import units as u
from astropy.io import fits
from astropy import constants
from astropy import wcs
import numpy as np
import warnings
# Imports for the custom kernels
from astropy.modeling.models import Ellipse2D, Gaussian2D
from astropy.convolution import Kernel2D
from astropy.convolution.kernels import _round_up_to_odd_integer
from .utils import deconvolve_optimized, convolve, RadioBeamDeprecationWarning
# Conversion between a twod Gaussian FWHM**2 and effective area
FWHM_TO_AREA = 2*np.pi/(8*np.log(2))
SIGMA_TO_FWHM = np.sqrt(8*np.log(2))
class NoBeamException(Exception):
pass
def _to_area(major,minor):
return (major * minor * FWHM_TO_AREA).to(u.sr)
unit_format = {u.deg: r'\\circ',
u.arcsec: "''",
u.arcmin: "'"}
class Beam(u.Quantity):
"""
An object to handle single radio beams.
"""
def __new__(cls, major=None, minor=None, pa=None, area=None,
default_unit=u.arcsec, meta=None):
"""
Create a new Gaussian beam
Parameters
----------
major : :class:`~astropy.units.Quantity` with angular equivalency
The FWHM major axis
minor : :class:`~astropy.units.Quantity` with angular equivalency
The FWHM minor axis
pa : :class:`~astropy.units.Quantity` with angular equivalency
The beam position angle
area : :class:`~astropy.units.Quantity` with steradian equivalency
The area of the beam. This is an alternative to specifying the
major/minor/PA, and will create those values assuming a circular
Gaussian beam.
default_unit : :class:`~astropy.units.Unit`
The unit to impose on major, minor if they are specified as floats
"""
# improve to some kwargs magic later
# error checking
# ... given an area make a round beam assuming it is Gaussian
if area is not None:
if major is not None:
raise ValueError("Can only specify one of {major,minor,pa} "
"and {area}")
if not area.unit.is_equivalent(u.sr):
raise ValueError("Area unit should be equivalent to steradian.")
rad = np.sqrt(area/(2*np.pi))
major = rad * SIGMA_TO_FWHM
minor = rad * SIGMA_TO_FWHM
pa = 0.0 * u.deg
# give specified values priority
if major is not None:
if u.deg.is_equivalent(major):
major = major
else:
warnings.warn("Assuming major axis has been specified in degrees")
major = major * u.deg
if minor is not None:
if u.deg.is_equivalent(minor):
minor = minor
else:
warnings.warn("Assuming minor axis has been specified in degrees")
minor = minor * u.deg
if pa is not None:
if u.deg.is_equivalent(pa):
pa = pa
else:
warnings.warn("Assuming position angle has been specified in degrees")
pa = pa * u.deg
else:
pa = 0.0 * u.deg
# some sensible defaults
if minor is None:
minor = major
if minor > major:
raise ValueError("Minor axis greater than major axis.")
self = super(Beam, cls).__new__(cls, _to_area(major,minor).value, u.sr)
self._major = major
self._minor = minor
self._pa = pa
self.default_unit = default_unit
if meta is None:
self.meta = {}
elif isinstance(meta, dict):
self.meta = meta
else:
raise TypeError("metadata must be a dictionary")
return self
@classmethod
def from_fits_bintable(cls, bintable, tolerance=0.01, unit=u.arcsec):
"""
Instantiate a single beam from a bintable from a CASA-produced image
HDU. The beams in the BinTableHDU will be averaged to form a single
beam.
Parameters
----------
bintable : fits.BinTableHDU
The table data containing the beam information
tolerance : float
The fractional tolerance on the beam size to include when averaging
to a single beam
Returns
-------
beam : Beam
A new beam object that is the average of the table beams
"""
from astropy.stats import circmean
bmaj = bintable.data['BMAJ']
bmin = bintable.data['BMIN']
bpa = bintable.data['BPA']
if np.any(np.isnan(bmaj) | np.isnan(bmin) | np.isnan(bpa)):
raise ValueError("NaN beam encountered.")
for par in (bmin,bmaj):
par_mean = par.mean()
if (par.max() > par_mean*(1+tolerance)) or (par.min()<par_mean*(1-tolerance)):
raise ValueError("Beams are not within specified tolerance")
meta = {key: bintable.data[key].mean() for key in bintable.data.names if
key not in ('BMAJ','BPA', 'BMIN')}
if meta:
warnings.warn("Metadata was averaged for keywords "
"{0}".format(",".join([key for key in meta])))
return cls(major=bmaj.mean()*unit, minor=bmin.mean()*unit,
pa=circmean(bpa*u.deg, weights=bmaj/bmin))
@classmethod
def from_fits_header(cls, hdr, unit=u.deg):
"""
Instantiate the beam from a header. Attempts to extract the
beam from standard keywords. Failing that, it looks for an
AIPS-style HISTORY entry.
"""
# ... given a file try to make a fits header
# assume a string refers to a filename on disk
if not isinstance(hdr,fits.Header):
if isinstance(hdr, str):
if hdr.lower().endswith(('.fits', '.fits.gz', '.fit',
'.fit.gz', '.fits.Z', '.fit.Z')):
hdr = fits.getheader(hdr)
else:
raise TypeError("Unrecognized extension.")
else:
raise TypeError("Header is not a FITS header or a filename")
# If we find a major axis keyword then we are in keyword
# mode. Else look to see if there is an AIPS header.
if "BMAJ" in hdr:
major = hdr["BMAJ"] * unit
else:
hist_beam = cls.from_fits_history(hdr)
if hist_beam is not None:
return hist_beam
else:
raise NoBeamException("No BMAJ found and does not appear to be a CASA/AIPS header.")
# Fill out the minor axis and position angle if they are
# present. Else they will default .
if "BMIN" in hdr:
minor = hdr["BMIN"] * unit
else:
minor = None
if "BPA" in hdr:
pa = hdr["BPA"] * unit
else:
pa = None
return cls(major=major, minor=minor, pa=pa)
@classmethod
def from_fits_history(cls, hdr):
"""
Instantiate the beam from an AIPS header. AIPS holds the beam
in history. This method of initializing uses the last such
entry.
"""
# a line looks like
# HISTORY AIPS CLEAN BMAJ= 1.7599E-03 BMIN= 1.5740E-03 BPA= 2.61
if 'HISTORY' not in hdr:
return None
aipsline = None
for line in hdr['HISTORY']:
if 'BMAJ' in line:
aipsline = line
# a line looks like
# HISTORY Sat May 10 20:53:11 2014
# HISTORY imager::clean() [] Fitted beam used in
# HISTORY > restoration: 1.34841 by 0.830715 (arcsec)
# at pa 82.8827 (deg)
casaline = None
for line in hdr['HISTORY']:
if ('restoration' in line) and ('arcsec' in line):
casaline = line
#assert precedence for CASA style over AIPS
# this is a dubious choice
if casaline is not None:
bmaj = float(casaline.split()[2]) * u.arcsec
bmin = float(casaline.split()[4]) * u.arcsec
bpa = float(casaline.split()[8]) * u.deg
return cls(major=bmaj, minor=bmin, pa=bpa)
elif aipsline is not None:
bmaj = float(aipsline.split()[3]) * u.deg
bmin = float(aipsline.split()[5]) * u.deg
bpa = float(aipsline.split()[7]) * u.deg
return cls(major=bmaj, minor=bmin, pa=bpa)
else:
return None
@classmethod
def from_casa_image(cls, imagename):
'''
Instantiate beam from a CASA image.
** Must be run in a CASA environment! **
Parameters
----------
imagename : str
Name of CASA image.
'''
try:
import casac
except ImportError:
raise ImportError("Could not import CASA (casac) and therefore"
" cannot read CASA .image files")
ia.open(imagename)
beam_props = ia.restoringbeam()
ia.close()
beam_keys = ["major", "minor", "positionangle"]
if not all([True for key in beam_keys if key in beam_props]):
raise ValueError("The image does not contain complete beam "
"information. Check the output of "
"ia.restoringbeam().")
major = beam_props["major"]["value"] * \
u.Unit(beam_props["major"]["unit"])
minor = beam_props["minor"]["value"] * \
u.Unit(beam_props["minor"]["unit"])
pa = beam_props["positionangle"]["value"] * \
u.Unit(beam_props["positionangle"]["unit"])
return cls(major=major, minor=minor, pa=pa)
def attach_to_header(self, header, copy=True):
'''
Attach the beam information to the provided header.
Parameters
----------
header : astropy.io.fits.header.Header
Header to add/update beam info.
copy : bool, optional
Returns a copy of the inputted header with the beam information.
Returns
-------
copy_header : astropy.io.fits.header.Header
Copy of the input header with the updated beam info when
`copy=True`.
'''
if copy:
header = header.copy()
header.update(self.to_header_keywords())
return header
def __repr__(self):
return "Beam: BMAJ={0} BMIN={1} BPA={2}".format(self.major.to(self.default_unit),self.minor.to(self.default_unit),self.pa.to(u.deg))
def __repr_html__(self):
return "Beam: BMAJ={0} BMIN={1} BPA={2}".format(self.major.to(self.default_unit),self.minor.to(self.default_unit),self.pa.to(u.deg))
def _repr_latex_(self):
return "Beam: BMAJ=${0}^{{{fmt}}}$ BMIN=${1}^{{{fmt}}}$ BPA=${2}^\\circ$".format(self.major.to(self.default_unit).value,
self.minor.to(self.default_unit).value,
self.pa.to(u.deg).value,
fmt = unit_format[self.default_unit])
def __str__(self):
return self.__repr__()
def convolve(self, other):
"""
Convolve one beam with another.
Parameters
----------
other : `Beam`
The beam to convolve with
Returns
-------
new_beam : `Beam`
The convolved Beam
"""
new_major, new_minor, new_pa = convolve(self, other)
return Beam(major=new_major,
minor=new_minor,
pa=new_pa)
def __mul__(self, other):
return self.convolve(other)
# Does division do the same? Or what? Doesn't have to be defined.
def __sub__(self, other):
warnings.warn("Subtraction-as-deconvolution is deprecated. "
"Use division instead.",
RadioBeamDeprecationWarning)
return self.deconvolve(other)
def __truediv__(self, other):
return self.deconvolve(other)
def deconvolve(self, other, failure_returns_pointlike=False):
"""
Deconvolve a beam from another
Parameters
----------
other : `Beam`
The beam to deconvolve from this beam
failure_returns_pointlike : bool
Option to return a pointlike beam (i.e., one with major=minor=0) if
the second beam is larger than the first. Otherwise, a ValueError
will be raised
Returns
-------
new_beam : `Beam`
The convolved Beam
Raises
------
failure : ValueError
If the second beam is larger than the first, the default behavior
is to raise an exception. This can be overridden with
failure_returns_pointlike
"""
new_major, new_minor, new_pa = deconvolve_optimized(self.to_header_keywords(),
other.to_header_keywords(),
failure_returns_pointlike=failure_returns_pointlike)
# Keep the units from before
new_major = (new_major * u.deg).to(self.major.unit)
new_minor = (new_minor * u.deg).to(self.minor.unit)
new_pa = (new_pa * u.rad).to(self.pa.unit)
return Beam(major=new_major, minor=new_minor, pa=new_pa)
def __eq__(self, other):
# Catch floating point issues
atol_deg = 1e-10 * u.deg
this_pa = self.pa.to(u.deg) % (180.0 * u.deg)
other_pa = other.pa.to(u.deg) % (180.0 * u.deg)
if self.iscircular():
equal_pa = True
else:
equal_pa = True if np.abs(this_pa - other_pa) < atol_deg else False
equal_maj = np.abs(self.major - other.major) < atol_deg
equal_min = np.abs(self.minor - other.minor) < atol_deg
if equal_maj and equal_min and equal_pa:
return True
else:
return False
def __ne__(self, other):
return not self.__eq__(other)
# Is it astropy convention to access properties through methods?
@property
def sr(self):
return _to_area(self.major,self.minor)
@property
def major(self):
""" Beam FWHM Major Axis """
return self._major
@property
def minor(self):
""" Beam FWHM Minor Axis """
return self._minor
@property
def pa(self):
return self._pa
@property
def isfinite(self):
return ((self.major > 0) & (self.minor > 0) & np.isfinite(self.major) &
np.isfinite(self.minor) & np.isfinite(self.pa))
def iscircular(self, rtol=1e-6):
frac_diff = (self.major - self.minor).to(u.deg) / self.major.to(u.deg)
return frac_diff <= rtol
def beam_projected_area(self, distance):
"""
Return the beam area in pc^2 (or equivalent) given a distance
"""
return self.sr*(distance**2)/u.sr
def jtok_equiv(self, freq):
'''
Return conversion function between Jy/beam to K at the specified
frequency.
The function can be used with the usual astropy.units conversion:
>>> beam = Beam.from_fits_header("header.fits") # doctest: +SKIP
>>> (1.0*u.Jy).to(u.K, beam.jtok_equiv(1.4*u.GHz)) # doctest: +SKIP
Parameters
----------
freq : astropy.units.quantity.Quantity
Frequency to calculate conversion.
Returns
-------
u.brightness_temperature
'''
if not isinstance(freq, u.quantity.Quantity):
raise TypeError("freq must be a Quantity object. "
"Try 'freq*u.Hz' or another equivalent unit.")
try:
return u.brightness_temperature(beam_area=self.sr, frequency=freq)
except TypeError:
# old astropy used ordered arguments
return u.brightness_temperature(self.sr, freq)
def jtok(self, freq, value=1.0*u.Jy):
"""
Return the conversion for the given value between Jy/beam to K at
the specified frequency.
Unlike :meth:`jtok_equiv`, the output is the numerical value that
converts the units, without any attached unit.
Parameters
----------
freq : astropy.units.quantity.Quantity
Frequency to calculate conversion.
value : astropy.units.quantity.Quantity
Value (in Jy or an equivalent unit) to convert to K.
Returns
-------
value : float
Value converted to K.
"""
return value.to(u.K, self.jtok_equiv(freq))
@property
def beamarea_equiv(self):
return u.beam_angular_area(self.sr)
def commonbeam_with(self, other_beam):
'''
Solve for the common beam with a given `~radio_beam.Beam`.
This common beam operation is only valid for a set of 2 beams.
For the general case, define a set of beams using `~radio_beam.Beams`.
Parameters
----------
other_beam : radio_beam.Beam
The beam to find the common beam with.
'''
from .commonbeam import find_commonbeam_between
return find_commonbeam_between(self, other_beam)
def ellipse_to_plot(self, xcen, ycen, pixscale, **kwargs):
"""
Return a matplotlib ellipse for plotting
Parameters
----------
xcen : int
Center pixel in the x-direction.
ycen : int
Center pixel in the y-direction.
pixscale : `~astropy.units.Quantity`
Conversion from degrees to pixels.
Returns
-------
~matplotlib.patches.Ellipse
Ellipse patch object centered on the given pixel coordinates.
"""
from matplotlib.patches import Ellipse
return Ellipse((xcen, ycen),
width=(self.major.to(u.deg) / pixscale).to(u.dimensionless_unscaled).value,
height=(self.minor.to(u.deg) / pixscale).to(u.dimensionless_unscaled).value,
# PA is 90 deg offset from x-y axes by convention
# (it is angle from NCP)
angle=(self.pa+90*u.deg).to(u.deg).value, **kwargs)
def as_kernel(self, pixscale, **kwargs):
"""
Returns an elliptical Gaussian kernel of the beam.
.. warning::
This method is not aware of any misalignment between pixel
and world coordinates.
Parameters
----------
pixscale : `~astropy.units.Quantity`
Conversion from angular to pixel size.
kwargs : passed to EllipticalGaussian2DKernel
"""
# do something here involving matrices
# need to rotate the kernel into the wcs pixel space, kinda...
# at the least, need to rescale the kernel axes into pixels
stddev_maj = (self.major.to(u.deg)/(pixscale.to(u.deg) *
SIGMA_TO_FWHM)).decompose()
stddev_min = (self.minor.to(u.deg)/(pixscale.to(u.deg) *
SIGMA_TO_FWHM)).decompose()
# position angle is defined as CCW from north
# "angle" is conventionally defined as CCW from "west".
# Therefore, add 90 degrees
angle = (90*u.deg+self.pa).to(u.radian).value,
return EllipticalGaussian2DKernel(stddev_maj.value,
stddev_min.value,
angle,
**kwargs)
def as_tophat_kernel(self, pixscale, **kwargs):
'''
Returns an elliptical Tophat kernel of the beam. The area has
been scaled to match the 2D Gaussian area:
.. math::
\\begin{array}{ll}
A_{\\mathrm{Gauss}} = 2\\pi\\sigma_{\\mathrm{Gauss}}^{2}
A_{\\mathrm{Tophat}} = \\pi\\sigma_{\\mathrm{Tophat}}^{2}
\\sigma_{\\mathrm{Tophat}} = \\sqrt{2}\\sigma_{\\mathrm{Gauss}}
\\end{array}
.. warning::
This method is not aware of any misalignment between pixel
and world coordinates.
Parameters
----------
pixscale : float
deg -> pixels
**kwargs : passed to EllipticalTophat2DKernel
'''
# Based on Gaussian to Tophat area conversion
# A_gaussian = 2 * pi * sigma^2 / (sqrt(8*log(2))^2
# A_tophat = pi * r^2
# pi r^2 = 2 * pi * sigma^2 / (sqrt(8*log(2))^2
# r = sqrt(2)/sqrt(8*log(2)) * sigma
gauss_to_top = np.sqrt(2)
maj_eff = gauss_to_top * self.major.to(u.deg) / \
(pixscale * SIGMA_TO_FWHM)
min_eff = gauss_to_top * self.minor.to(u.deg) / \
(pixscale * SIGMA_TO_FWHM)
# position angle is defined as CCW from north
# "angle" is conventionally defined as CCW from "west".
# Therefore, add 90 degrees
angle = (90*u.deg+self.pa).to(u.radian).value,
return EllipticalTophat2DKernel(maj_eff.value, min_eff.value,
angle, **kwargs)
def to_header_keywords(self):
return {'BMAJ': self.major.to(u.deg).value,
'BMIN': self.minor.to(u.deg).value,
'BPA': self.pa.to(u.deg).value,
}
# Beam.__doc__ = Beam.__doc__ + Beam.__new__.__doc__
def mywcs_to_platescale(mywcs):
pix_area = wcs.utils.proj_plane_pixel_area(mywcs)
return pix_area**0.5
class EllipticalGaussian2DKernel(Kernel2D):
"""
2D Elliptical Gaussian filter kernel.
The Gaussian filter is a filter with great smoothing properties. It is
isotropic and does not produce artifacts.
Parameters
----------
stddev_maj : float
Standard deviation of the Gaussian kernel in direction 1
stddev_min : float
Standard deviation of the Gaussian kernel in direction 1
position_angle : float
Position angle of the elliptical gaussian
x_size : odd int, optional
Size in x direction of the kernel array. Default = support_scaling *
stddev.
y_size : odd int, optional
Size in y direction of the kernel array. Default = support_scaling *
stddev.
support_scaling : int
The amount to scale the stddev to determine the size of the kernel
mode : str, optional
One of the following discretization modes:
* 'center' (default)
Discretize model by taking the value
at the center of the bin.
* 'linear_interp'
Discretize model by performing a bilinear interpolation
between the values at the corners of the bin.
* 'oversample'
Discretize model by taking the average
on an oversampled grid.
* 'integrate'
Discretize model by integrating the
model over the bin.
factor : number, optional
Factor of oversampling. Default factor = 10.
See Also
--------
Box2DKernel, Tophat2DKernel, MexicanHat2DKernel, Ring2DKernel,
TrapezoidDisk2DKernel, AiryDisk2DKernel, Gaussian2DKernel,
EllipticalTophat2DKernel
Examples
--------
Kernel response:
.. plot::
:include-source:
import matplotlib.pyplot as plt
from radio_beam import EllipticalGaussian2DKernel
gaussian_2D_kernel = EllipticalGaussian2DKernel(10, 5, np.pi/4)
plt.imshow(gaussian_2D_kernel, interpolation='none', origin='lower')
plt.xlabel('x [pixels]')
plt.ylabel('y [pixels]')
plt.colorbar()
plt.show()
"""
_separable = True
_is_bool = False
def __init__(self, stddev_maj, stddev_min, position_angle,
support_scaling=8, **kwargs):
self._model = Gaussian2D(1. / (2 * np.pi * stddev_maj * stddev_min), 0,
0, x_stddev=stddev_maj, y_stddev=stddev_min,
theta=position_angle)
try:
from astropy.modeling.utils import ellipse_extent
except ImportError:
raise NotImplementedError("EllipticalGaussian2DKernel requires"
" astropy 1.1b1 or greater.")
max_extent = \
np.max(ellipse_extent(stddev_maj, stddev_min, position_angle))
self._default_size = \
_round_up_to_odd_integer(support_scaling * 2 * max_extent)
super(EllipticalGaussian2DKernel, self).__init__(**kwargs)
self._truncation = np.abs(1. - 1 / self._array.sum())
class EllipticalTophat2DKernel(Kernel2D):
"""
2D Elliptical Tophat filter kernel.
The Tophat filter can produce artifacts when applied
repeatedly on the same data.
Parameters
----------
stddev_maj : float
Standard deviation of the Gaussian kernel in direction 1
stddev_min : float
Standard deviation of the Gaussian kernel in direction 1
position_angle : float
Position angle of the elliptical gaussian
x_size : odd int, optional
Size in x direction of the kernel array. Default = support_scaling *
stddev.
y_size : odd int, optional
Size in y direction of the kernel array. Default = support_scaling *
stddev.
support_scaling : int
The amount to scale the stddev to determine the size of the kernel
mode : str, optional
One of the following discretization modes:
* 'center' (default)
Discretize model by taking the value
at the center of the bin.
* 'linear_interp'
Discretize model by performing a bilinear interpolation
between the values at the corners of the bin.
* 'oversample'
Discretize model by taking the average
on an oversampled grid.
* 'integrate'
Discretize model by integrating the
model over the bin.
factor : number, optional
Factor of oversampling. Default factor = 10.
See Also
--------
Box2DKernel, Tophat2DKernel, MexicanHat2DKernel, Ring2DKernel,
TrapezoidDisk2DKernel, AiryDisk2DKernel, Gaussian2DKernel,
EllipticalGaussian2DKernel
Examples
--------
Kernel response:
.. plot::
:include-source:
import matplotlib.pyplot as plt
from radio_beam import EllipticalTophat2DKernel
tophat_2D_kernel = EllipticalTophat2DKernel(10, 5, np.pi/4)
plt.imshow(tophat_2D_kernel, interpolation='none', origin='lower')
plt.xlabel('x [pixels]')
plt.ylabel('y [pixels]')
plt.colorbar()
plt.show()
"""
_is_bool = True
def __init__(self, stddev_maj, stddev_min, position_angle, support_scaling=1,
**kwargs):
self._model = Ellipse2D(1. / (np.pi * stddev_maj * stddev_min), 0, 0,
stddev_maj, stddev_min, position_angle)
try:
from astropy.modeling.utils import ellipse_extent
except ImportError:
raise NotImplementedError("EllipticalTophat2DKernel requires"
" astropy 1.1b1 or greater.")
max_extent = \
np.max(ellipse_extent(stddev_maj, stddev_min, position_angle))
self._default_size = \
_round_up_to_odd_integer(support_scaling * 2 * max_extent)
super(EllipticalTophat2DKernel, self).__init__(**kwargs)
self._truncation = 0