SkyEllipticalAperture#
- class photutils.aperture.SkyEllipticalAperture(positions, a, b, theta=<Quantity 0. deg>)[source]#
Bases:
SkyApertureAn elliptical aperture defined in sky coordinates.
The aperture has a single fixed size/shape, but it can have multiple positions (see the
positionsinput).- Parameters:
- positions
SkyCoord The celestial coordinates of the aperture center(s). This can be either scalar coordinates or an array of coordinates.
- ascalar
Quantity The semimajor axis of the ellipse in angular units.
- bscalar
Quantity The semiminor axis of the ellipse in angular units.
- thetascalar
Quantity, optional The position angle (in angular units) of the ellipse semimajor axis, measured from North (PA=0) toward East. This is counterclockwise on an image displayed with North up and East to the left. North and East are the directions of increasing latitude and longitude in the coordinate frame of
positions(e.g., ICRS or Galactic). When the aperture is converted to pixels with a WCS whose celestial frame differs from that frame, the angle is converted to the equivalent angle in the WCS frame, so the aperture keeps the same orientation on the sky.
- positions
- Raises:
- TypeError
TypeError If either axis (
aorb) is not aQuantity.- ValueError
ValueError If either axis (
aorb) is not positive.
- TypeError
Examples
>>> from astropy.coordinates import SkyCoord >>> import astropy.units as u >>> from photutils.aperture import SkyEllipticalAperture >>> positions = SkyCoord(ra=[10.0, 20.0], dec=[30.0, 40.0], unit='deg') >>> aper = SkyEllipticalAperture(positions, 1.0*u.arcsec, 0.5*u.arcsec)
Attributes Summary
The semimajor axis in angular units.
The semiminor axis in angular units.
Whether the instance is scalar (i.e., a single position).
The center position(s) in sky coordinates.
The shape of the instance.
The position angle in angular units of the ellipse semimajor axis.
Methods Summary
copy()Make a deep copy of this object.
to_pixel(wcs)Convert the aperture to an
EllipticalApertureobject defined in pixel coordinates.to_polygon(*[, n_vertices])Return a
SkyPolygonAperturethat approximates this elliptical aperture.Attributes Documentation
- a#
The semimajor axis in angular units.
- b#
The semiminor axis in angular units.
- isscalar#
Whether the instance is scalar (i.e., a single position).
- positions#
The center position(s) in sky coordinates.
- shape#
The shape of the instance.
- theta#
The position angle in angular units of the ellipse semimajor axis.
Methods Documentation
- to_pixel(wcs)[source]#
Convert the aperture to an
EllipticalApertureobject defined in pixel coordinates.- Parameters:
- wcsWCS object
A world coordinate system (WCS) transformation that supports the astropy shared interface for WCS (e.g.,
astropy.wcs.WCS,gwcs.wcs.WCS).
- Returns:
- aperture
EllipticalApertureobject An
EllipticalApertureobject.
- aperture
Notes
The aperture shape parameters are converted using the local WCS properties (pixel scale, rotation angle) evaluated at the first aperture position. Because aperture objects require scalar shape parameters, only a single reference position is used for the conversion. For apertures with multiple positions used with a WCS that has spatially-varying distortions, this may produce inaccurate results for positions far from the first position.
- to_polygon(*, n_vertices=100)[source]#
Return a
SkyPolygonAperturethat approximates this elliptical aperture.- Parameters:
- n_verticesint, optional
The number of polygon vertices used to approximate the ellipse. Must be at least 3. Default is 100.
- Returns:
- aperture
SkyPolygonAperture A sky polygon aperture that approximates the ellipse.
- aperture