File: IsotopeEnvelopeEstimator.hpp

package info (click to toggle)
libpwiz 3.0.18342-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 14,888 kB
  • sloc: cpp: 157,552; sh: 4,182; makefile: 317
file content (86 lines) | stat: -rw-r--r-- 2,578 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
//
// $Id$
//
//
// Original author: Darren Kessner <darren@proteowizard.org>
//
// Copyright 2007 Spielberg Family Center for Applied Proteomics
//   Cedars Sinai Medical Center, Los Angeles, California  90048
//
// Licensed under the Apache License, Version 2.0 (the "License"); 
// you may not use this file except in compliance with the License. 
// You may obtain a copy of the License at 
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
// See the License for the specific language governing permissions and 
// limitations under the License.
//


#ifndef _ISOTOPEENVELOPEESTIMATOR_HPP_
#define _ISOTOPEENVELOPEESTIMATOR_HPP_


#include "pwiz/utility/misc/Export.hpp"
#include "Chemistry.hpp"
#include "IsotopeCalculator.hpp"
 

namespace pwiz {
namespace chemistry {


/// Class used for calculating a theoretical isotope envelope for a given mass,
/// based on an estimate of the elemental composition for that mass.  For peptides,
/// the elemental composition estimate is based on the average elemental composition
/// of amino acid residues.  Mass distributions are calculated on construction of the 
/// object and cached for quick access.
class PWIZ_API_DECL IsotopeEnvelopeEstimator
{
    public:

    struct PWIZ_API_DECL Config
    {
        enum Type {Peptide}; 

        Type type;
        unsigned int cacheSize; 
        double cacheMaxMass;
        int normalization;
        const IsotopeCalculator* isotopeCalculator; // must be valid during construction only

        Config()
        :   type(Peptide), 
            cacheSize(10000),
            cacheMaxMass(100000), 
            normalization(IsotopeCalculator::NormalizeMass |      // monoisotopic == 0
                          IsotopeCalculator::NormalizeAbundance), // norm_2 == 1 
            isotopeCalculator(0)
        {}
    };

    IsotopeEnvelopeEstimator(const Config& config);
    ~IsotopeEnvelopeEstimator();

    MassDistribution isotopeEnvelope(double mass) const;

    private:

    class Impl;
    std::auto_ptr<Impl> impl_;

    // no copying
    IsotopeEnvelopeEstimator(const IsotopeEnvelopeEstimator&);
    IsotopeEnvelopeEstimator& operator=(const IsotopeEnvelopeEstimator&);
};


} // namespace chemistry
} // namespace pwiz


#endif // _ISOTOPEENVELOPEESTIMATOR_HPP_