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

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


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/synthpop/modules/post_processing/_post_processing/index
   /autoapi/synthpop/modules/post_processing/additional_cuts/index
   /autoapi/synthpop/modules/post_processing/blending/index
   /autoapi/synthpop/modules/post_processing/combined_csv/index
   /autoapi/synthpop/modules/post_processing/convert_mist_mags/index
   /autoapi/synthpop/modules/post_processing/equatorial_coordinates/index
   /autoapi/synthpop/modules/post_processing/gulls_post_processing/index
   /autoapi/synthpop/modules/post_processing/popsycle_post_processing/index
   /autoapi/synthpop/modules/post_processing/process_dark_compact_objects/index
   /autoapi/synthpop/modules/post_processing/recalculate_kinematics/index
   /autoapi/synthpop/modules/post_processing/rename_columns/index


Classes
-------

.. autoapisummary::

   synthpop.modules.post_processing.PostProcessing


Package Contents
----------------

.. py:class:: PostProcessing(model: types.ModuleType = None, logger: types.ModuleType = None, sun: types.ModuleType = None, **kwargs)

   Base class for post-processing, for catalog modifications after the
   regular SynthPop generation process has completed.


   .. py:attribute:: model
      :value: None



   .. py:attribute:: logger
      :value: None



   .. py:attribute:: sun
      :value: None



   .. 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