← Back to branch summary

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

« back to all changes in this revision

Viewing changes to include/OpenMS/FORMAT/MascotOutfile.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/FORMAT/MascotOutfile.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: Nico Pfeifer $
 
25
// $Authors: $
 
26
// --------------------------------------------------------------------------
 
27
 
 
28
#ifndef OPENMS_FORMAT_MASCOTOUTFILE_H
 
29
#define OPENMS_FORMAT_MASCOTOUTFILE_H
 
30
 
 
31
#include <OpenMS/CONCEPT/Types.h>
 
32
#include <OpenMS/METADATA/PeptideIdentification.h>
 
33
 
 
34
#include <vector>
 
35
 
 
36
namespace OpenMS
 
37
{
 
38
        class ProteinIdentification;
 
39
 
 
40
  /**
 
41
    @brief Representation of a Mascot output file
 
42
    
 
43
                !WARNING!
 
44
 
 
45
                This class is only provided for convenience. The MascotAdapter reads the 
 
46
                output from Mascot via MascotXML and pepXML. E.g. This class does not 
 
47
                provide support for modifications. MascotXML and pepXML can be exported
 
48
                from Mascot using export*.pl scripts.
 
49
                
 
50
    This class serves to read in a Mascot outfile. The information can be 
 
51
    retrieved via the load function.
 
52
        
 
53
        @ingroup FileIO
 
54
  */
 
55
  class OPENMS_DLLAPI MascotOutfile
 
56
  {
 
57
    public:
 
58
      
 
59
      /// Constructor
 
60
      MascotOutfile();
 
61
 
 
62
                  /**
 
63
                    @brief loads data from a Mascot outfile
 
64
                    
 
65
                    @param filename the file to be loaded
 
66
                    @param protein_identification the protein identification
 
67
                    @param peptide_identifications the peptide identifications
 
68
                                @param p the significance level (for the protein hit scores)
 
69
                                @throw ParseError is thrown if the file could not be parsed
 
70
 
 
71
                    This class serves to read in a Mascot outfile. The information can be 
 
72
                    retrieved via the load function. This class is only contained to be compatible with previous versions.
 
73
                    You should use the MascotXMLFile instead. 
 
74
                  */
 
75
                        void load(String filename, ProteinIdentification& protein_identification, std::vector<PeptideIdentification>& peptide_identifications, Real p = 0.05);
 
76
 
 
77
    protected:
 
78
 
 
79
   };
 
80
 
 
81
} //namespace OpenMS
 
82
 
 
83
#endif // OPENMS_FORMAT_MASCOTOUTFILE_H