data_properties

photutils.morphology.data_properties(data, mask=None, background=None, wcs=None)

Calculate the morphological properties (and centroid) of a 2D array (e.g., an image cutout of an object) using image moments.

Parameters:

dataarray_like or Quantity

The 2D array of the image.

maskarray_like (bool), optional

A boolean mask, with the same shape as data, where a True value indicates the corresponding element of data is masked. Masked data are excluded from all calculations.

backgroundfloat, array_like, or Quantity, optional

The background level that was previously present in the input data. background may either be a scalar value or a 2D image with the same shape as the input data. Inputting the background merely allows for its properties to be measured within each source segment. The input background does not get subtracted from the input data, which should already be background-subtracted.

wcsWCS object or None, optional

A world coordinate system (WCS) transformation that supports the astropy shared interface for WCS (e.g., astropy.wcs.WCS, gwcs.wcs.WCS). If None, then all sky-based properties will be set to None.

Returns:

resultSourceCatalog instance

A SourceCatalog object.