UniDec
Universal Deconvolution of Mass and Ion Mobility Spectra
Public Member Functions | Public Attributes | List of all members
UniDec.unidec_modules.PlottingWindow.PlottingWindow Class Reference
Inheritance diagram for UniDec.unidec_modules.PlottingWindow.PlottingWindow:
Inheritance graph
[legend]
Collaboration diagram for UniDec.unidec_modules.PlottingWindow.PlottingWindow:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, args, kwargs)
 
def on_release (self, event)
 
def on_save_fig_dialog (self, evt)
 
def on_save_fig (self, evt, path, kwargs)
 
def save_figure (self, path, kwargs)
 
def kda_test (self, xvals)
 
def plotadddot (self, x, y, colval, markval)
 
def repaint (self)
 
def clear_plot (self, args)
 
def set_nticks (self, bins)
 
def add_legend
 
def set_color
 
def set_tickcolor (self)
 
def size_handler (self, args, kwargs)
 
def setup_zoom
 

Public Attributes

 figure
 
 int
 
 smash
 
 subplot1
 
 zoom
 
 canvas
 
 resize
 
 flag
 
 kda
 
 kdnorm
 
 normalticks
 
 nativez
 
 text
 
 lines
 
 cbar
 
 datalims
 
 cmap
 
 xlabel
 
 ylabel
 
 zoomtype
 
 tickcolor
 

Detailed Description

Class for wx window with embedded matplotlib plots

Constructor & Destructor Documentation

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.__init__ (   self,
  args,
  kwargs 
)
Initialize plot window parameters.

Optional keywords:
figsize: size of figure in inches
integrate: 0 or 1 of whether the plot should send the integrate pubsub when a right click is activated.
smash: 0 or 1 of whether the plot should send the integrate pubsub when a right click is activated.

:param args: Arguments
:param kwargs: Keywords
:return:

Member Function Documentation

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.add_legend (   self,
  location = 1 
)
Adds a legend to the plot.
:param location: Integer code for location
:return: None

Here is the call graph for this function:

Here is the caller graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.clear_plot (   self,
  args 
)
Clear the plot and rest some of the parameters.
:param args: Arguments
:return:

Here is the call graph for this function:

Here is the caller graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.kda_test (   self,
  xvals 
)
Test whether the axis should be normalized to convert mass units from Da to kDa.
Will use kDa if: xvals[int(len(xvals) / 2)] > 100000 or xvals[len(xvals) - 1] > 1000000

If kDa is used, self.kda=True and self.kdnorm=1000. Otherwise, self.kda=False and self.kdnorm=1.
:param xvals: mass axis
:return: None
def UniDec.unidec_modules.PlottingWindow.PlottingWindow.on_release (   self,
  event 
)
Function triggered on button release event from plot.
Currently wired to trigger on_save_figure_dialog on middle button.
:param event: wx.Event
:return: None

Here is the call graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.on_save_fig (   self,
  evt,
  path,
  kwargs 
)
Save figure to path.
:param evt: wx.Event (unused)
:param path: Path to save figure to
:param kwargs: keywords passed to save_figure
:return: None

Here is the call graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.on_save_fig_dialog (   self,
  evt 
)
Open a save figure dialog for specified plot.
:param evt: wx.Event (unused)
:return: None

Here is the call graph for this function:

Here is the caller graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.plotadddot (   self,
  x,
  y,
  colval,
  markval 
)
Adds a scatter plot to the figure. May be one or more.
:param x: x values
:param y: y values
:param colval: Color
:param markval: Marker
:return: None
def UniDec.unidec_modules.PlottingWindow.PlottingWindow.repaint (   self)
Redraw and refresh the plot.
:return: None

Here is the caller graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.save_figure (   self,
  path,
  kwargs 
)
Saves Figure to path.
:param path: Path to save figure at.
:param kwargs: Keywords passed to matplotlib.figure.savefig
:return: None

Here is the caller graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.set_color (   self,
  rgbtuple = None 
)
Sets background color
:param rgbtuple: background color
:return:
def UniDec.unidec_modules.PlottingWindow.PlottingWindow.set_nticks (   self,
  bins 
)
Set the number of ticks in the x-axis.
:param bins: Number of ticks in the x-axis
:return: None

Here is the call graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.set_tickcolor (   self)
Sets tick colors based on the colormap set at self.cmap
:return: None
def UniDec.unidec_modules.PlottingWindow.PlottingWindow.setup_zoom (   self,
  plots,
  zoom,
  data_lims = None 
)
Set up zoom on axes.
:param plots: Axes objects to setup
:param zoom: Type of zoom ('span' or 'box')
:param data_lims: Optional manual description of the data limits (where to go when fully zoomed out)
:return: None

Here is the caller graph for this function:

def UniDec.unidec_modules.PlottingWindow.PlottingWindow.size_handler (   self,
  args,
  kwargs 
)
Resizes the plots
:param args:
:param kwargs:
:return: None

Member Data Documentation

UniDec.unidec_modules.PlottingWindow.PlottingWindow.canvas
UniDec.unidec_modules.PlottingWindow.PlottingWindow.cbar
UniDec.unidec_modules.PlottingWindow.PlottingWindow.cmap
UniDec.unidec_modules.PlottingWindow.PlottingWindow.datalims
UniDec.unidec_modules.PlottingWindow.PlottingWindow.figure
UniDec.unidec_modules.PlottingWindow.PlottingWindow.flag
UniDec.unidec_modules.PlottingWindow.PlottingWindow.int
UniDec.unidec_modules.PlottingWindow.PlottingWindow.kda
UniDec.unidec_modules.PlottingWindow.PlottingWindow.kdnorm
UniDec.unidec_modules.PlottingWindow.PlottingWindow.lines
UniDec.unidec_modules.PlottingWindow.PlottingWindow.nativez
UniDec.unidec_modules.PlottingWindow.PlottingWindow.normalticks
UniDec.unidec_modules.PlottingWindow.PlottingWindow.resize
UniDec.unidec_modules.PlottingWindow.PlottingWindow.smash
UniDec.unidec_modules.PlottingWindow.PlottingWindow.subplot1
UniDec.unidec_modules.PlottingWindow.PlottingWindow.text
UniDec.unidec_modules.PlottingWindow.PlottingWindow.tickcolor
UniDec.unidec_modules.PlottingWindow.PlottingWindow.xlabel
UniDec.unidec_modules.PlottingWindow.PlottingWindow.ylabel
UniDec.unidec_modules.PlottingWindow.PlottingWindow.zoom
UniDec.unidec_modules.PlottingWindow.PlottingWindow.zoomtype

The documentation for this class was generated from the following file: