stage/include/ost/qa/torsion_statistics.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2010 by the OpenStructure authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_QA_TORSION_STATISTICS_HH
#define OST_QA_TORSION_STATISTICS_HH
/*
  Author: Pascal, Benkert, Marco Biasini
*/
#include <ost/mol/entity_handle.hh>
#include <ost/qa/histogram.hh>
#include <ost/qa/amino_acids.hh>
#include <boost/shared_ptr.hpp>

namespace ost { namespace qa {

class TorsionStatistics;
typedef boost::shared_ptr<TorsionStatistics> TorsionStatisticsPtr;

class DLLEXPORT_OST_QA TorsionStatistics {
public:
  TorsionStatistics(int prev_torsion_bucket_size, int central_torsion_bucket_size, 
                    int next_torsion_bucket_size);
  TorsionStatistics();
  void Extract(mol::EntityHandle entity);
  
  void Extract(mol::EntityView view);
  
  static TorsionStatisticsPtr LoadFromFile(const String& file_name);

  void SaveToFile(const String& file_name) const;
  
  uint64_t GetCount(const AminoAcidSet& central_aa,
                  Real prev_phi_angle, Real prev_psi_angle,
                  Real central_phi_angle, Real central_psi_angle,
                  Real next_phi_angle, Real next_psi_angle) const;
                  
  uint64_t GetCount(Real prev_phi_angle, Real prev_psi_angle,
                  Real central_phi_angle, Real central_psi_angle,
                  Real next_phi_angle, Real next_psi_angle) const;

  uint64_t GetCount(const AminoAcidSet& central_aa) const;

  uint64_t GetCount() const;

//  /// \brief  Get frequency of the amino acid aa.
//  /// \return frequency in the range of [0, 1]
//  Real GetFrequency(AminoAcid aa) const;
  

  uint32_t GetTorsionBucketCountPrev() const;
  int GetTorsionBucketSizePrev() const;
  uint32_t GetTorsionBucketCountCentral() const;
  int GetTorsionBucketSizeCentral() const;
  uint32_t GetTorsionBucketCountNext() const;
  int GetTorsionBucketSizeNext() const;


  template <typename DS>
  void Serialize(DS& ds)
  {
    ds & prev_torsion_bucket_size_;
    ds & central_torsion_bucket_size_;
    ds & next_torsion_bucket_size_;
    ds & histogram_;
  }
public:

  typedef MultiClassifier<uint32_t, int, Real, Real,
                          Real, Real, Real, Real> TorsionHistogram;
  typedef TorsionHistogram::IndexType               IndexType;


private:
  uint64_t Accumulate(const IndexType& start, const IndexType& end) const;
  
  uint32_t IndexForAnglePrev(Real angle) const;
  uint32_t IndexForAngleCentral(Real angle) const;
  uint32_t IndexForAngleNext(Real angle) const;

  TorsionHistogram  histogram_;
  int               prev_torsion_bucket_size_;
  int               central_torsion_bucket_size_;
  int               next_torsion_bucket_size_;
};
}}

#endif

---