astrowisp.background module

Class Inheritance Diagram

Inheritance diagram of BackgroundExtractor, c_double, c_uint

Interface to the AstroWISP background library.

class astrowisp.background.BackgroundExtractor(image, inner_radius, outer_radius, error_confidence=0.68)[source]

Bases: object

Inheritance diagram of astrowisp.background.BackgroundExtractor

Measure the background level for each source in an image.

image

The image being processed.

inner_radius

The size of the aperture aronud each source within which pixels are excluded from background measurement.

outer_radius

The outer rim of the aperture around each source within which unrejected pixels are included in the background measurement.

error_confidence

The confidence level to use for estimating the background error.

__call__(source_x, source_y)[source]

Measure the background under the sources with the given coordinates.

Parameters:
  • source_x – The x coordinates of the sources within the image.

  • source_y – The y coordinates of the sources within the image.

Returns:

numpy.array:

The estimate of the background under each source in the same order as the input sources.

numpy.array:

The estimate of the uncertainty in the background under each source in the same order as the input sources.

numpy.array:

The number of pixels which were used to derive the background and its uncertainty.

Return type:

tuple

__del__()[source]

Destroy the image and extractor created in __init__().

__init__(image, inner_radius, outer_radius, error_confidence=0.68)[source]

Create a background extractor with the given parameters.

Args: see class attributes.

Returns: None