Source code for lenstronomy.GalKin.aperture
__author__ = 'sibirrer'
from lenstronomy.GalKin.aperture_types import Shell, Slit, IFUShells, Frame
__all__ = ['Aperture']
"""
class that defines the aperture of the measurement (e.g. slit, integral field spectroscopy regions etc)
Available aperture types:
-------------------------
'slit': length, width, center_ra, center_dec, angle
'shell': r_in, r_out, center_ra, center_dec
"""
[docs]class Aperture(object):
"""
defines mask(s) of spectra, can handle IFU and single slit/box type data.
"""
def __init__(self, aperture_type, **kwargs_aperture):
"""
:param aperture_type: string
:param kwargs_aperture: keyword arguments reflecting the aperture type chosen.
We refer to the specific class instances for documentation.
"""
if aperture_type == 'slit':
self._aperture = Slit(**kwargs_aperture)
elif aperture_type == 'shell':
self._aperture = Shell(**kwargs_aperture)
elif aperture_type == 'IFU_shells':
self._aperture = IFUShells(**kwargs_aperture)
elif aperture_type == 'frame':
self._aperture = Frame(**kwargs_aperture)
else:
raise ValueError("aperture type %s not implemented! Available are 'slit', 'shell', 'IFU_shells'. " % aperture_type)
[docs] def aperture_select(self, ra, dec):
"""
:param ra: angular coordinate of photon/ray
:param dec: angular coordinate of photon/ray
:return: bool, True if photon/ray is within the slit, False otherwise, int of the segment of the IFU
"""
return self._aperture.aperture_select(ra, dec)
@property
def num_segments(self):
return self._aperture.num_segments