opticam.finders

Classes

DefaultFinder

Default source finder. Combines image segmentation with source deblending.

Functions

get_source_coords_from_image(image, finder, threshold)

Get an array of source coordinates from an image in descending order of source brightness.

Module Contents

class opticam.finders.DefaultFinder(npixels, border_width=0)

Default source finder. Combines image segmentation with source deblending.

Parameters:
  • npixels (int)

  • border_width (int)

border_width = 0
finder
__call__(data, threshold)
Parameters:
  • data (numpy.typing.NDArray)

  • threshold (float | numpy.typing.NDArray)

Return type:

astropy.table.QTable

opticam.finders.get_source_coords_from_image(image, finder, threshold, bkg=None, n_sources=None, background=None)

Get an array of source coordinates from an image in descending order of source brightness.

Parameters

imageNDArray

The non-background-subtracted image from which to extract source coordinates.

bkgBackground2D, optional

The background of the image, by default None. If None, the background is estimated from the image.

n_sourcesint, optional

The number of source coordinates to return, by default None (all sources will be returned).

Returns

NDArray

The source coordinates in descending order of brightness.

Parameters:
Return type:

numpy.typing.NDArray