Migration from pyms.Display

pymassspec_plot replaces pyms.Display. The latter will eventually deprecated and removed.

Table 1 Replacements for functions in pyms.Display

Old	New
pyms.Display.plot_ic()	pymassspec_plot.plot_ic()
pyms.Display.plot_mass_spec()	pymassspec_plot.plot_mass_spec()
pyms.Display.plot_peaks()	pymassspec_plot.plot_peaks()
pyms.Display.plot_head2tail()	pymassspec_plot.plot_head2tail()
pyms.Display.ClickEventHandler	pymassspec_plot.ClickEventHandler
pyms.Display.invert_mass_spec()	pymassspec_plot.utils.invert_mass_spec()

pyms.Display also provided a Display class. Its methods were mostly thin wrappers around the functions in this library.

Table 2 Replacements for methods on pyms.Display.Display

Old	New
pyms.Display.Display.plot_ic()	pymassspec_plot.plot_ic()
pyms.Display.Display.plot_tic()	pymassspec_plot.plot_ic()
pyms.Display.Display.plot_mass_spec()	pymassspec_plot.plot_mass_spec()
pyms.Display.Display.plot_peaks()	pymassspec_plot.plot_peaks()
pyms.Display.Display.do_plotting()	No replacement †
pyms.Display.Display.get_5_largest()	No replacement ‡
pyms.Display.Display.onclick()	No replacement §
pyms.Display.Display.save_chart()	Achievable through matplotlib.figure.Figure.savefig()
pyms.Display.Display.show_chart()	matplotlib.figure.Figure.show() or matplotlib.pyplot.show()

†

pyms.Display.Display.do_plotting() did the following:

• Emit a warning if called without any plotting functions (e.g. pyms.Display.Display.plot_ic()) being called.

• Set the plot_label as the axes title. Use matplotlib.axes.Axes.set_title() instead.

• Create a legend for the axes. Use matplotlib.axes.Axes.legend() instead.

• Ensure the figure is drawn on the canvas. Use matplotlib.figure.Figure.canvas.draw() instead.

• Configure a callback for the plot being clicked. Use ClickEventHandler instead.

‡

pyms.Display.Display.get_5_largest() was used internally as part of the left click callback. See pymassspec_plot.ClickEventHandler.get_n_largest() for a similar implementation.

§

pyms.Display.Display.onclick() was configured internally as an event callback. The same result can be obtained using the ClickEventHandler class.