Utility Functions (photutils.utils)#

Introduction#

The photutils.utils package contains general-purpose utility functions that do not fit into any of the other subpackages.

Some functions and classes of note include:

  • CutoutImage: Class to create a cutout object from a 2D array.

  • ImageDepth: Class to calculate the limiting flux and magnitude of an image by placing random circular apertures on blank regions.

  • ShepardIDWInterpolator: Class to perform inverse distance weighted (IDW) interpolation.

  • calc_total_error(): Function to calculate the total error in an image by combining a background-only error array with the source Poisson error.

  • circular_footprint(): Function to create a circular footprint array.

  • make_random_cmap(): Function to create a colormap consisting of random muted colors. This type of colormap is useful for plotting segmentation images.

  • NoDetectionsWarning: Warning class to indicate no sources were detected.

API Reference#

Utility Functions (photutils.utils)