← Back to branch summary

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

« back to all changes in this revision

Viewing changes to include/OpenMS/ANALYSIS/QUANTITATION/ProteinInference.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/ANALYSIS/QUANTITATION/ProteinInference.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
 
1
// --------------------------------------------------------------------------
 
2
//                   OpenMS -- Open-Source Mass Spectrometry
 
3
// --------------------------------------------------------------------------
 
4
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
 
5
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
 
6
//
 
7
// This software is released under a three-clause BSD license:
 
8
//  * Redistributions of source code must retain the above copyright
 
9
//    notice, this list of conditions and the following disclaimer.
 
10
//  * Redistributions in binary form must reproduce the above copyright
 
11
//    notice, this list of conditions and the following disclaimer in the
 
12
//    documentation and/or other materials provided with the distribution.
 
13
//  * Neither the name of any author or any participating institution
 
14
//    may be used to endorse or promote products derived from this software
 
15
//    without specific prior written permission.
 
16
// For a full list of authors, refer to the file AUTHORS.
 
17
// --------------------------------------------------------------------------
 
18
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 
19
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 
20
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 
21
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
 
22
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 
23
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
24
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
25
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
26
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 
27
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 
28
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
29
//
23
30
// --------------------------------------------------------------------------
24
31
// $Maintainer: Chris Bielow $
35
42
 
36
43
namespace OpenMS
37
44
{
38
 
        /**
39
 
                @brief [experimental class] given a peptide quantitation, infer corresponding protein quantities
40
 
                
41
 
                Infers protein ratios from peptide ratios (currently using unique peptides only).
42
 
                Use the IDMapper class to add protein and peptide information to a 
43
 
                quantitative ConsensusMap prior to this step.
44
 
 
45
 
        */
46
 
        class OPENMS_DLLAPI ProteinInference
47
 
        {
48
 
 
49
 
                public:
50
 
        
51
 
                        typedef Peak2D::IntensityType IntensityType;
52
 
                        
53
 
                        /// Constructor
54
 
                        ProteinInference();
55
 
                        
56
 
                        /// copy constructor
57
 
            ProteinInference(const ProteinInference& cp);
58
 
        
59
 
            /// assignment operator
60
 
            ProteinInference& operator = (const ProteinInference& rhs);
61
 
        
62
 
                        /**
63
 
                                @brief given a peptide quantitation, infer corresponding protein quantities
64
 
                                
65
 
                                Infers protein ratios from peptide ratios (currently using unique peptides only).
66
 
                                Use the IDMapper class to add protein and peptide information to a 
67
 
                                quantitative ConsensusMap prior to this step.
68
 
                                
69
 
                                @param consensus_map Peptide quantitation with ProteinIdentifications attached, where
70
 
                                                         Protein quantitation will be attached
71
 
                                @param reference_map Index of (iTRAQ) reference channel within the consensus map
72
 
                                                         
73
 
                                @throws Exception::MissingInformation if Protein/PeptideIdentifications are missing
74
 
                        */
75
 
                        void infer(ConsensusMap& consensus_map,
76
 
                                                                 const UInt reference_map);
77
 
                        
78
 
                        
79
 
                protected:
80
 
                        
81
 
                        void infer_(ConsensusMap& consensus_map, 
82
 
                                                                        const size_t protein_idenfication_index, 
83
 
                                                                        const UInt reference_map);
84
 
                        
85
 
                        bool sortByUnique_(std::vector< PeptideHit >& peptide_hits_local, const bool is_higher_score_better );
86
 
                
87
 
        }; // !class
 
45
  /**
 
46
      @brief [experimental class] given a peptide quantitation, infer corresponding protein quantities
 
47
 
 
48
      Infers protein ratios from peptide ratios (currently using unique peptides only).
 
49
      Use the IDMapper class to add protein and peptide information to a
 
50
      quantitative ConsensusMap prior to this step.
 
51
 
 
52
  */
 
53
  class OPENMS_DLLAPI ProteinInference
 
54
  {
 
55
 
 
56
public:
 
57
 
 
58
    typedef Peak2D::IntensityType IntensityType;
 
59
 
 
60
    /// Constructor
 
61
    ProteinInference();
 
62
 
 
63
    /// copy constructor
 
64
    ProteinInference(const ProteinInference & cp);
 
65
 
 
66
    /// assignment operator
 
67
    ProteinInference & operator=(const ProteinInference & rhs);
 
68
 
 
69
    /**
 
70
        @brief given a peptide quantitation, infer corresponding protein quantities
 
71
 
 
72
        Infers protein ratios from peptide ratios (currently using unique peptides only).
 
73
        Use the IDMapper class to add protein and peptide information to a
 
74
        quantitative ConsensusMap prior to this step.
 
75
 
 
76
        @param consensus_map Peptide quantitation with ProteinIdentifications attached, where
 
77
                     Protein quantitation will be attached
 
78
        @param reference_map Index of (iTRAQ) reference channel within the consensus map
 
79
 
 
80
        @throws Exception::MissingInformation if Protein/PeptideIdentifications are missing
 
81
    */
 
82
    void infer(ConsensusMap & consensus_map,
 
83
               const UInt reference_map);
 
84
 
 
85
 
 
86
protected:
 
87
 
 
88
    void infer_(ConsensusMap & consensus_map,
 
89
                const size_t protein_idenfication_index,
 
90
                const UInt reference_map);
 
91
 
 
92
    bool sortByUnique_(std::vector<PeptideHit> & peptide_hits_local, const bool is_higher_score_better);
 
93
 
 
94
  };   // !class
88
95
 
89
96
} // !namespace
90
97