Add options to change label names on plot

Author: Andrew Yang

diffpy/pdfmorph/morphs/morph.py

@@ -163,14 +163,14 @@ def checkConfig(self):
     def plotInputs(self, xylabels=True):
         '''Plot input arrays using matplotlib.pyplot
 
-        xylabels -- flag for updating x and y axis labels
+        xylabels -- flag for updating x and y axes labels
 
         Return a list of matplotlib line objects.
         '''
         from matplotlib.pyplot import plot, xlabel, ylabel
 
-        rv = plot(self.x_target_in, self.y_target_in, label="***TARGET***")
-        rv = plot(self.x_morph_in, self.y_morph_in, label="***MORPH***")
+        rv = plot(self.x_target_in, self.y_target_in, label="target")
+        rv = plot(self.x_morph_in, self.y_morph_in, label="morph")
         if xylabels:
             xlabel(self.xinlabel)
             ylabel(self.yinlabel)
@@ -179,7 +179,7 @@ def plotInputs(self, xylabels=True):
     def plotOutputs(self, xylabels=True, **plotargs):
         '''Plot output arrays using matplotlib.pyplot
 
-        xylabels -- flag for updating x and y axis labels
+        xylabels -- flag for updating x and y axes labels
         plotargs -- arguments passed to the pylab plot function. Note that
                     "label" will be ignored.
 
@@ -189,8 +189,8 @@ def plotOutputs(self, xylabels=True, **plotargs):
 
         pargs = dict(plotargs)
         pargs.pop("label", None)
-        rv = plot(self.x_target_out, self.y_target_out, label="***TARGET***", **pargs)
-        rv = plot(self.x_morph_out, self.y_morph_out, label="***MORPH***", **pargs)
+        rv = plot(self.x_target_out, self.y_target_out, label="target", **pargs)
+        rv = plot(self.x_morph_out, self.y_morph_out, label="morph", **pargs)
         if xylabels:
             xlabel(self.xoutlabel)
             ylabel(self.youtlabel)

diffpy/pdfmorph/pdfmorph_api.py

@@ -268,8 +268,8 @@ def plot_morph(chain, ax=None, **kwargs):
         fig, ax = plt.subplots()
     rfit, grfit = chain.xy_morph_out
     rdat, grdat = chain.xy_target_out
-    l_list = ax.plot(rfit, grfit, label='***MORPH***', **kwargs)
-    l_list += ax.plot(rdat, grdat, label='***TARGET***', **kwargs)
+    l_list = ax.plot(rfit, grfit, label='morph', **kwargs)
+    l_list += ax.plot(rdat, grdat, label='target', **kwargs)
     ax.set_xlim([chain.config['rmin'], chain.config['rmax']])
     ax.legend()
     ax.set_xlabel(r'r ($\mathrm{\AA}$)')

diffpy/pdfmorph/pdfmorphapp.py

@@ -178,6 +178,24 @@ def custom_error(self, msg):
         dest="plot",
         help="Do not show the plot.",
     )
+    group.add_option(
+        '--usefilenames',
+        action="store_true",
+        dest="usefilenames",
+        help="Use the file names as labels on plot."
+    )
+    group.add_option(
+        '--mlabel',
+        metavar="MLABEL",
+        dest="mlabel",
+        help="Set label for morphed data to MLABEL on plot. Ignored if using file names as labels.",
+    )
+    group.add_option(
+        '--tlabel',
+        metavar="TLABEL",
+        dest="tlabel",
+        help="Set label for target data to TLABEL on plot. Ignored if using file names as labels.",
+    )
     group.add_option(
         '--pmin', type="float", help="Minimum r-value to plot. Defaults to RMIN."
     )
@@ -375,7 +393,14 @@ def main():
 
     if opts.plot:
         pairlist = [chain.xy_morph_out, chain.xy_target_out]
-        labels = ["***MORPH***", "***TARGET***"]
+        labels = ["morph", "target"]  # Default label names
+        if opts.usefilenames:
+            labels = [pargs[0], pargs[1]]
+        else:
+            if opts.mlabel is not None:
+                labels[0] = opts.mlabel
+            if opts.tlabel is not None:
+                labels[1] = opts.tlabel
         # Plot extent defaults to calculation extent
         pmin = opts.pmin if opts.pmin is not None else opts.rmin
         pmax = opts.pmax if opts.pmax is not None else opts.rmax