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

Public Member Functions

def __init__ (self)
 
def initialize (self)
 
def default_colormaps (self)
 
def config_export (self, name)
 
def config_import (self, name)
 
def print_config (self)
 
def default_file_names (self)
 
def check_badness (self)
 
def default_high_res (self)
 
def default_isotopic_res (self)
 
def default_zero_charge (self)
 
def initialize_system_paths (self)
 

Public Attributes

 infname
 
 outfname
 
 mfile
 
 manualfile
 
 confname
 
 ofile
 
 matchfile
 
 peaksfile
 
 dirname
 
 filename
 
 extension
 
 imflag
 
 publicationmode
 
 discreteplot
 
 cmap
 
 peakcmap
 
 rawflag
 
 detectoreffva
 
 mzbins
 
 smooth
 
 subbuff
 
 subtype
 
 intthresh
 
 minmz
 
 maxmz
 
 numit
 
 zzsig
 
 startz
 
 endz
 
 numz
 
 mzsig
 
 psfun
 
 massub
 
 masslb
 
 msig
 
 molig
 
 massbins
 
 adductmass
 
 damp
 
 aggressiveflag
 
 suppression
 
 isotopemode
 
 peakwindow
 
 peakthresh
 
 peakplotthresh
 
 separation
 
 peaknorm
 
 error
 
 mtabsig
 
 poolflag
 
 nativezub
 
 nativezlb
 
 inflate
 
 linflag
 
 integratelb
 
 integrateub
 
 mindt
 
 maxdt
 
 smoothdt
 
 subbufdt
 
 ccslb
 
 ccsub
 
 nativeccsub
 
 nativeccslb
 
 dtsig
 
 ccsbins
 
 csig
 
 pusher
 
 zout
 
 temp
 
 pressure
 
 volt
 
 to
 
 driftlength
 
 tcal1
 
 tcal2
 
 edc
 
 gasmass
 
 twaveflag
 
 batchflag
 
 procflag
 
 runtime
 
 massdatnormtop
 
 mfileflag
 
 manualfileflag
 
 kendrickmass
 
 masslist
 
 matchlist
 
 oligomerlist
 
 manuallist
 
 zoffs
 
 massoffset
 
 extractshape
 
 gridparams
 
 griddecon
 
 matchtolerance
 
 cmaps
 
 cmaps2
 
 badtest
 
 warning
 
 system
 
 defaultUnidecDir
 
 defaultUnidecName
 
 defaultIMName
 
 UniDecPath
 
 UniDecName
 
 UniDecIMName
 
 UniDecDir
 
 UniDecIMPath
 
 rawreaderpath
 
 cdcreaderpath
 
 defaultconfig
 

Detailed Description

Class containing all options and configurations for UniDec GUI and Program. Contains methods to export and import
config to text file for running UniDec core binaries and for storing parameters for GUI.

Constructor & Destructor Documentation

def UniDec.unidec_modules.unidecstructure.UniDecConfig.__init__ (   self)
Initialize Everything. Set default paths and run self.initialize
:return: UniDecConfig object

Member Function Documentation

def UniDec.unidec_modules.unidecstructure.UniDecConfig.check_badness (   self)
Test for a few things that will crash the program:
    Min is greater than Max for m/z, charge, mass, native charge, ccs, native ccs, dt
    Bad IM-MS calibration values.
    Peak width is zero
    m/z resolution is really small.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.config_export (   self,
  name 
)
Writes config to file give in name. Typically in format: name value.

Also exports manuallist, masslist, and oligomerlist to text files.
:param name: File name to write to.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.config_import (   self,
  name 
)
Imports configuration from txt file. Also imports masslist, manuallist, and oligomerlist.
:param name: File to import from.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.default_colormaps (   self)
Get default matplotlib colormaps and set names to self.cmaps.
A more list is set as self.cmaps2. For some reason, matplotlib v.1.5.0 allows viridis and other new colormaps
with the colormaps() but not cm.datad. Even weirder, they work for some things and not others. Solution, two
lists, one for the 2D plots and the other for the linear colors.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.default_file_names (   self)
Sets the default file names. For things comming into and out of the program. In theory these can be modified,
 but it might be risky.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.default_high_res (   self)
