py4py.reverb.output
===================

.. py:module:: py4py.reverb.output

.. autoapi-nested-parse::

   Reverberation mapping output module

   This contains helper functions that bundle up the production of multiple transfer functions or the creation of
   response functions.



.. autoapisummary::

   py4py.reverb.output.do_tf_plots
   py4py.reverb.output.do_rf_plots


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

.. py:function:: do_tf_plots(tf_list_inp: List[py4py.reverb.TransferFunction], dynamic_range: Optional[float] = None, keplerian: Optional[dict] = None, name: Optional[str] = None, file: Optional[str] = None, threshold: float = 0.8)

   Produces plots of the transfer functions for a list of provided TFs,
   with matching plotted dynamic ranges and name structures.
   Also optionally generates a file containing the centroid delays for each transfer function.

   :param tf_list_inp: The transfer functions to plot.
   :type tf_list_inp: List[TransferFunction]
   :param dynamic_range: The dynamic range to plot them all across (see TransferFunction.plot).
   :type dynamic_range: Optional[float]
   :param keplerian: The keplerian orbit parameters to overplot on all of them.
   :type keplerian: Optional[dict]
   :param name: The name component to be added to the output plot filenames,
                e.g. [tf.name]_[name].eps. Useful for ending up with e.g. c4_with_keplerian.eps.
   :type name: Optional[str]
   :param file: The output filename for the list of centroid delays.
   :type file: Optional[str]
   :param threshold: The peak flux threshold to use for calculating the centroid (see TransferFunction.delay).
   :type threshold: float

   Outputs:
      ` {file}_tf_delay.txt` [Optional]
       `{tf.filename}_name.eps` [for each tf in tf_list_inp]


.. py:function:: do_rf_plots(tf_min: py4py.reverb.TransferFunction, tf_mid: py4py.reverb.TransferFunction, tf_max: py4py.reverb.TransferFunction, keplerian: Optional[dict] = None, name: Optional[str] = None, file: Optional[str] = None)

   Do response plot for a transfer function, optionally with keplerian disk lines on it.
   This will generate not just a response function from the two bracketing TFs, but one
   from the midpoint TF and the bracketing ones (e.g. Min-Max, Min-Mid, Mid-Max).
   Ideally, all three should be similar- if they are not, it suggests that the change
   in luminosity from min-max covers a point of inflection in d[Ionisation state]dL.

   :param tf_min: The low-state TF
   :type tf_min: TransferFunction
   :param tf_mid: The TF bracketed by low and high to produce the RF for.
   :type tf_mid: TransferFunction
   :param tf_max: The high-state TF
   :type tf_max: TransferFunction
   :param keplerian: The keplerian orbit parameters to overplot on all of them.
   :type keplerian: Optional[dict]
   :param name: The name component to be added to the output plot filenames,
                e.g. [tf.name]_[name].eps. Useful for ending up with e.g. c4_with_keplerian.eps.
   :type name: Optional[str]
   :param file: The output filename for the list of centroid delays.
   :type file: Optional[str]

   Outputs:
       `{tf_mid.name}_resp_mid.eps`
       `{tf_mid.name}_resp_low.eps`
       `{tf_mid.name}_resp_high.eps`
       `{file}_rf_delay.txt` [Optional]