ITRAQLabeler.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-2017.
//
// 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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------

#ifndef OPENMS_SIMULATION_LABELING_ITRAQLABELER_H
#define OPENMS_SIMULATION_LABELING_ITRAQLABELER_H

#include <OpenMS/ANALYSIS/QUANTITATION/ItraqConstants.h>
#include <OpenMS/DATASTRUCTURES/Utils/MatrixUtils.h>
#include <OpenMS/SIMULATION/LABELING/BaseLabeler.h>
#include <OpenMS/SIMULATION/SimTypes.h>

namespace OpenMS
{

  class OPENMS_DLLAPI ITRAQLabeler :
    public BaseLabeler
  {
public:

    typedef ItraqConstants::ChannelInfo ChannelInfo;
    typedef ItraqConstants::ChannelMapType ChannelMapType;
    typedef ItraqConstants::IsotopeMatrices IsotopeMatrices;

    ITRAQLabeler();

    virtual ~ITRAQLabeler();

    static BaseLabeler* create()
    {
      return new ITRAQLabeler();
    }

    static const String getProductName()
    {
      return "itraq";
    }

    // redeclaration of virtual methods
    void preCheck(Param& param) const;

    void setUpHook(SimTypes::FeatureMapSimVector& /* channels */);

    void postDigestHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);

    void postRTHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);

    void postDetectabilityHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);

    void postIonizationHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);

    void postRawMSHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);

    void postRawTandemMSHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */, SimTypes::MSSimExperiment& /* simulated map */);

protected:

    void addModificationToPeptideHit_(Feature& feature, const String& modification, const Size& pos) const;

    void labelPeptide_(const Feature& feature, SimTypes::FeatureMapSim& result) const;

    Feature mergeFeatures_(Feature& labeled_channel_feature, const AASequence& unmodified_sequence, std::map<AASequence, Feature>& unlabeled_features_index) const;

    void updateMembers_();

    // get the closest RT profile factor of a feature for a given RT
    double getRTProfileIntensity_(const Feature& f, const double MS2_RT_time) const;

    EigenMatrixXdPtr getItraqIntensity_(const Feature& f, const double MS2_RT_time) const;


    // Members:

    Int itraq_type_;

    ChannelMapType channel_map_;

    IsotopeMatrices isotope_corrections_;

    double y_labeling_efficiency_;

  };
} // namespace OpenMS

#endif //#ifndef OPENMS_SIMULATION_LABELING_ITRAQLabeler_H