Sets some defaults for high resolution spectra. Leaves other values unchanged.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.default_isotopic_res (   self)
Sets some defaults for isotopic resolution spectra. Leaves other values unchanged.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.default_zero_charge (   self)
Sets some defaults for when the zero-charge mass spectrum itself is to be deisotoped. Leaves other values
unchanged.
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.initialize (   self)
Initialize configuration parameters but not paths. Runs self.default_colormaps
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.initialize_system_paths (   self)
Initialize initial paths for UniDec directories
:return: None
def UniDec.unidec_modules.unidecstructure.UniDecConfig.print_config (   self)
Simple debugging command to read in the config file and print out its contents.
:return: None

Member Data Documentation

UniDec.unidec_modules.unidecstructure.UniDecConfig.adductmass
UniDec.unidec_modules.unidecstructure.UniDecConfig.aggressiveflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.badtest
UniDec.unidec_modules.unidecstructure.UniDecConfig.batchflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.ccsbins
UniDec.unidec_modules.unidecstructure.UniDecConfig.ccslb
UniDec.unidec_modules.unidecstructure.UniDecConfig.ccsub
UniDec.unidec_modules.unidecstructure.UniDecConfig.cdcreaderpath
UniDec.unidec_modules.unidecstructure.UniDecConfig.cmap
UniDec.unidec_modules.unidecstructure.UniDecConfig.cmaps
UniDec.unidec_modules.unidecstructure.UniDecConfig.cmaps2
UniDec.unidec_modules.unidecstructure.UniDecConfig.confname
UniDec.unidec_modules.unidecstructure.UniDecConfig.csig
UniDec.unidec_modules.unidecstructure.UniDecConfig.damp
UniDec.unidec_modules.unidecstructure.UniDecConfig.defaultconfig
UniDec.unidec_modules.unidecstructure.UniDecConfig.defaultIMName
UniDec.unidec_modules.unidecstructure.UniDecConfig.defaultUnidecDir
UniDec.unidec_modules.unidecstructure.UniDecConfig.defaultUnidecName
UniDec.unidec_modules.unidecstructure.UniDecConfig.detectoreffva
UniDec.unidec_modules.unidecstructure.UniDecConfig.dirname
UniDec.unidec_modules.unidecstructure.UniDecConfig.discreteplot
UniDec.unidec_modules.unidecstructure.UniDecConfig.driftlength
UniDec.unidec_modules.unidecstructure.UniDecConfig.dtsig
UniDec.unidec_modules.unidecstructure.UniDecConfig.edc
UniDec.unidec_modules.unidecstructure.UniDecConfig.endz
UniDec.unidec_modules.unidecstructure.UniDecConfig.error
UniDec.unidec_modules.unidecstructure.UniDecConfig.extension
UniDec.unidec_modules.unidecstructure.UniDecConfig.extractshape
UniDec.unidec_modules.unidecstructure.UniDecConfig.filename
UniDec.unidec_modules.unidecstructure.UniDecConfig.gasmass
UniDec.unidec_modules.unidecstructure.UniDecConfig.griddecon
UniDec.unidec_modules.unidecstructure.UniDecConfig.gridparams
UniDec.unidec_modules.unidecstructure.UniDecConfig.imflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.inflate
UniDec.unidec_modules.unidecstructure.UniDecConfig.infname
UniDec.unidec_modules.unidecstructure.UniDecConfig.integratelb
UniDec.unidec_modules.unidecstructure.UniDecConfig.integrateub
UniDec.unidec_modules.unidecstructure.UniDecConfig.intthresh
UniDec.unidec_modules.unidecstructure.UniDecConfig.isotopemode
UniDec.unidec_modules.unidecstructure.UniDecConfig.kendrickmass
UniDec.unidec_modules.unidecstructure.UniDecConfig.linflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.manualfile
UniDec.unidec_modules.unidecstructure.UniDecConfig.manualfileflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.manuallist
UniDec.unidec_modules.unidecstructure.UniDecConfig.massbins
UniDec.unidec_modules.unidecstructure.UniDecConfig.massdatnormtop
UniDec.unidec_modules.unidecstructure.UniDecConfig.masslb
UniDec.unidec_modules.unidecstructure.UniDecConfig.masslist
UniDec.unidec_modules.unidecstructure.UniDecConfig.massoffset
UniDec.unidec_modules.unidecstructure.UniDecConfig.massub
UniDec.unidec_modules.unidecstructure.UniDecConfig.matchfile
UniDec.unidec_modules.unidecstructure.UniDecConfig.matchlist
UniDec.unidec_modules.unidecstructure.UniDecConfig.matchtolerance
UniDec.unidec_modules.unidecstructure.UniDecConfig.maxdt
UniDec.unidec_modules.unidecstructure.UniDecConfig.maxmz
UniDec.unidec_modules.unidecstructure.UniDecConfig.mfile
UniDec.unidec_modules.unidecstructure.UniDecConfig.mfileflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.mindt
UniDec.unidec_modules.unidecstructure.UniDecConfig.minmz
UniDec.unidec_modules.unidecstructure.UniDecConfig.molig
UniDec.unidec_modules.unidecstructure.UniDecConfig.msig
UniDec.unidec_modules.unidecstructure.UniDecConfig.mtabsig
UniDec.unidec_modules.unidecstructure.UniDecConfig.mzbins
UniDec.unidec_modules.unidecstructure.UniDecConfig.mzsig
UniDec.unidec_modules.unidecstructure.UniDecConfig.nativeccslb
UniDec.unidec_modules.unidecstructure.UniDecConfig.nativeccsub
UniDec.unidec_modules.unidecstructure.UniDecConfig.nativezlb
UniDec.unidec_modules.unidecstructure.UniDecConfig.nativezub
UniDec.unidec_modules.unidecstructure.UniDecConfig.numit
UniDec.unidec_modules.unidecstructure.UniDecConfig.numz
UniDec.unidec_modules.unidecstructure.UniDecConfig.ofile
UniDec.unidec_modules.unidecstructure.UniDecConfig.oligomerlist
UniDec.unidec_modules.unidecstructure.UniDecConfig.outfname
UniDec.unidec_modules.unidecstructure.UniDecConfig.peakcmap
UniDec.unidec_modules.unidecstructure.UniDecConfig.peaknorm
UniDec.unidec_modules.unidecstructure.UniDecConfig.peakplotthresh
UniDec.unidec_modules.unidecstructure.UniDecConfig.peaksfile
UniDec.unidec_modules.unidecstructure.UniDecConfig.peakthresh
UniDec.unidec_modules.unidecstructure.UniDecConfig.peakwindow
UniDec.unidec_modules.unidecstructure.UniDecConfig.poolflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.pressure
UniDec.unidec_modules.unidecstructure.UniDecConfig.procflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.psfun
UniDec.unidec_modules.unidecstructure.UniDecConfig.publicationmode
UniDec.unidec_modules.unidecstructure.UniDecConfig.pusher
UniDec.unidec_modules.unidecstructure.UniDecConfig.rawflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.rawreaderpath
UniDec.unidec_modules.unidecstructure.UniDecConfig.runtime
UniDec.unidec_modules.unidecstructure.UniDecConfig.separation
UniDec.unidec_modules.unidecstructure.UniDecConfig.smooth
UniDec.unidec_modules.unidecstructure.UniDecConfig.smoothdt
UniDec.unidec_modules.unidecstructure.UniDecConfig.startz
UniDec.unidec_modules.unidecstructure.UniDecConfig.subbufdt
UniDec.unidec_modules.unidecstructure.UniDecConfig.subbuff
UniDec.unidec_modules.unidecstructure.UniDecConfig.subtype
UniDec.unidec_modules.unidecstructure.UniDecConfig.suppression
UniDec.unidec_modules.unidecstructure.UniDecConfig.system
UniDec.unidec_modules.unidecstructure.UniDecConfig.tcal1
UniDec.unidec_modules.unidecstructure.UniDecConfig.tcal2
UniDec.unidec_modules.unidecstructure.UniDecConfig.temp
UniDec.unidec_modules.unidecstructure.UniDecConfig.to
UniDec.unidec_modules.unidecstructure.UniDecConfig.twaveflag
UniDec.unidec_modules.unidecstructure.UniDecConfig.UniDecDir
UniDec.unidec_modules.unidecstructure.UniDecConfig.UniDecIMName
UniDec.unidec_modules.unidecstructure.UniDecConfig.UniDecIMPath
UniDec.unidec_modules.unidecstructure.UniDecConfig.UniDecName
UniDec.unidec_modules.unidecstructure.UniDecConfig.UniDecPath
UniDec.unidec_modules.unidecstructure.UniDecConfig.volt
UniDec.unidec_modules.unidecstructure.UniDecConfig.warning
UniDec.unidec_modules.unidecstructure.UniDecConfig.zoffs
UniDec.unidec_modules.unidecstructure.UniDecConfig.zout
UniDec.unidec_modules.unidecstructure.UniDecConfig.zzsig

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