sourcefinder.utility.sourceparams
=================================

.. py:module:: sourcefinder.utility.sourceparams


Attributes
----------

.. autoapisummary::

   sourcefinder.utility.sourceparams._source_params_descriptions
   sourcefinder.utility.sourceparams.file_fields


Classes
-------

.. autoapisummary::

   sourcefinder.utility.sourceparams.SourceParams


Functions
---------

.. autoapisummary::

   sourcefinder.utility.sourceparams.describe_dataframe_columns
   sourcefinder.utility.sourceparams.make_measurements_dataframe


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

.. py:class:: SourceParams

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   
   Enumeration of source parameters that can be measured and stored.
















   ..
       !! processed by numpydoc !!

   .. py:method:: describe() -> str

      
      Return a description of the source parameter.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: CHISQ
      :value: 'chisq'



   .. py:attribute:: DEC
      :value: 'dec'



   .. py:attribute:: DEC_ERR
      :value: 'dec_err'



   .. py:attribute:: ERROR_RADIUS
      :value: 'error_radius'



   .. py:attribute:: FLUX
      :value: 'flux'



   .. py:attribute:: FLUX_ERR
      :value: 'flux_err'



   .. py:attribute:: PEAK
      :value: 'peak'



   .. py:attribute:: PEAK_ERR
      :value: 'peak_err'



   .. py:attribute:: RA
      :value: 'ra'



   .. py:attribute:: RA_ERR
      :value: 'ra_err'



   .. py:attribute:: REDUCED_CHISQ
      :value: 'reduced_chisq'



   .. py:attribute:: SIG
      :value: 'sig'



   .. py:attribute:: SMAJ
      :value: 'smaj'



   .. py:attribute:: SMAJ_ASEC
      :value: 'smaj_asec'



   .. py:attribute:: SMAJ_ASEC_ERR
      :value: 'smaj_asec_err'



   .. py:attribute:: SMAJ_DC
      :value: 'smaj_dc'



   .. py:attribute:: SMAJ_DC_ERR
      :value: 'smaj_dc_err'



   .. py:attribute:: SMAJ_ERR
      :value: 'smaj_err'



   .. py:attribute:: SMIN
      :value: 'smin'



   .. py:attribute:: SMIN_ASEC
      :value: 'smin_asec'



   .. py:attribute:: SMIN_ASEC_ERR
      :value: 'smin_asec_err'



   .. py:attribute:: SMIN_DC
      :value: 'smin_dc'



   .. py:attribute:: SMIN_DC_ERR
      :value: 'smin_dc_err'



   .. py:attribute:: SMIN_ERR
      :value: 'smin_err'



   .. py:attribute:: THETA
      :value: 'theta'



   .. py:attribute:: THETA_CELES
      :value: 'theta_celes'



   .. py:attribute:: THETA_CELES_ERR
      :value: 'theta_celes_err'



   .. py:attribute:: THETA_DC
      :value: 'theta_dc'



   .. py:attribute:: THETA_DC_CELES
      :value: 'theta_dc_celes'



   .. py:attribute:: THETA_DC_CELES_ERR
      :value: 'theta_dc_celes_err'



   .. py:attribute:: THETA_DC_ERR
      :value: 'theta_dc_err'



   .. py:attribute:: THETA_ERR
      :value: 'theta_err'



   .. py:attribute:: X
      :value: 'x'



   .. py:attribute:: X_ERR
      :value: 'x_err'



   .. py:attribute:: Y
      :value: 'y'



   .. py:attribute:: Y_ERR
      :value: 'y_err'



.. py:function:: describe_dataframe_columns(df: pandas.DataFrame) -> dict[str, str]

.. py:function:: make_measurements_dataframe(moments_of_sources, sky_barycenters, ra_errors, dec_errors, smaj_asec, errsmaj_asec, smin_asec, errsmin_asec, theta_celes_values, theta_celes_errors, theta_dc_celes_values, theta_dc_celes_errors, error_radii, sig, chisq, reduced_chisq)

   
   Create a Pandas DataFrame with parameters related to detected sources
   from a subset of the tuple of Numpy ndarrays returned by the
   `extract.source_measurements_vectorised` function.
















   ..
       !! processed by numpydoc !!

.. py:data:: _source_params_descriptions

.. py:data:: file_fields
   :value: ['PEAK', 'PEAK_ERR', 'FLUX', 'FLUX_ERR', 'X', 'Y', 'RA', 'RA_ERR', 'DEC', 'DEC_ERR',...