UniDec
Universal Deconvolution of Mass and Ion Mobility Spectra
Public Member Functions | Public Attributes | List of all members
UniDec.unidec_modules.peakstructure.Peaks Class Reference

Public Member Functions

def __init__ (self)
 
def add_peaks
 
def default_params
 
def get_mass_defects
 
def score_peaks
 

Public Attributes

 peaks
 
 plen
 
 changed
 
 masses
 
 convolved
 
 composite
 
 peakcolors
 
 markers
 
 colormap
 
 textmarkers
 
 marklen
 
 massbins
 

Detailed Description

Class containing all useful data about peaks.

The peaks themselves are of the Peak class and contained within the self.peaks list.

Constructor & Destructor Documentation

def UniDec.unidec_modules.peakstructure.Peaks.__init__ (   self)
Initialize Peaks class and set empty values
:return: None

Member Function Documentation

def UniDec.unidec_modules.peakstructure.Peaks.add_peaks (   self,
  parray,
  massbins = 0 
)
Create peak objects from an array
:param parray: N x 2 array containing (mass, height) of each peak.
:param massbins: Describes the precision of the mass inputs by describing the bin size on the mass axis.
:return: None
def UniDec.unidec_modules.peakstructure.Peaks.default_params (   self,
  cmap = "rainbow" 
)
Set default parameters for peaks, such as color, label, and marker
:param cmap: Colormap from matplotlib.cm
:return: None
def UniDec.unidec_modules.peakstructure.Peaks.get_mass_defects (   self,
  kendrickmass,
  mode = 0 
)
Get the mass defects and mass number for each peak
:param kendrickmass: Kendrick reference mass
:param mode: Select range of defects 1=(0,1), 0=(-0.5,0.5)
:return: None
def UniDec.unidec_modules.peakstructure.Peaks.score_peaks (   self,
  thresh = 0,
  ci = 0.99 
)
For each peak, assign a score of the fractional number of charge states observed.
:param thresh: Optional threshold to define a noise floor.
:return: None

Member Data Documentation

UniDec.unidec_modules.peakstructure.Peaks.changed
UniDec.unidec_modules.peakstructure.Peaks.colormap
UniDec.unidec_modules.peakstructure.Peaks.composite
UniDec.unidec_modules.peakstructure.Peaks.convolved
UniDec.unidec_modules.peakstructure.Peaks.markers
UniDec.unidec_modules.peakstructure.Peaks.marklen
UniDec.unidec_modules.peakstructure.Peaks.massbins
UniDec.unidec_modules.peakstructure.Peaks.masses
UniDec.unidec_modules.peakstructure.Peaks.peakcolors
UniDec.unidec_modules.peakstructure.Peaks.peaks
UniDec.unidec_modules.peakstructure.Peaks.plen
UniDec.unidec_modules.peakstructure.Peaks.textmarkers

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