synthpop.modules.post_processing.blending
=========================================

.. py:module:: synthpop.modules.post_processing.blending

.. autoapi-nested-parse::

   Postprocessing module to calculate blended magnitude of all stars within a given blend radius.
   Note: consider using no regular magnitude cut, then running additional_cuts after this module
       to cut on blend magnitude.



Classes
-------

.. autoapisummary::

   synthpop.modules.post_processing.blending.Blending


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

.. py:class:: Blending(model, blend_radius, filters, logger, **kwargs)

   Bases: :py:obj:`synthpop.modules.post_processing._post_processing.PostProcessing`


   Postprocessing module to calculate blended magnitudes in selected filters
   for a given blend radius. To use different radii for different filters,
   include multiple instances of this postproc in your configuration.

   Attributes
   ----------
   blend_radius : float
       blending radius in arcseconds
   filters : list of str
       names of filters to compute blended magnitude in;
       must be included in your config's chosen_bands


   .. py:attribute:: blend_radius


   .. py:attribute:: filters


   .. py:method:: get_obs_mags(dataframe, filt)


   .. py:method:: do_post_processing(dataframe: pandas.DataFrame) -> pandas.DataFrame

      This is a placeholder for the postprocessing.
      It must accept the pandas data frame and must return a pandas data frame.

      Parameters
      ----------
      dataframe : dataframe
          original SynthPop output as pandas data frame

      Returns
      -------
      dataframe : dataframe
          modified pandas data frame