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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_diagnostics.h,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 18:11:48  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: blast_diagnostics.h,v 1000.0 2004/06/01 18:11:48 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_diagnostics.h
  38.  * Various diagnostics (hit counts, etc.) returned from the BLAST engine
  39.  */
  40. #ifndef __BLAST_DIAGNOSTICS__
  41. #define __BLAST_DIAGNOSTICS__
  42. #include <algo/blast/core/ncbi_std.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. typedef struct BlastRawCutoffs {
  47.    Int4 x_drop_ungapped; /**< Raw value of the x-dropoff for ungapped 
  48.                             extensions */
  49.    Int4 x_drop_gap; /**< Raw value of the x-dropoff for preliminary gapped 
  50.                        extensions */
  51.    Int4 x_drop_gap_final; /**< Raw value of the x-dropoff for gapped 
  52.                              extensions with traceback */
  53.    Int4 gap_trigger; /**< Minimal raw score for starting gapped extension */
  54. } BlastRawCutoffs;
  55. typedef struct BlastUngappedStats {
  56.    Int8 lookup_hits; /**< Number of successful lookup table hits */
  57.    Int4 num_seqs_lookup_hits; /**< Number of sequences which had at least one 
  58.                                  lookup table hit. */
  59.    Int4 init_extends; /**< Number of initial words found and extended */
  60.    Int4 good_init_extends; /**< Number of successful initial extensions,
  61.                               i.e. number of HSPs saved after ungapped stage.*/
  62.    Int4 num_seqs_passed; /**< Number of sequences with at least one HSP saved
  63.                             after ungapped stage. */
  64. } BlastUngappedStats;
  65. typedef struct BlastGappedStats {
  66.    Int4 seqs_ungapped_passed; /**< Number of sequences with top HSP 
  67.                                  after ungapped extension passing the
  68.                                  e-value threshold. */
  69.    Int4 extra_extensions; /**< Number of extra gapped extensions performed for
  70.                              ungapped HSPs above the e-value threshold. */
  71.    Int4 extensions; /**< Total number of gapped extensions performed. */
  72.    Int4 good_extensions; /**< Number of HSPs below the e-value threshold after
  73.                             gapped extension */
  74.    Int4 num_seqs_passed; /**< Number of sequences with top HSP passing the
  75.                             e-value threshold. */
  76. } BlastGappedStats;
  77. /** Return statistics from the BLAST search */
  78. typedef struct BlastDiagnostics {
  79.    BlastUngappedStats* ungapped_stat; /**< Ungapped extension counts */
  80.    BlastGappedStats* gapped_stat; /**< Gapped extension counts */
  81.    BlastRawCutoffs* cutoffs; /**< Various raw values for the cutoffs */
  82. } BlastDiagnostics;
  83. /** Free the BlastDiagnostics structure and all substructures. */
  84. BlastDiagnostics* Blast_DiagnosticsFree(BlastDiagnostics* diagnostics);
  85. /** Initialize the BlastDiagnostics structure and all its substructures. */
  86. BlastDiagnostics* Blast_DiagnosticsInit();
  87. /** Fill data in the ungapped hits diagnostics structure */
  88. void Blast_UngappedStatsUpdate(BlastUngappedStats* ungapped_stats, 
  89.                                Int4 total_hits, Int4 extended_hits,
  90.                                Int4 saved_hits);
  91. #ifdef __cplusplus
  92. }
  93. #endif
  94. #endif /* !__BLAST_DIAGNOSTICS__ */