← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/SIMULATION/DigestSimulation.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2012-11-12 15:58:12 UTC
  • Revision ID: package-import@ubuntu.com-20121112155812-vr15wtg9b50cuesg
Tags: upstream-1.9.0
Import upstream version 1.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/SIMULATION/DigestSimulation.h
 
1
// -*- mode: C++; tab-width: 2; -*-
 
2
// vi: set ts=2:
 
3
//
 
4
// --------------------------------------------------------------------------
 
5
//                   OpenMS Mass Spectrometry Framework
 
6
// --------------------------------------------------------------------------
 
7
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
 
8
//
 
9
//  This library is free software; you can redistribute it and/or
 
10
//  modify it under the terms of the GNU Lesser General Public
 
11
//  License as published by the Free Software Foundation; either
 
12
//  version 2.1 of the License, or (at your option) any later version.
 
13
//
 
14
//  This library is distributed in the hope that it will be useful,
 
15
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
17
//  Lesser General Public License for more details.
 
18
//
 
19
//  You should have received a copy of the GNU Lesser General Public
 
20
//  License along with this library; if not, write to the Free Software
 
21
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
22
//
 
23
// --------------------------------------------------------------------------
 
24
// $Maintainer: Chris Bielow$
 
25
// $Authors: Stephan Aiche, Chris Bielow$
 
26
// --------------------------------------------------------------------------
 
27
 
 
28
#ifndef OPENMS_SIMULATION_DIGESTSIMULATION_H
 
29
#define OPENMS_SIMULATION_DIGESTSIMULATION_H
 
30
 
 
31
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
 
32
#include <OpenMS/SIMULATION/SimTypes.h>
 
33
 
 
34
namespace OpenMS
 
35
{
 
36
 
 
37
  /**
 
38
                @brief Simulates protein digestion
 
39
 
 
40
                Supports all enzymes supported by EnzymaticDigestion.h
 
41
                and additionally incorporates abundance values, which
 
42
                are distributed evenly among digestion products of each
 
43
                protein.
 
44
 
 
45
                @htmlinclude OpenMS_DigestSimulation.parameters
 
46
 
 
47
                @ingroup Simulation
 
48
  */
 
49
  class OPENMS_DLLAPI DigestSimulation
 
50
    : public DefaultParamHandler
 
51
  {
 
52
 
 
53
  public:
 
54
    /** @name Constructors and Destructors
 
55
      */
 
56
    //@{
 
57
    /// Default constructor
 
58
    DigestSimulation();
 
59
 
 
60
    /// Copy constructor
 
61
    DigestSimulation(const DigestSimulation& source);
 
62
 
 
63
    /// Destructor
 
64
    virtual ~DigestSimulation();
 
65
    //@}
 
66
 
 
67
                /// Assignment operator
 
68
                DigestSimulation& operator = (const DigestSimulation& source);
 
69
 
 
70
 
 
71
                /**
 
72
                        @brief Digest a set of proteins into peptides
 
73
 
 
74
                        Digest proteins to peptides, with protein abundance distributes equally among
 
75
                        created sibling peptides (this also applies for peptides with missed cleavages).
 
76
                        Should a peptide be non-unique the abundances of its instances from proteins are summed up.
 
77
                        
 
78
                        @param feature_map Input FeatureMap containing the proteins that should be digested as ProteinIdentification
 
79
                **/
 
80
    void digest(FeatureMapSim & feature_map);    
 
81
    
 
82
  private:
 
83
    /// set defaults
 
84
    void setDefaultParams_();
 
85
 
 
86
  };
 
87
 
 
88
}
 
89
 
 
90
#endif