predict_coiled_coil.cpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:11k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: predict_coiled_coil.cpp,v $
  4.  * PRODUCTION Revision 1000.5  2004/06/01 20:55:30  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.15
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: predict_coiled_coil.cpp,v 1000.5 2004/06/01 20:55:30 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Authors:  Josh Cherry
  35.  *
  36.  * File Description:  gbench plugin for predicting coiled coil regions
  37.  *
  38.  */
  39. #include <ncbi_pch.hpp>
  40. #include "predict_coiled_coil.hpp"
  41. #include <algo/sequence/coiled_coil.hpp>
  42. #include <gui/core/plugin_utils.hpp>
  43. #include <gui/core/version.hpp>
  44. #include <gui/dialogs/col/multi_col_dlg.hpp>
  45. #include <gui/plugin/PluginCommandSet.hpp>
  46. #include <gui/plugin/PluginInfo.hpp>
  47. #include <gui/plugin/PluginReply.hpp>
  48. #include <gui/plugin/PluginRequest.hpp>
  49. #include <gui/plugin/PluginValueConstraint.hpp>
  50. #include <gui/objutils/utils.hpp>
  51. #include <objmgr/seq_vector.hpp>
  52. #include <objmgr/util/sequence.hpp>
  53. BEGIN_NCBI_SCOPE
  54. USING_SCOPE(objects);
  55. CAlgoPlugin_PredictCoiledCoil::~CAlgoPlugin_PredictCoiledCoil()
  56. {
  57. }
  58. // standard plugin announce bopilerplate
  59. void CAlgoPlugin_PredictCoiledCoil::GetInfo(CPluginInfo& info)
  60. {
  61.     info.Reset();
  62.     
  63.     // version info macro
  64.     info.SetInfo(CPluginVersion::eMajor, CPluginVersion::eMinor, 0,
  65.                  string(__DATE__) + " " + string(__TIME__),
  66.                  "CAlgoPlugin_PredictCoiledCoil", "Protein analysis/Predict coiled coil regions",
  67.                  "Predict coiled coil regions from protein sequence",
  68.                  "");
  69.     // command info
  70.     CPluginCommandSet& cmds = info.SetCommands();
  71.     CPluginCommand&    args = cmds.AddAlgoCommand(eAlgoCommand_run);
  72.     args.AddArgument("locs", "Locations to evaluate",
  73.                      CSeq_loc::GetTypeInfo(),
  74.                      CPluginArg::TData::e_Array);
  75.     args.SetConstraint("locs",
  76.                        (*CPluginValueConstraint::CreateSeqMol(),
  77.                         CSeq_inst::eMol_aa));
  78.     args.AddDefaultArgument("win_len", "Window length",
  79.                             CPluginArg::eInteger, "28");
  80. }
  81. void CAlgoPlugin_PredictCoiledCoil::RunCommand(CPluginMessage& msg)
  82. {
  83.     const CPluginCommand& args = msg.GetRequest().GetCommand();
  84.     CPluginReply& reply = msg.SetReply();
  85.     _TRACE("CAlgoPlugin_PredictCoiledCoil::RunCommand()");
  86.     
  87.     if ( !m_Dialog.get() ) {
  88.         m_Dialog.reset(new CMultiColDlg());
  89.         m_Dialog->SetWindowSize(800, 450);
  90.         m_Dialog->SetTitle("Predicted Coiled Coil Regions");
  91.         
  92.         m_Dialog->SetColumn(0, "Sequence", FL_ALIGN_LEFT, 0.5f);
  93.         m_Dialog->SetColumn(1, "Location", FL_ALIGN_LEFT, 0.5f);
  94.         m_Dialog->SetColumn(2, "Range", FL_ALIGN_CENTER, 0.4f);
  95.         m_Dialog->SetColumn(3, "Maximum Score", FL_ALIGN_CENTER, 0.5f);
  96.         m_Dialog->SetColumn(4, "Coiled Coil Prob.", FL_ALIGN_CENTER, 0.5f);
  97.     }
  98.     // clear any previous contents
  99.     m_Dialog->SetRows(0);
  100.     int row = 0;
  101.     plugin_args::TLocList locs;
  102.     GetArgValue(args["locs"], locs);
  103.     int win_len = args["win_len"].AsInteger();
  104.     ITERATE (plugin_args::TLocList, iter, locs) {
  105.         const CSeq_loc&  loc = *iter->second;
  106.         const IDocument& doc = *iter->first;
  107.         // find the best ID for this bioseq
  108.         try {
  109.             CBioseq_Handle handle = doc.GetScope().GetBioseqHandle(loc);
  110.             // get sequence vector
  111.             CSeqVector vec =
  112.                 handle.GetSequenceView(loc,
  113.                                        CBioseq_Handle::eViewConstructed,
  114.                                        CBioseq_Handle::eCoding_Iupac);
  115.             string& id_str  = m_Dialog->SetCell(row, 0);
  116.             string& loc_str = m_Dialog->SetCell(row, 1);
  117.             const CSeq_id& best_id =
  118.                 sequence::GetId(handle, sequence::eGetId_Best);
  119.             id_str.erase();
  120.             best_id.GetLabel(&id_str);
  121.             loc_str = CPluginUtils::GetLabel(loc, &doc.GetScope());
  122.             // a new feature table
  123.             CRef<CSeq_annot> annot(new CSeq_annot());
  124.             // places to store coiled coil regions and their max scores
  125.             vector<CRef<CSeq_loc> > regions;
  126.             vector<double> max_scores;
  127.             // find the regions
  128.             double top_score = CCoiledCoil::
  129.                 PredictRegions(vec, regions, max_scores, win_len);
  130.             _TRACE("Predicted " << regions.size() << " coiled coil regions");
  131.             // add description to annot
  132.             annot->AddName("Predicted coiled coil regions");
  133.             string comment = string("Predicted coiled coil regions "
  134.                                     "using window length = ")
  135.                 + NStr::IntToString(win_len);
  136.             annot->AddComment(comment);
  137.             NON_CONST_ITERATE (vector< CRef<CSeq_loc> >, region, regions) {
  138.                 // must set the ID field
  139.                 (**region).SetId(sequence::GetId(loc));
  140.                 *region = CSeqUtils::RemapChildToParent(loc, **region);
  141.                 //
  142.                 // add regions to dialog
  143.                 //
  144.                 m_Dialog->SetCell(row, 2)
  145.                     = NStr::IntToString((**region).GetTotalRange().GetFrom() + 1) + "-"
  146.                     + NStr::IntToString((**region).GetTotalRange().GetTo() + 1);
  147.                 m_Dialog->SetCell(row, 3) = 
  148.                     NStr::DoubleToString(max_scores[region - regions.begin()],
  149.                                          2);
  150.                 m_Dialog->SetCell(row, 4) = 
  151.                     NStr::DoubleToString(CCoiledCoil::ScoreToProb
  152.                                          (max_scores[region - regions.begin()]));
  153.                 ++row;
  154.                 
  155.                 //
  156.                 // add features to annot
  157.                 //
  158.                 CRef<CSeq_id> this_id
  159.                     (const_cast<CSeq_id*>(&sequence::GetId(loc)));
  160.                 // create feature
  161.                 CRef<CSeq_feat> feat(new CSeq_feat());
  162.                 feat->SetExp_ev(CSeq_feat::eExp_ev_not_experimental);
  163.                 // set up the location
  164.                 feat->SetLocation(**region);
  165.                 feat->SetLocation().SetId(*this_id);
  166.                 
  167.                 feat->SetData().SetRegion() = 
  168.                     string("Predicted coiled coil: max. score = ") +
  169.                     NStr::DoubleToString(max_scores[region - regions.begin()], 
  170.                                          2)
  171.                     + " (probability = " +
  172.                     NStr::DoubleToString(CCoiledCoil::ScoreToProb
  173.                                          (max_scores[region - regions.begin()]),
  174.                                          2)
  175.                     + ")";
  176.                 
  177.                 // save in annot
  178.                 annot->SetData().SetFtable().push_back(feat);
  179.             }
  180.             // attach annot to doc
  181.             //const_cast<IDocument&>(doc).AttachAnnot(*annot);
  182.             reply.AddObject(doc, *annot);
  183.             // if no regions found, report max score for the sequence
  184.             if (regions.size() == 0) {
  185.                 m_Dialog->SetCell(row, 2) = "None";
  186.                 m_Dialog->SetCell(row, 3) = NStr::DoubleToString(top_score);
  187.                 m_Dialog->SetCell(row, 4) = 
  188.                     NStr::DoubleToString(CCoiledCoil::ScoreToProb(top_score));
  189.                 ++row;
  190.             }
  191.         }
  192.         catch (exception& e) {
  193.             LOG_POST(Error << e.what());
  194.             string str = CPluginUtils::GetLabel(loc, &doc.GetScope());
  195.             LOG_POST(Error << "Error processing location " << str);
  196.         }
  197. #ifndef _DEBUG
  198.         catch (...) {
  199.             string str = CPluginUtils::GetLabel(loc, &doc.GetScope());
  200.             LOG_POST(Error << "Error processing location " << str);
  201.         }
  202. #endif
  203.     }
  204.     // update all views
  205.     //CDocManager::UpdateAllViews();
  206.     //
  207.     // prepare our dialog box
  208.     //
  209.     m_Dialog->SetLabel(string("Predicted coiled coil regions"
  210.                               " using a window length of ") 
  211.                        + NStr::IntToString(win_len));
  212.     m_Dialog->Show();
  213.     reply.SetStatus(eMessageStatus_success);
  214.     reply.AddAction(CPluginReplyAction::e_Add_to_document);
  215. }
  216. END_NCBI_SCOPE
  217. /*
  218.  * ===========================================================================
  219.  * $Log: predict_coiled_coil.cpp,v $
  220.  * Revision 1000.5  2004/06/01 20:55:30  gouriano
  221.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.15
  222.  *
  223.  * Revision 1.15  2004/05/21 22:27:47  gorelenk
  224.  * Added PCH ncbi_pch.hpp
  225.  *
  226.  * Revision 1.14  2004/05/03 13:05:42  dicuccio
  227.  * gui/utils --> gui/objutils where needed
  228.  *
  229.  * Revision 1.13  2004/03/05 17:35:37  dicuccio
  230.  * Use sequence::GetId() instead of CSeq_id::GetStringDescr()
  231.  *
  232.  * Revision 1.12  2004/01/27 18:38:00  dicuccio
  233.  * Code clean-up.  Use standard names for plugins.  Removed unnecessary #includes
  234.  *
  235.  * Revision 1.11  2004/01/07 15:50:38  dicuccio
  236.  * Adjusted for API change in CPluginUtils::GetLabel().  Standardized exception
  237.  * reporting in algorithms.
  238.  *
  239.  * Revision 1.10  2003/11/24 15:45:27  dicuccio
  240.  * Renamed CVersion to CPluginVersion
  241.  *
  242.  * Revision 1.9  2003/11/18 17:48:37  dicuccio
  243.  * Added standard processing of return values
  244.  *
  245.  * Revision 1.8  2003/11/06 20:12:12  dicuccio
  246.  * Cleaned up handling of USING_SCOPE - removed from all headers
  247.  *
  248.  * Revision 1.7  2003/11/04 17:49:23  dicuccio
  249.  * Changed calling parameters for plugins - pass CPluginMessage instead of paired
  250.  * CPluginCommand/CPluginReply
  251.  *
  252.  * Revision 1.6  2003/10/27 17:46:49  dicuccio
  253.  * Removed dead #includes
  254.  *
  255.  * Revision 1.5  2003/10/15 13:40:26  dicuccio
  256.  * Mkae sure to set the 'id' for the seq-locs before calling RemapChildToParent()
  257.  *
  258.  * Revision 1.4  2003/10/14 16:24:37  dicuccio
  259.  * Correctly remap new feature locations through the parent location to the master
  260.  * sequence
  261.  *
  262.  * Revision 1.3  2003/10/07 13:47:00  dicuccio
  263.  * Renamed CPluginURL* to CPluginValue*
  264.  *
  265.  * Revision 1.2  2003/09/25 17:21:35  jcherry
  266.  * Added name to annot
  267.  *
  268.  * Revision 1.1  2003/09/08 16:15:13  jcherry
  269.  * Initial version
  270.  *
  271.  * ===========================================================================
  272.  */