pyvibdmc.analysis.plotter
=========================

.. py:module:: pyvibdmc.analysis.plotter


Classes
-------

.. autoapisummary::

   pyvibdmc.analysis.plotter.Plotter


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

.. py:class:: Plotter

   A very basic plotting class that will use matplotlib to generate various plots using results from PyVibDMC/AnalyzeWfn/SimInfo.


   .. py:attribute:: params


   .. py:method:: plt_vref_vs_tau(vref_vs_tau, save_name='vref_vs_tau.png')
      :staticmethod:


      Takes in the vref vs tau array from a DMC sim and plots it. Can also take in many vref_vs_tau arrays and plot them successively

      :param vref_vs_tau: The vref_vs_tau array from the *sim_info.hdf5 file. Can be a list of these as well.
      :type vref_vs_tau: str or list
      :param save_name: The name of the plot that will save as a .png
      :type save_name: str
      :return:



   .. py:method:: plt_pop_vs_tau(pop_vs_tau, save_name='pop_vs_tau.png')
      :staticmethod:


      Takes in the pop_vs_tau array from a DMC sim and plots it. Can also take in many pop_vs_tau arrays and plot them successively

      :param pop_vs_tau: The vref_vs_tau array from the *sim_info.hdf5 file. Can be a list of these as well.
      :type pop_vs_tau: str or list
      :param save_name: The name of the plot that will save as a .png
      :type save_name: str
      :return:



   .. py:method:: plt_hist1d(hist, xlabel, ylabel='Probability Amplitude ($\\mathrm{\\Psi^{2}}$)', title='', save_name='histogram.png')
      :staticmethod:


      Plots the histogram generated from AnalyzeWfn.projection_1d.

      :param hist: Output from AnalyzeWfn.projection_1d ; array of shape (bin_num-1 x 2)
      :type hist: np.ndarray
      :param xlabel: What to label the x-axis
      :type xlabel: str
      :param ylabel: What to label the y-axis (units in Parenthesis is always good)
      :type ylabel: str
      :param title: Title of the plot
      :type title: str
      :param save_name: name of the .png file that this plot will be saved to
      :type save_name: str



   .. py:method:: plt_hist2d(binsx, binsy, hist_2d, xlabel, ylabel, title='', save_name='histogram.png')
      :staticmethod:


      Plots the 2D-histogram generated from AnalyzeWfn.projection_2d.

      :param bins: First output from AnalyzeWfn.projection_2d; the array containing the x and y bins
      :type bins: np.ndarray
      :param hist_2d: Second output from AnalyzeWfn.projection_2d; The matrix that contains the amplitude at each of the bins in the 2d histogram.
      :type hist_2d: np.ndarray
      :param xlabel: What to label the x-axis
      :type xlabel: str
      :param ylabel: What to label the y-axis (units in Parenthesis is always good)
      :type ylabel: str
      :param title: Title of the plot
      :type title: str
      :param save_name: name of the .png file that this plot will be saved to
      :type save_name: str