multi_image_photometry#

stellarphot.photometry.photometry.multi_image_photometry(directory_with_images, photometry_settings, reject_unmatched=True, object_of_interest=None)[source]#

Perform aperture photometry on a directory of images.

Parameters:
directory_with_imagesstr

Folder containing the images on which to do photometry. Photometry will only be done on images that contain the object_of_interest. All images must have WCS headers and the following headers: OBJECT, DATE-OBS, an exposure time header (which can be any of the following: EXPOSURE, EXPTIME, TELAPSE, ELAPTIME, ONTIME, or LIVETIME), and FILTER. If AIRMASS is available it will be added to phot_table.

photometry_settingsstellarphot.settings.PhotometrySettings

Photometry settings to use for the photometry. This includes the camera, observatory, the aperture and annulus radii to use for the photometry, a map of passbands from your filters to AAVSO filter names, and options for the photometry. See stellarphot.settings.PhotometrySettings for more information.

reject_unmatchedbool, optional (Default: True)

If True, any sources that are not detected on all the images are rejected. If you are interested in a source that can intermittently fall below your detection limits, we suggest setting this to False so that all sources detected on each image are reported.

object_of_intereststr, optional (Default: None)

Name of the object of interest. The only files on which photometry will be done are those whose header contains the keyword OBJECT whose value is object_of_interest. Only used for multi-image photometry to select which files to perform photometry on.

Returns:
phot_tablestellarphot.PhotometryData

Photometry data for all the sources on which aperture photometry was performed in all the images. This may be a subset of the sources in the sourcelist if locations were too close to the edge of any one image or to each other for successful aperture photometry.