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

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

.. autoapi-nested-parse::

   Postprocessing module to improve the estimation of F146 wide-filter extinction
   with a polynomial function of A_Ks and narrower filter colors.



Classes
-------

.. autoapisummary::

   synthpop.modules.post_processing.estimate_roman_extinction.EstimateRomanExtinction


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

.. py:class:: EstimateRomanExtinction(model, logger, mag_sys='None', use_low_extinction=False, **kwargs)

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


   Postprocessing module to apply a correction to F146 extinction

   Attributes
   ----------


   .. py:attribute:: use_low_extinction
      :value: False



   .. py:attribute:: roman_filter_list
      :value: ['f062', 'f087', 'f106', 'f129', 'f158', 'f184', 'f213', 'f146']



   .. py:method:: generic_extinction_polynomial(AKs_C, coeffs, order)
      :staticmethod:


      Generic polynomial function of flexible order. Any number of colors
      may be input, and cross-terms are computed between A_Ks and each color,
      not between different colors.

      Identical function to that used to run the fits.

      Parameters:
      -----------
      AKs_C : ndarray
          array of extinction and color values to compute extinction estimate
      coeffs : ndarray
          array of coefficients for the polynomial function
      order : int
          polynomial order for the extinction coefficient function

      Returns:
      --------
      ext_ests : ndarray
          extinction estimates for each star in the AKs_C table



   .. py:method:: get_roman_extinction_sim(catalog)

      Roman extinction estimator for simulations. Assumes all Roman filter photometry 
      is provided and in absolute AB mags.

      Parameters:
      -----------
      catalog : pd.DataFrame, astropy.table.Table, or similar
          required columns: A_Ks, f062, f087, f106, f129, f158, f184, f213, and f146
      low_extinction=False : boolean
          if all A_Ks<=1, use the alternate lower order correction. if any A_Ks>1, a warning
          will be printed, and the higher order correction will be used
          
      Returns:
      --------
      extinctions : dict
          entries of '<filter>':[<ext_star1>, <ext_star2>, ...] for each filter



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

      Run the process