sourcextractor.config.aperture Namespace Reference

Functions
def	add_aperture_photometry (target, apertures)

Variables
dictionary	apertures_for_image = {}
	Aperture = cpp.Aperture

Function Documentation

add_aperture_photometry()

def sourcextractor.config.aperture.add_aperture_photometry	(		target,
			apertures
	)

Flux measurement from the image above the background inside a circular aperture.

Parameters
----------
target : MeasurementImage object, or leaf MeasurementGroup object with a single image, or a list of either
    Target images on which to measure the aperture photometry. Leaf MeasurementGroup with a single image
    are accepted as a convenience.

apertures : float, or list of float
    Diameter of the aperture. As different MeasurementImage may not be aligned, nor have equivalent pixel size,
    the aperture is interpreted as diameter in pixels of a circle on the detection image.
    A transformation will be applied for each frame, so the covered area is equivalent.

Returns
-------
list of Aperture objects
    An Aperture object is an internal representation of a property on the measurement frame that contains the
    apertures. To actually get the measurements on the output catalog, you need to add explicitly them to the
    output.

See Also
--------
add_output_column

Notes
-----
This property will generate five columns with the prefix specified by `add_output_column`:
- ``_flux`` and ``_flux_err``, for the flux and its associated error
- ``_mag`` and ``_mag_err``, for the magnitude and its associated error
- ``_flags``, to mark, for instance, saturation, boundary conditions, etc.

For M apertures and N images, the cells on the output column will be an array of MxN fluxes.

Examples
--------
>>> measurement_group = MeasurementGroup(load_fits_images(frames, psfs))
>>> all_apertures = []
>>> for img in measurement_group:
>>>     all_apertures.extend(add_aperture_photometry(img, [5, 10, 20]))
>>> add_output_column('aperture', all_apertures)

Definition at line 29 of file aperture.py.

References sourcextractor.config.aperture.add_aperture_photometry(), sourcextractor.config.output.add_output_column(), and sourcextractor.config.measurement_images.load_fits_images().

Referenced by sourcextractor.config.aperture.add_aperture_photometry().

Here is the call graph for this function:

Variable Documentation

Aperture

sourcextractor.config.aperture.Aperture = cpp.Aperture

Definition at line 26 of file aperture.py.

apertures_for_image

dictionary sourcextractor.config.aperture.apertures_for_image = {}

Definition at line 23 of file aperture.py.