Add more comments

Author: codingS3b

lib/python/picongpu/plugins/plot_mpl/base_visualizer.py

@@ -24,6 +24,12 @@ class Visualizer(object):
     def __init__(self, run_directory):
         """
         Initialize the reader and data as member parameters.
+
+        Parameters
+        ----------
+        run_directory : string
+            path to the run directory of PIConGPU
+            (the path before ``simOutput/``)
         """
         if run_directory is None:
             raise ValueError('The run_directory parameter can not be None!')
@@ -46,6 +52,10 @@ def _create_plt_obj(self, ax):
         object (or derived classes) which can be updated
         by feeding new data into it.
         Only called on the first call for visualization.
+
+        Parameters
+        ----------
+        ax: matplotlib.axes.Axes instance
         """
         raise NotImplementedError
 
@@ -60,6 +70,13 @@ def _ax_or_gca(self, ax):
         """
         Returns the passed ax if it is not None or the current
         matplotlib axes object otherwise.
+
+        Parameters
+        ----------
+        ax: None or matplotlib.axes.Axes instance
+        Returns
+        -------
+        A matplotlib.axes.Axes instance
         """
 
         return ax or plt.gca()

lib/python/picongpu/plugins/plot_mpl/energy_histogram_visualizer.py

@@ -17,16 +17,33 @@ class Visualizer(BaseVisualizer):
     """
 
     def __init__(self, run_directory):
+        """
+        Parameters
+        ----------
+        run_directory : string
+            path to the run directory of PIConGPU
+            (the path before ``simOutput/``)
+        """
         super(Visualizer, self).__init__(run_directory)
 
     def _create_data_reader(self, run_directory):
+        """
+        Implementation of base class function.
+        """
         return EnergyHistogram(run_directory)
 
     def _create_plt_obj(self, ax):
+        """
+        Implementation of base class function.
+        Turns 'self.plt_obj' into a matplotlib.pyplot.plot object.
+        """
         bins, counts = self.data
         self.plt_obj = ax.semilogy(bins, counts, nonposy='clip')[0]
 
     def _update_plt_obj(self):
+        """
+        Implementation of base class function.
+        """
         bins, counts = self.data
         self.plt_obj.set_data(bins, counts)
 

lib/python/picongpu/plugins/plot_mpl/phase_space_visualizer.py

@@ -34,9 +34,16 @@ def __init__(self, run_directory):
         self.e_mc_r = 1. / (9.1e-31 * 2.9979e8)
 
     def _create_data_reader(self, run_directory):
+        """
+        Implementation of base class function.
+        """
         return PhaseSpace(run_directory)
 
     def _create_plt_obj(self, ax):
+        """
+        Implementation of base class function.
+        Turns 'self.plt_obj' into a matplotlib.image.AxesImage object.
+        """
         dat, meta = self.data
         self.plt_obj = ax.imshow(
             np.abs(dat).T * meta.dV,
@@ -48,6 +55,9 @@ def _create_plt_obj(self, ax):
         )
 
     def _update_plt_obj(self):
+        """
+        Implementation of base class function.
+        """
         dat, meta = self.data
         self.plt_obj.set_data(np.abs(dat).T * meta.dV)
 

lib/python/picongpu/plugins/plot_mpl/png_visualizer.py

@@ -27,12 +27,23 @@ def __init__(self, run_directory):
         super(Visualizer, self).__init__(run_directory)
 
     def _create_data_reader(self, run_directory):
+        """
+        Implementation of base class function.
+        """
+
         return PNG(run_directory)
 
     def _create_plt_obj(self, ax):
+        """
+        Implementation of base class function.
+        Turns 'self.plt_obj' into a matplotlib.image.AxesImage object.
+        """
         self.plt_obj = ax.imshow(self.data)
 
     def _update_plt_obj(self):
+        """
+        Implementation of base class function.
+        """
         self.plt_obj.set_data(self.data)
 
     def visualize(self, ax=None, **kwargs):