IsotopeLabelingMDVs.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-2022.
//
// 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: Ahmed Khalil $
// $Authors: Ahmed Khalil $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
#include <OpenMS/DATASTRUCTURES/Matrix.h>
#include <OpenMS/KERNEL/FeatureMap.h>
#include <OpenMS/KERNEL/Feature.h>

namespace OpenMS
{
  class OPENMS_DLLAPI IsotopeLabelingMDVs :
    public DefaultParamHandler
  {
  public:
    IsotopeLabelingMDVs();

    ~IsotopeLabelingMDVs() override;
    
    enum class DerivatizationAgent
    {
      NOT_SELECTED,
      TBDMS,
      SIZE_OF_DERIVATIZATIONAGENT
    };
    
    enum class MassIntensityType
    {
      NORM_MAX,
      NORM_SUM,
      SIZE_OF_MASSINTENSITYTYPE
    };
    
    static const std::string NamesOfDerivatizationAgent[static_cast<int>(DerivatizationAgent::SIZE_OF_DERIVATIZATIONAGENT)];
    
    static const std::string NamesOfMassIntensityType[static_cast<int>(MassIntensityType::SIZE_OF_MASSINTENSITYTYPE)];
 
    void isotopicCorrection(
      const Feature& normalized_feature, Feature& corrected_feature,
      const Matrix<double>& correction_matrix, const DerivatizationAgent& correction_matrix_agent);
    
    void isotopicCorrections(
      const FeatureMap& normalized_featureMap, FeatureMap& corrected_featureMap,
      const Matrix<double>& correction_matrix, const DerivatizationAgent& correction_matrix_agent);

    void calculateIsotopicPurity(
      Feature& normalized_feature,
      const std::vector<double>& experiment_data, const std::string& isotopic_purity_name);
    
    void calculateIsotopicPurities(
      FeatureMap& normalized_featureMap,
      const std::vector<std::vector<double>>& experiment_data, const std::vector<std::string>& isotopic_purity_name);

    void calculateMDVAccuracy(
      Feature& normalized_feature,
      const std::string& feature_name, const std::string& fragment_isotopomer_theoretical_formula);
    
    void calculateMDVAccuracies(
      FeatureMap& normalized_featureMap,
      const std::string& feature_name,
      const std::map<std::string, std::string>& fragment_isotopomer_theoretical_formulas);
 
    void calculateMDV(
      const Feature& measured_feature, Feature& normalized_feature,
      const MassIntensityType& mass_intensity_type, const std::string& feature_name);
    
    void calculateMDVs(
      const FeatureMap& measured_featureMap, FeatureMap& normalized_featureMap,
      const MassIntensityType& mass_intensity_type, const std::string& feature_name);
    
  protected:
    void updateMembers_() override;
  };
}