SkyCircularAperture¶
- class photutils.aperture.SkyCircularAperture(positions, r)[source]¶
Bases:
SkyAperture
A circular aperture defined in sky coordinates.
The aperture has a single fixed size/shape, but it can have multiple positions (see the
positions
input).- Parameters:
Examples
>>> from astropy.coordinates import SkyCoord >>> import astropy.units as u >>> from photutils.aperture import SkyCircularAperture >>> positions = SkyCoord(ra=[10.0, 20.0], dec=[30.0, 40.0], unit='deg') >>> aper = SkyCircularAperture(positions, 0.5*u.arcsec)
Attributes Summary
Whether the instance is scalar (i.e., a single position).
The center position(s) in sky coordinates.
The radius in angular units.
The shape of the instance.
Methods Summary
copy
()Make an independent (deep) copy.
to_pixel
(wcs)Convert the aperture to a
CircularAperture
object defined in pixel coordinates.Attributes Documentation
- isscalar¶
Whether the instance is scalar (i.e., a single position).
- positions¶
The center position(s) in sky coordinates.
- r¶
The radius in angular units.
- shape¶
The shape of the instance.
Methods Documentation
- copy()¶
Make an independent (deep) copy.
- to_pixel(wcs)[source]¶
Convert the aperture to a
CircularAperture
object 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
CircularAperture
object A
CircularAperture
object.
- aperture