File: utils.rst

package info (click to toggle)
photutils 2.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,016 kB
  • sloc: python: 29,584; makefile: 115
file content (31 lines) | stat: -rw-r--r-- 971 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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:

* :class:`~photutils.utils.ImageDepth`: Class to calculate the limiting
  flux and magnitude of an image by placing random circular apertures on
  blank regions.

* :class:`~photutils.utils.ShepardIDWInterpolator`: Class to perform
  inverse distance weighted (IDW) interpolation.

* :func:`~photutils.utils.calc_total_error`: Function to calculate the
  total error in an image by combining a background-only error array with
  the source Poisson error.

* :func:`~photutils.utils.make_random_cmap`: Function to create a
  colormap consisting of random muted colors. This type of colormap is
  useful for plotting segmentation images.


API Reference
-------------

:doc:`../reference/utils_api`