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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_util.cpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 20:54:19  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: blast_util.cpp,v 1000.2 2004/06/01 20:54:19 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:  Mike DiCuccio
  35.  *
  36.  * File Description:
  37.  *
  38.  */
  39. #include <ncbi_pch.hpp>
  40. #include "blast_util.hpp"
  41. #include <objects/seqfeat/Genetic_code.hpp>
  42. #include <objects/seqfeat/Genetic_code_table.hpp>
  43. #include <gui/plugin/PluginValueConstraint.hpp>
  44. #include <gui/core/plugin_utils.hpp>
  45. #include <util/static_map.hpp>
  46. #include <algo/blast/api/blast_types.hpp>
  47. BEGIN_NCBI_SCOPE
  48. USING_SCOPE(objects);
  49. // figure out the id of the genetic code the user wants
  50. inline
  51. int x_DecodeGeneticCode(const string& s)
  52. {
  53.     const CGenetic_code_table& code_table = CGen_code_table::GetCodeTable();
  54.     const CGenetic_code_table::Tdata& codes = code_table.Get();
  55.     ITERATE (CGenetic_code_table::Tdata, code, codes) {
  56.         if ((*code)->GetName() == s) {
  57.             return (*code)->GetId();
  58.         }
  59.     }
  60.     // if we got here, nothing matched
  61.     NCBI_THROW(CException, eUnknown,
  62.                "x_DecodeGeneticCode: no genetic code matched " + s);
  63. }
  64. void CBlastUtils::AddBlastArgs(CPluginCommand& args, blast::EProgram prog)
  65. {
  66.     switch (prog) {
  67.     case blast::eBlastn:
  68.         args.AddDefaultArgument("word", "Word Size",
  69.                                 CPluginArg::eInteger, "11");
  70.         args.AddDefaultArgument("expect", "Expect Value",
  71.                                 CPluginArg::eDouble, "10.0");
  72.         args.AddArgument("greedy", "Perform a greedy alignment",
  73.                          CPluginArg::eBoolean);
  74.         //
  75.         // hidden argument for program type
  76.         //
  77.         {{
  78.             CPluginArg& arg = args.AddArgument("prog", "Program Type",
  79.                                                CPluginArg::eString);
  80.             arg.SetHidden(true);
  81.             arg.SetString("blastn");
  82.         }}
  83.         break;
  84.     case blast::eBlastx:
  85.         args.AddDefaultArgument("thresh", "Threshold",
  86.                                 CPluginArg::eInteger, "12");
  87.         args.AddDefaultArgument("word", "Word Size",
  88.                                 CPluginArg::eInteger, "3");
  89.         args.AddDefaultArgument("expect", "Expect Value",
  90.                                 CPluginArg::eDouble, "10.0");
  91.         // genetic code argument
  92.         {{
  93.             const CGenetic_code_table& code_table =
  94.                 CGen_code_table::GetCodeTable();
  95.             const list<CRef<CGenetic_code> >& codes = code_table.Get();
  96.             args.AddDefaultArgument("gencode", "Genetic code",
  97.                                     CPluginArg::eString,
  98.                                     codes.front()->GetName());
  99.             CPluginValueConstraint *code_list =
  100.                 CPluginValueConstraint::CreateSet();
  101.             ITERATE (list<CRef<CGenetic_code> >, code, codes) {
  102.                 code_list->SetSet().push_back((*code)->GetName());
  103.             }
  104.             args.SetConstraint("gencode", *code_list);
  105.         }}
  106.         //
  107.         // hidden argument for program type
  108.         //
  109.         {{
  110.             CPluginArg& arg = args.AddArgument("prog", "Program Type",
  111.                                                CPluginArg::eString);
  112.             arg.SetHidden(true);
  113.             arg.SetString("blastx");
  114.         }}
  115.         break;
  116.     case blast::eBlastp:
  117.         args.AddDefaultArgument("thresh", "Threshold",
  118.                                 CPluginArg::eInteger, "11");
  119.         args.AddDefaultArgument("word", "Word Size",
  120.                                 CPluginArg::eInteger, "3");
  121.         args.AddDefaultArgument("expect", "Expect Value",
  122.                                 CPluginArg::eDouble, "10.0");
  123.         //
  124.         // hidden argument for program type
  125.         //
  126.         {{
  127.             CPluginArg& arg = args.AddArgument("prog", "Program Type",
  128.                                                CPluginArg::eString);
  129.             arg.SetHidden(true);
  130.             arg.SetString("blastp");
  131.         }}
  132.         break;
  133.     case blast::eTblastx:
  134.         args.AddDefaultArgument("thresh", "Threshold",
  135.                                 CPluginArg::eInteger, "13");
  136.         args.AddDefaultArgument("word", "Word Size",
  137.                                 CPluginArg::eInteger, "3");
  138.         args.AddDefaultArgument("expect", "Expect Value",
  139.                                 CPluginArg::eDouble, "10.0");
  140.         // genetic code argument
  141.         {{
  142.             const CGenetic_code_table& code_table =
  143.                 CGen_code_table::GetCodeTable();
  144.             const list<CRef<CGenetic_code> >& codes = code_table.Get();
  145.             args.AddDefaultArgument("gencode", "Genetic code",
  146.                                     CPluginArg::eString,
  147.                                     codes.front()->GetName());
  148.             CPluginValueConstraint *code_list =
  149.                 CPluginValueConstraint::CreateSet();
  150.             ITERATE (list<CRef<CGenetic_code> >, code, codes) {
  151.                 code_list->SetSet().push_back((*code)->GetName());
  152.             }
  153.             args.SetConstraint("gencode", *code_list);
  154.         }}
  155.         //
  156.         // hidden argument for program type
  157.         //
  158.         {{
  159.             CPluginArg& arg = args.AddArgument("prog", "Program Type",
  160.                                                CPluginArg::eString);
  161.             arg.SetHidden(true);
  162.             arg.SetString("tblastx");
  163.         }}
  164.         break;
  165.     default:
  166.         LOG_POST(Error << "unhandled BLAST program");
  167.         break;
  168.     }
  169. }
  170. void CBlastUtils::ArgsToBlastOptions(const CPluginCommand& cmd,
  171.                                      blast::CBlastOptions& opts)
  172. {
  173.     if (cmd.HasArgument("word")  &&
  174.         CPluginUtils::IsValid(cmd["word"])) {
  175.         int word_size = cmd["word"].AsInteger();
  176.         opts.SetWordSize(word_size);
  177.         _TRACE("CBlastBase: word size = " << word_size);
  178.     }
  179.     if (cmd.HasArgument("expect")  &&
  180.         CPluginUtils::IsValid(cmd["expect"])) {
  181.         double expect = cmd["expect"].AsDouble();
  182.         opts.SetEvalueThreshold(expect);
  183.         _TRACE("CBlastBase: expect = " << expect);
  184.     }
  185.     if (cmd.HasArgument("thresh")  &&
  186.         CPluginUtils::IsValid(cmd["thresh"])) {
  187.         int thresh = cmd["thresh"].AsInteger();
  188.         opts.SetWordThreshold(thresh);
  189.         _TRACE("CBlastBase: threshold = " << thresh);
  190.     }
  191.     if (cmd.HasArgument("greedy")  &&
  192.         CPluginUtils::IsValid(cmd["greedy"])) {
  193.         bool greedy = cmd["greedy"].AsBoolean();
  194.         if (greedy) {
  195.             opts.SetGapExtnAlgorithm(eGreedyWithTracebackExt);
  196.         }
  197.         _TRACE("CBlastBase: greedy = " << greedy);
  198.     }
  199.     if (cmd.HasArgument("gencode")  &&
  200.         CPluginUtils::IsValid(cmd["gencode"])) {
  201.         string code = cmd["gencode"].AsString();
  202.         opts.SetDbGeneticCode(x_DecodeGeneticCode(code.c_str()));
  203.         _TRACE("CBlastBase: genetic code = " << code);
  204.     }
  205. }
  206. blast::EProgram CBlastUtils::GetBlastProgram(const string& str)
  207. {
  208.     typedef pair<const char*, blast::EProgram> TProgPair;
  209.     static const TProgPair sc_ProgPairs[] = {
  210.         TProgPair("blastn", blast::eBlastn),
  211.         TProgPair("blastp", blast::eBlastp),
  212.         TProgPair("blastx", blast::eBlastx),
  213.         TProgPair("tblastn", blast::eTblastn),
  214.         TProgPair("tblastx", blast::eTblastx)
  215.     };
  216.     typedef CStaticArrayMap<const char*, blast::EProgram, PCase> TProgDictionary;
  217.     static const TProgDictionary sc_Progs(sc_ProgPairs, sizeof(sc_ProgPairs));
  218.     TProgDictionary::const_iterator iter = sc_Progs.find(str.c_str());
  219.     if (iter != sc_Progs.end()) {
  220.         return iter->second;
  221.     }
  222.     return blast::eBlastProgramMax;
  223. }
  224. END_NCBI_SCOPE
  225. /*
  226.  * ===========================================================================
  227.  * $Log: blast_util.cpp,v $
  228.  * Revision 1000.2  2004/06/01 20:54:19  gouriano
  229.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  230.  *
  231.  * Revision 1.4  2004/05/21 22:27:46  gorelenk
  232.  * Added PCH ncbi_pch.hpp
  233.  *
  234.  * Revision 1.3  2004/05/17 18:00:09  ucko
  235.  * Int algorithm_type replaced with enum EBlastPrelimGapExt
  236.  *
  237.  * Revision 1.2  2004/04/16 14:41:22  dicuccio
  238.  * Added GetBlastProgram() - convert text-based program name to enum
  239.  *
  240.  * Revision 1.1  2004/01/13 20:35:27  dicuccio
  241.  * Initial revision
  242.  *
  243.  * ===========================================================================
  244.  */