py4py.reverb.output

Reverberation mapping output module

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

do_tf_plots(tf_list_inp[, dynamic_range, keplerian, ...])

Produces plots of the transfer functions for a list of provided TFs,

do_rf_plots(tf_min, tf_mid, tf_max[, keplerian, name, ...])

Do response plot for a transfer function, optionally with keplerian disk lines on it.

Module Contents

py4py.reverb.output.do_tf_plots(tf_list_inp: List[py4py.reverb.TransferFunction], dynamic_range: float | None = None, keplerian: dict | None = None, name: str | None = None, file: str | None = 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.

Parameters:

  • tf_list_inp (List[TransferFunction]) – The transfer functions to plot.

  • dynamic_range (Optional[float]) – The dynamic range to plot them all across (see TransferFunction.plot).

  • keplerian (Optional[dict]) – The keplerian orbit parameters to overplot on all of them.

  • name (Optional[str]) – 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.

  • file (Optional[str]) – The output filename for the list of centroid delays.

  • threshold (float) – The peak flux threshold to use for calculating the centroid (see TransferFunction.delay).

Outputs:
` {file}_tf_delay.txt` [Optional]

{tf.filename}_name.eps [for each tf in tf_list_inp]

py4py.reverb.output.do_rf_plots(tf_min: py4py.reverb.TransferFunction, tf_mid: py4py.reverb.TransferFunction, tf_max: py4py.reverb.TransferFunction, keplerian: dict | None = None, name: str | None = None, file: str | None = 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.

Parameters:

  • tf_min (TransferFunction) – The low-state TF

  • tf_mid (TransferFunction) – The TF bracketed by low and high to produce the RF for.

  • tf_max (TransferFunction) – The high-state TF

  • keplerian (Optional[dict]) – The keplerian orbit parameters to overplot on all of them.

  • name (Optional[str]) – 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.

  • file (Optional[str]) – The output filename for the list of centroid delays.

Outputs:

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