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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: predict_antigen.cpp,v $
  4.  * PRODUCTION Revision 1000.5  2004/06/01 20:55:28  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.17
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: predict_antigen.cpp,v 1000.5 2004/06/01 20:55:28 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 antigenic sites
  37.  *
  38.  */
  39. #include <ncbi_pch.hpp>
  40. #include "predict_antigen.hpp"
  41. #include <algo/sequence/antigenic.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/PluginRequest.hpp>
  48. #include <gui/plugin/PluginValueConstraint.hpp>
  49. #include <gui/objutils/utils.hpp>
  50. #include <objmgr/util/sequence.hpp>
  51. BEGIN_NCBI_SCOPE
  52. USING_SCOPE(objects);
  53. CAlgoPlugin_PredictAntigen::~CAlgoPlugin_PredictAntigen()
  54. {
  55. }
  56. // standard plugin announce bopilerplate
  57. void CAlgoPlugin_PredictAntigen::GetInfo(CPluginInfo& info)
  58. {
  59.     info.Reset();
  60.     
  61.     // version info macro
  62.     info.SetInfo(CPluginVersion::eMajor, CPluginVersion::eMinor, 0,
  63.                  string(__DATE__) + " " + string(__TIME__),
  64.                  "CAlgoPlugin_PredictAntigen", "Protein analysis/Predict antigenic sites",
  65.                  "Predict antigenic sites from protein sequence",
  66.                  "");
  67.     // command info
  68.     CPluginCommandSet& cmds = info.SetCommands();
  69.     CPluginCommand&    args = cmds.AddAlgoCommand(eAlgoCommand_run);
  70.     args.AddArgument("locs", "Locations to evaluate",
  71.                      CSeq_loc::GetTypeInfo(),
  72.                      CPluginArg::TData::e_Array);
  73.     args.SetConstraint("locs",
  74.                        (*CPluginValueConstraint::CreateSeqMol(),
  75.                         CSeq_inst::eMol_aa));
  76.     args.AddDefaultArgument("min_len", "Minimum length of antigenic sites",
  77.                             CPluginArg::eInteger, "6");
  78. }
  79. void CAlgoPlugin_PredictAntigen::RunCommand(CPluginMessage& msg)
  80. {
  81.     const CPluginCommand& args = msg.GetRequest().GetCommand();
  82.     CPluginReply& reply = msg.SetReply();
  83.     _TRACE("CAlgoPlugin_PredictAntigen::RunCommand()");
  84.     
  85.     if ( !m_Dialog.get() ) {
  86.         m_Dialog.reset(new CMultiColDlg());
  87.         m_Dialog->SetWindowSize(800, 450);
  88.         m_Dialog->SetTitle("Predicted Antigenic Sites");
  89.         
  90.         m_Dialog->SetColumn(0, "Sequence", FL_ALIGN_LEFT, 0.5f);
  91.         m_Dialog->SetColumn(1, "Location", FL_ALIGN_LEFT, 0.5f);
  92.         m_Dialog->SetColumn(2, "Range", FL_ALIGN_CENTER, 0.4f);
  93.         m_Dialog->SetColumn(3, "Sequence", FL_ALIGN_CENTER, 1.5f);
  94.     }
  95.     // clear any previous contents
  96.     m_Dialog->SetRows(0);
  97.     int row = 0;
  98.     plugin_args::TLocList locs;
  99.     GetArgValue(args["locs"], locs);
  100.     int min_len = args["min_len"].AsInteger();
  101.     ITERATE (plugin_args::TLocList, iter, locs) {
  102.         const CSeq_loc&  loc = *iter->second;
  103.         const IDocument& doc = *iter->first;
  104.         // find the best ID for this bioseq
  105.         try {
  106.             CBioseq_Handle handle = doc.GetScope().GetBioseqHandle(loc);
  107.             // get sequence vector
  108.             CSeqVector vec =
  109.                 handle.GetSequenceView(loc,
  110.                                        CBioseq_Handle::eViewConstructed,
  111.                                        CBioseq_Handle::eCoding_Iupac);
  112.             // get IUPAC for display later
  113.             string seq_iupac;
  114.             vec.GetSeqData( (TSeqPos) 0, vec.size(), seq_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 antigenic sites
  125.             vector< CRef<CSeq_loc> > sites;
  126.             // find the sites
  127.             CAntigenic::PredictSites(vec, sites, min_len);
  128.             _TRACE("Predicted " << sites.size() << " antigenic sites");
  129.             // add description to annot
  130.             annot->AddName("Predicted antigenic sites");
  131.             string comment = string("Predicted antigenic determinants"
  132.                                     "using minimum length = ")
  133.                 + NStr::IntToString(min_len);
  134.             annot->AddComment(comment);
  135.             NON_CONST_ITERATE (vector< CRef<CSeq_loc> >, site, sites) {
  136.                 // must set the ID field
  137.                 (**site).SetId(sequence::GetId(loc));
  138.                 //
  139.                 // add sites to dialog
  140.                 //
  141.                 // set the sequence portion first - this relies on our
  142.                 // location being mapped to the sequence vector
  143.                 m_Dialog->SetCell(row, 3)
  144.                     = seq_iupac.substr((**site).GetTotalRange().GetFrom(),
  145.                                        (**site).GetTotalRange().GetTo() -
  146.                                        (**site).GetTotalRange().GetFrom() + 1);
  147.                 // cast the location back to the calling position
  148.                 *site = CSeqUtils::RemapChildToParent(loc, **site);
  149.                 m_Dialog->SetCell(row, 2)
  150.                     = NStr::IntToString((**site).GetTotalRange().GetFrom() + 1) + "-"
  151.                     + NStr::IntToString((**site).GetTotalRange().GetTo() + 1);
  152.                 ++row;
  153.                 
  154.                 //
  155.                 // add features to annot
  156.                 //
  157.                 CRef<CSeq_id> this_id
  158.                     (const_cast<CSeq_id*>(&sequence::GetId(loc)));
  159.                 // create feature
  160.                 CRef<CSeq_feat> feat(new CSeq_feat());
  161.                 feat->SetExp_ev(CSeq_feat::eExp_ev_not_experimental);
  162.                 (*site)->SetId(*this_id);
  163.                 feat->SetLocation(**site);
  164.                 
  165.                 feat->SetData().SetRegion() = "Predicted antigenic site";
  166.                 
  167.                 // save in annot
  168.                 annot->SetData().SetFtable().push_back(feat);
  169.             }
  170.             // attach annot to doc
  171.             //const_cast<IDocument&>(doc).AttachAnnot(*annot);
  172.             reply.AddObject(doc, *annot);
  173.         }
  174.         catch (exception& e) {
  175.             LOG_POST(Error << e.what());
  176.             string str = CPluginUtils::GetLabel(loc, &doc.GetScope());
  177.             LOG_POST(Error << "Error processing location " << str);
  178.         }
  179. #ifndef _DEBUG
  180.         catch (...) {
  181.             string str = CPluginUtils::GetLabel(loc, &doc.GetScope());
  182.             LOG_POST(Error << "Error processing location " << str);
  183.         }
  184. #endif
  185.     }
  186.     // update all views
  187.     //CDocManager::UpdateAllViews();
  188.     //
  189.     // prepare our dialog box
  190.     //
  191.     m_Dialog->SetLabel(string("Antigenic determinants predicted"
  192.                               " using a minimum length of ") 
  193.                        + NStr::IntToString(min_len));
  194.     m_Dialog->Show();
  195.     reply.SetStatus(eMessageStatus_success);
  196.     reply.AddAction(CPluginReplyAction::e_Add_to_document);
  197. }
  198. END_NCBI_SCOPE
  199. /*
  200.  * ===========================================================================
  201.  * $Log: predict_antigen.cpp,v $
  202.  * Revision 1000.5  2004/06/01 20:55:28  gouriano
  203.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.17
  204.  *
  205.  * Revision 1.17  2004/05/21 22:27:47  gorelenk
  206.  * Added PCH ncbi_pch.hpp
  207.  *
  208.  * Revision 1.16  2004/05/03 13:05:42  dicuccio
  209.  * gui/utils --> gui/objutils where needed
  210.  *
  211.  * Revision 1.15  2004/03/05 17:35:37  dicuccio
  212.  * Use sequence::GetId() instead of CSeq_id::GetStringDescr()
  213.  *
  214.  * Revision 1.14  2004/01/27 18:37:58  dicuccio
  215.  * Code clean-up.  Use standard names for plugins.  Removed unnecessary #includes
  216.  *
  217.  * Revision 1.13  2004/01/07 15:50:37  dicuccio
  218.  * Adjusted for API change in CPluginUtils::GetLabel().  Standardized exception
  219.  * reporting in algorithms.
  220.  *
  221.  * Revision 1.12  2003/11/24 15:45:27  dicuccio
  222.  * Renamed CVersion to CPluginVersion
  223.  *
  224.  * Revision 1.11  2003/11/18 17:48:37  dicuccio
  225.  * Added standard processing of return values
  226.  *
  227.  * Revision 1.10  2003/11/06 20:12:12  dicuccio
  228.  * Cleaned up handling of USING_SCOPE - removed from all headers
  229.  *
  230.  * Revision 1.9  2003/11/04 17:49:23  dicuccio
  231.  * Changed calling parameters for plugins - pass CPluginMessage instead of paired
  232.  * CPluginCommand/CPluginReply
  233.  *
  234.  * Revision 1.8  2003/10/27 17:46:49  dicuccio
  235.  * Removed dead #includes
  236.  *
  237.  * Revision 1.7  2003/10/15 13:40:26  dicuccio
  238.  * Mkae sure to set the 'id' for the seq-locs before calling RemapChildToParent()
  239.  *
  240.  * Revision 1.6  2003/10/14 16:24:37  dicuccio
  241.  * Correctly remap new feature locations through the parent location to the master
  242.  * sequence
  243.  *
  244.  * Revision 1.5  2003/10/07 13:47:00  dicuccio
  245.  * Renamed CPluginURL* to CPluginValue*
  246.  *
  247.  * Revision 1.4  2003/09/25 17:21:35  jcherry
  248.  * Added name to annot
  249.  *
  250.  * Revision 1.3  2003/09/04 14:05:24  dicuccio
  251.  * Use IDocument instead of CDocument
  252.  *
  253.  * Revision 1.2  2003/09/03 17:49:11  jcherry
  254.  * Change namespace name from args to plugin_args to avoid clashes with
  255.  * variable names.
  256.  *
  257.  * Revision 1.1  2003/09/02 14:53:12  jcherry
  258.  * Initial version
  259.  *
  260.  * ===========================================================================
  261.  */