MS2Info.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2012.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Florian Zeller $
// $Authors: Lukas Mueller, Markus Mueller $
// --------------------------------------------------------------------------
//
//
//  written by Lukas N Mueller, 30.3.05
//  Lukas.Mueller@imsb.biol.ethz.ch
//  Group of Prof. Ruedi Aebersold, IMSB, ETH Hoenggerberg, Zurich
//
//  Ported to OpenMS by Florian Zeller, florian.zeller@bsse.ethz.ch
//  December 2010
//

#ifndef OPENMS_TRANSFORMATIONS_FEATUREFINDER_SUPERHIRN_MS2INFO_H
#define OPENMS_TRANSFORMATIONS_FEATUREFINDER_SUPERHIRN_MS2INFO_H

#include <OpenMS/CONCEPT/Types.h>

#include <string>
#include <vector>
#include <map>

namespace OpenMS
{

  class OPENMS_DLLAPI MS2Info
  {

    // declaration of the private members:

private:

    int ID;

    std::string SQ;
    std::string FULL_SQ;
    std::string PREV_AA;
    std::vector<std::string> AC;
//  std::string ORIGINAL_INTERACT_FILE;
    std::string MS2_TYPE_TAG;

    // peptide prophet analysis:
    float PEP_PROB;

    // sorcerer search results:
    double XCORR;
    double DELTA_CN;

    double MONO_MZ;
    double THEO_MZ;
    double NEUTRAL_MR;

    int CHRG;
    int SCAN_START;
    int SCAN_END;

    double TR;

    std::map<int, double> MOD_LIST;

    // static values:
    static const double _MONO_H;
    static const double _MONO_O;

    // declaration of the public members:

public:
    static const double mono_mass[26];
    static const char AA[20];
// static double MS2_TR_TOL;
// static bool THEO_MATCH_MODUS;
// static double MS2_MZ_PPM_TOLERANCE;

    // class destructor
    ~MS2Info();

    // class constructor
    MS2Info();
    MS2Info(int);
    MS2Info(std::string, std::string, float);
    MS2Info(std::string, std::string, int, float);
    MS2Info(std::string, std::string, float, int, int);
    // class copy constructor
    MS2Info(const MS2Info &);
    // class copy constructor
    MS2Info(const MS2Info *);

    // overload operators:
    MS2Info & operator=(const MS2Info &);
    bool operator==(const MS2Info &);
    MS2Info & operator<=(const MS2Info &);
    MS2Info & operator>=(const MS2Info &);
    MS2Info & operator<(const MS2Info &);
    MS2Info & operator>(const MS2Info &);

    // add modification
    void add_modification(int, double);
    std::map<int, double>::iterator get_Modification_list_start()
    {
      return MOD_LIST.begin();
    }

    std::map<int, double>::iterator get_Modification_list_end()
    {
      return MOD_LIST.end();
    }

    std::map<int, double>::iterator find_Modification(int pos)
    {
      return MOD_LIST.find(pos);
    }

    std::map<int, double> * get_Modification_list()
    {
      return &(MOD_LIST);
    }

    bool check_MODIFICATION()
    {
      return !MOD_LIST.empty();
    }

    // calculates the theoretical mass from a sequence:
    void set_THEO_MASS_from_SQ();
    double get_THEO_MZ()
    {
      return THEO_MZ;
    }

    // sets modificatied SQ:
    void set_FULL_SQ();
    void set_SQ(std::string IN)
    {
      SQ = IN;
      set_THEO_MASS_from_SQ();
      set_FULL_SQ();
    }

    // show info:
    void show_info();

    // check whethere proteotypic peptide:
    bool get_PROTEO_TYPE();
    // check the tryptic state:
    // 2: full tryptic
    // 1: semi tryptic
    // 0: non tryptic
    int get_TRYPTIC_STATE();

    // AC functions:
    // check if this AC or not:
    bool compare_AC(std::string);
    // search a pattern in the  AC list:
    bool search_AC_pattern(std::string);

    // start here all the get / set
    // function to access the
    // variables of the class
    std::string get_SQ()
    {
      return SQ;
    }

    std::string get_MOD_SQ()
    {
      return FULL_SQ;
    }

    std::string get_TOTAL_SQ()
    {
      return get_PREV_AA() + "." + get_MOD_SQ();
    }

    std::string get_AC()
    {
      return *(AC.begin());
    }

    std::vector<std::string> get_ALL_AC()
    {
      return AC;
    }

    std::vector<std::string>::iterator get_ALL_AC_START()
    {
      return AC.begin();
    }

    std::vector<std::string>::iterator get_ALL_AC_END()
    {
      return AC.end();
    }

    bool find_AC(std::string);
    void set_AC(std::string);
    float get_PEP_PROB()
    {
      return PEP_PROB;
    }

    void set_PEP_PROB(float IN)
    {
      PEP_PROB = IN;
    }

    double get_MONO_MZ()
    {
      return MONO_MZ;
    }

    void set_MONO_MZ(double);

    double get_NEUTRAL_MR()
    {
      return NEUTRAL_MR;
    }

    void set_NEUTRAL_MR(double);

    int get_CHRG()
    {
      return CHRG;
    }

    void set_CHRG(int IN)
    {
      CHRG = IN;
    }

    int get_SCAN()
    {
      return SCAN_START;
    }

    int get_SCAN_START()
    {
      return SCAN_START;
    }

    void set_SCAN_START(int IN)
    {
      SCAN_START = IN;
    }

    int get_SCAN_END()
    {
      return SCAN_END;
    }

    void set_SCAN_END(int IN)
    {
      SCAN_END = IN;
    }

    int get_ID()
    {
      return ID;
    }

    double get_DELTA_CN()
    {
      return DELTA_CN;
    }

    void set_DELTA_CN(double IN)
    {
      DELTA_CN = IN;
    }

    double get_XCORR()
    {
      return XCORR;
    }

    void set_XCORR(double IN)
    {
      XCORR = IN;
    }

    void set_MS2_TYPE_TAG(std::string IN)
    {
      MS2_TYPE_TAG = IN;
    }

    std::string get_MS2_TYPE_TAG()
    {
      return MS2_TYPE_TAG;
    }

/*
        std::string get_ORIGINAL_INTERACT_FILE()
        {
            return ORIGINAL_INTERACT_FILE;
        }

        void set_ORIGINAL_INTERACT_FILE(std::string IN)
        {
            ORIGINAL_INTERACT_FILE = IN;
        }
*/

    // access the retentino parameter:
    double getRetentionTime()
    {
      return TR;
    }

    void setRetentionTime(double IN)
    {
      TR = IN;
    }

    double get_MONO_AA_MASS(int);

    std::string get_PREV_AA()
    {
      return PREV_AA;
    }

    void set_PREV_AA(std::string IN)
    {
      PREV_AA = IN;
    }

  };

} // ns

#endif // OPENMS_TRANSFORMATIONS_FEATUREFINDER_SUPERHIRN_MS2INFO_H