Apertures
All apertures will rely on a position and the shape parameters.
aperture = Aperture(x0, y0, shape_params...)
The position can be pixels or sky coordinates. The sky coordinate positions utilize SkyCoords.jl and WCS.jl for conversion.
The pixel positions for these apertures follow traditional image position with 1-based indexing. This means the origin is at top-left and has index (0.5, 0.5)
at the top-left corner and (1, 1)
at the center.
Circular Apertures
These apertures are parametrized by radius.
Photometry.Aperture.CircularAperture
— TypeCircularAperture(x, y, r)
CircularAperture([x, y], r)
A circular aperture.
Examples
julia> ap = CircularAperture(0, 0, 10)
CircularAperture(0, 0, r=10)
Photometry.Aperture.CircularAnnulus
— TypeCircularAnnulus(x, y, r_in, r_out)
CircularAnnulus([x, y], r_in, r_out)
A circular aperture.
Examples
julia> ap = CircularAnnulus(0, 0, 5, 10)
CircularAnnulus(0, 0, r_in=5, r_out=10)
Elliptical Apertures
These apertures are parametrized by the semi-major axis a
and semi-minor axis b
.
Rectangular Apertures
These apertures are parametrized by side-length a
and side-length b
.
API/Reference
Photometry.Aperture.AbstractAperture
— TypeThe abstract super-type for Apertures
Photometry.Aperture.mask
— Functionmask(::AbstractAperture; method=:exact)
Return an array of the weighting of the aperture in the minimum bounding box. For an explanation of the different methods, see aperture_photometry
.
Photometry.Aperture.cutout
— Functioncutout(::AbstractAperture, data)
Get the cutout of the aperture from the data
. This will handle partial overlap by padding the data with zeros.