opticam.finders
===============

.. py:module:: opticam.finders


Classes
-------

.. autoapisummary::

   opticam.finders.DefaultFinder


Functions
---------

.. autoapisummary::

   opticam.finders.get_source_coords_from_image


Module Contents
---------------

.. py:class:: DefaultFinder(npixels, border_width = 0)

   Default source finder. Combines image segmentation with source deblending.


   .. py:attribute:: border_width
      :value: 0



   .. py:attribute:: finder


   .. py:method:: __call__(data, threshold)


.. py:function:: get_source_coords_from_image(image, finder, threshold, bkg = None, n_sources = None, background = None, return_fwhm = False, aperture_selector = None)

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

   Parameters
   ----------
   image : NDArray
       The **non-background-subtracted** image from which to extract source coordinates.
   finder : DefaultFinder
       The source finder.
   threshold : float | int
       The source detection threshold in units of background RMS.
   bkg : Background2D, optional
       The background of the image, by default `None`. If `None`, the background is estimated from the image.
   n_sources : int, optional
       The number of source coordinates to return, by default `None` (all sources will be returned).
   background: BaseBackground | None, optional
       The background estimator if `bkg = None`, by default `None`. Either `bkg` or `background` must be defined.
   return_fwhm : bool, optional
       Whether to return the average PSF FWHM of the image, by default `False`.
   aperture_selector : Callable[[NDArray[np.float64]], float] | None, optional
       The function to use to compute the average PSF FWHM, by default `None`. If a function is passed, it must take
       an array of floats and return a float (e.g., `np.median`).

   Returns
   -------
   NDArray
       The source coordinates in descending order of brightness.