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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_traceback.h,v $
  4.  * PRODUCTION Revision 1000.3  2004/06/01 18:03:54  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.31
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: blast_traceback.h,v 1000.3 2004/06/01 18:03:54 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 offical 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.  * Author: Ilya Dondoshansky
  35.  *
  36.  */
  37. /** @file blast_traceback.h
  38.  * Functions to do gapped alignment with traceback
  39.  */
  40. #ifndef __BLAST_TRACEBACK__
  41. #define __BLAST_TRACEBACK__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #include <algo/blast/core/blast_seqsrc.h>
  46. #include <algo/blast/core/blast_gapalign.h>
  47. /** Compute gapped alignment with traceback for all HSPs from a single
  48.  * query/subject sequence pair. 
  49.  * Final e-values are calculated here, except when sum statistics is used,
  50.  * in which case this is done in file link_hsps.c:
  51.  * @sa { BLAST_LinkHsps }
  52.  * @param program_number Type of BLAST program [in]
  53.  * @param hsp_list List of HSPs [in]
  54.  * @param query_blk The query sequence [in]
  55.  * @param subject_blk The subject sequence [in]
  56.  * @param query_info Query information, needed to get pointer to the
  57.  *        start of this query within the concatenated sequence [in]
  58.  * @param gap_align Auxiliary structure used for gapped alignment [in]
  59.  * @param sbp Statistical parameters [in]
  60.  * @param score_params Scoring parameters (esp. scale factor) [in]
  61.  * @param ext_options Gapped extension options [in]
  62.  * @param hit_params Hit saving parameters [in]
  63.  * @param gen_code_string specifies genetic code [in]
  64.  */
  65. Int2
  66. Blast_TracebackFromHSPList(Uint1 program_number, BlastHSPList* hsp_list,
  67.    BLAST_SequenceBlk* query_blk, BLAST_SequenceBlk* subject_blk,
  68.    BlastQueryInfo* query_info,
  69.    BlastGapAlignStruct* gap_align, BlastScoreBlk* sbp,
  70.    const BlastScoringParameters* score_params,
  71.    const BlastExtensionOptions* ext_options,
  72.    const BlastHitSavingParameters* hit_params,
  73.    const Uint1* gen_code_string);
  74. /** Given the preliminary alignment results from a database search, redo 
  75.  * the gapped alignment with traceback, if it has not yet been done.
  76.  * @param program_number Type of the BLAST program [in]
  77.  * @param results Results of this BLAST search [in] [out]
  78.  * @param query The query sequence [in]
  79.  * @param query_info Information about the query [in]
  80.  * @param bssp BLAST database structure [in]
  81.  * @param gap_align The auxiliary structure for gapped alignment [in]
  82.  * @param score_params Scoring parameters (esp. scale factor) [in]
  83.  * @param ext_params Gapped extension parameters [in]
  84.  * @param hit_params Parameters for saving hits. Can change if not a 
  85.                      database search [in]
  86.  * @param eff_len_params Parameters for recalculating effective search 
  87.  *                       space. Can change if not a database search. [in]
  88.  * @param db_options Options containing database genetic code string [in]
  89.  * @param psi_options Options for iterative searches [in]
  90.  * @return nonzero indicates failure, otherwise zero
  91.  */
  92. Int2 BLAST_ComputeTraceback(Uint1 program_number, BlastHSPResults* results, 
  93.         BLAST_SequenceBlk* query, BlastQueryInfo* query_info, 
  94.         const BlastSeqSrc* bssp, BlastGapAlignStruct* gap_align,
  95.         BlastScoringParameters* score_params,
  96.         const BlastExtensionParameters* ext_params,
  97.         BlastHitSavingParameters* hit_params,
  98.         BlastEffectiveLengthsParameters* eff_len_params,
  99.         const BlastDatabaseOptions* db_options,
  100.         const PSIBlastOptions* psi_options);
  101. /** Compute traceback information for alignments found by an
  102.  *  RPS blast search. This function performs two major tasks:
  103.  *  - Computes a composition-specific PSSM to be used during the
  104.  *    traceback computation (non-translated searches only)
  105.  *  - After traceback is computed, switch query offsets with 
  106.  *    subject offsets and switch the edit blocks that describe
  107.  *    the alignment. This is required because the entire RPS search
  108.  *    was performed with these quatities reversed.
  109.  * This call is also the first time that enough information 
  110.  * exists to compute E-values for alignments that are found.
  111.  *
  112.  * @param program_number Type of the BLAST program [in]
  113.  * @param results Structure containing the single HSPList 
  114.  *                that is the result of a call to Blast_HSPResultsRPSUpdate.
  115.  *                Traceback information is added to HSPs in list [in] [out]
  116.  * @param concat_db The concatentation of all RPS DB sequences. 
  117.  *                  The sequence data itself is not needed, 
  118.  *                  only its size [in]
  119.  * @param concat_db_info Used for the list of context offsets 
  120.  *                       for concat_db [in]
  121.  * @param query The original query sequence [in]
  122.  * @param query_info Information associated with the original query. 
  123.  *                   Only used for the search space [in]
  124.  * @param gap_align The auxiliary structure for gapped alignment [in]
  125.  * @param score_params Scoring parameters (esp. scale factor) [in]
  126.  * @param ext_params Gapped extension parameters [in]
  127.  * @param hit_params Parameters for saving hits. Can change if not a 
  128.                      database search [in]
  129.  * @param db_options Options containing database genetic code string [in]
  130.  * @param karlin_k Array of Karlin values, one for each database 
  131.  *                 sequence. Used for E-value calculation [in]
  132.  * @return nonzero indicates failure, otherwise zero
  133.  */
  134. Int2 BLAST_RPSTraceback(Uint1 program_number,
  135.         BlastHSPResults* results,
  136.         BLAST_SequenceBlk* concat_db,
  137.         BlastQueryInfo* concat_db_info,
  138.         BLAST_SequenceBlk* query,
  139.         BlastQueryInfo* query_info,
  140.         BlastGapAlignStruct* gap_align, 
  141.         const BlastScoringParameters* score_params,
  142.         const BlastExtensionParameters* ext_params,
  143.         BlastHitSavingParameters* hit_params,
  144.         const BlastDatabaseOptions* db_options,
  145.         const double* karlin_k);
  146. #ifdef __cplusplus
  147. }
  148. #endif
  149. #endif /* !__BLAST_TRACEBACK__ */