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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_filter.h,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:03:28  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.18
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: blast_filter.h,v 1000.2 2004/06/01 18:03: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.  * Author:  Ilya Dondoshansky
  35.  *
  36.  */
  37. /** @file blast_filter.h
  38.  * BLAST filtering functions. @todo FIXME: contains more than filtering 
  39.  * functions, combine with blast_dust.h?
  40.  */
  41. #ifndef __BLAST_FILTER__
  42. #define __BLAST_FILTER__
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. #include <algo/blast/core/blast_def.h>
  47. #include <algo/blast/core/blast_message.h>
  48. /** Create and initialize a new sequence interval.
  49.  * @param from Start of the interval [in]
  50.  * @param to End of the interval [in]
  51.  * @return Pointer to the allocated BlastSeqLoc structure.
  52.  */
  53. BlastSeqLoc* BlastSeqLocNew(Int4 from, Int4 to);
  54. /** Deallocate a BlastSeqLoc structure */
  55. BlastSeqLoc* BlastSeqLocFree(BlastSeqLoc* loc);
  56. /** Deallocate memory for a list of BlastMaskLoc structures */
  57. BlastMaskLoc* BlastMaskLocFree(BlastMaskLoc* mask_loc);
  58. /** Allocate memory for a BlastMaskLoc.
  59.  * @param index which context (i.e., strand) [in]
  60.  * @param loc_list List of locations on that strand [in]
  61.  * @return Pointer to the allocated BlastMaskLoc structure.
  62. */
  63. BlastMaskLoc* BlastMaskLocNew(Int4 index, BlastSeqLoc *loc_list);
  64. /** Go through all mask locations in one sequence, 
  65.  * combine any that overlap. Deallocate the memory for the locations that 
  66.  * were on the list, produce a new (merged) list of locations. 
  67.  * @param mask_loc The list of masks to be merged [in] 
  68.  * @param mask_loc_out The new (merged) list of masks. [out]
  69.  * @param link_value Largest gap size between locations fow which they
  70.  *                   should be linked together [in] 
  71. */
  72. Int2
  73. CombineMaskLocations(BlastSeqLoc* mask_loc, BlastSeqLoc* *mask_loc_out,
  74.                      Int4 link_value);
  75. /** This function takes the list of mask locations (i.e., regions that 
  76.  * should not be searched or not added to lookup table) and makes up a set 
  77.  * of SSeqRange*'s that should be searched (that is, takes the 
  78.  * complement). If the entire sequence is filtered, then a SSeqRange is 
  79.  * created and both of its elements (left and right) are set to -1 to indicate 
  80.  * this. 
  81.  * If any of the mask_loc's is NULL, a SSeqRange for full span of the 
  82.  * respective query sequence is created.
  83.  * @param program_number Type of BLAST program [in]
  84.  * @param query_info The query information structure [in]
  85.  * @param mask_loc All mask locations [in]
  86.  * @param complement_mask Linked list of SSeqRange*s with offsets. [out]
  87. */
  88. Int2 
  89. BLAST_ComplementMaskLocations(Uint1 program_number, 
  90.    BlastQueryInfo* query_info, BlastMaskLoc* mask_loc, 
  91.    BlastSeqLoc* *complement_mask);
  92. /** Runs filtering functions, according to the string "instructions", on the
  93.  * SeqLocPtr. Should combine all SeqLocs so they are non-redundant.
  94.  * @param program_number Type of BLAST program [in]
  95.  * @param sequence The sequence or part of the sequence to be filtered [in]
  96.  * @param length Length of the (sub)sequence [in]
  97.  * @param offset Offset into the full sequence [in]
  98.  * @param instructions String of instructions to filtering functions. [in]
  99.  * @param mask_at_hash If TRUE masking is done while making the lookup table
  100.  *                     only. [out] 
  101.  * @param seqloc_retval Resulting locations for filtered region. [out]
  102. */
  103. Int2
  104. BlastSetUp_Filter(Uint1 program_number, 
  105.     Uint1* sequence, 
  106.     Int4 length, 
  107.     Int4 offset, 
  108.     const char* instructions, 
  109.     Boolean *mask_at_hash, 
  110.     BlastSeqLoc* *seqloc_retval);
  111. /** Does preparation for filtering and then calls BlastSetUp_Filter
  112.  * @param query_blk sequence to be filtered [in]
  113.  * @param query_info info on sequence to be filtered [in]
  114.  * @param program_number one of blastn,blastp,blastx,etc. [in]
  115.  * @param filter_string instructions for filtering [in]
  116.  * @param filter_out Resulting locations for filtered region. [out]
  117.  * @param mask_at_hash If TRUE masking is done while making the lookup table
  118.  *                     only. [out] 
  119.  * @param blast_message message that needs to be sent back to user.
  120. */
  121. Int2
  122. BlastSetUp_GetFilteringLocations(BLAST_SequenceBlk* query_blk, BlastQueryInfo* query_info,
  123.     Uint1 program_number, const char* filter_string, BlastMaskLoc* *filter_out, Boolean* mask_at_hash,
  124.     Blast_Message* *blast_message);
  125. /** Masks the letters in buffer.
  126.  * This is a low-level routine and takes a raw buffer which it assumes
  127.  * to be in ncbistdaa (protein) or blastna (nucleotide).
  128.  * @param buffer the sequence to be masked (will be modified). [out]
  129.  * @param length length of the sequence to be masked . [in]
  130.  * @param is_na nucleotide if TRUE [in]
  131.  * @param mask_loc the SeqLoc to use for masking [in] 
  132.  * @param reverse minus strand if TRUE [in]
  133.  * @param offset how far along sequence is 1st residuse in buffer [in]
  134.  *
  135. */
  136. Int2
  137. Blast_MaskTheResidues(Uint1 * buffer, Int4 length, Boolean is_na, 
  138.     ListNode * mask_loc, Boolean reverse, Int4 offset);
  139. /** Masks the sequence given a BlastMaskLoc
  140.  * @param query_blk sequence to be filtered [in]
  141.  * @param query_info info on sequence to be filtered [in]
  142.  * @param filter_maskloc Locations to filter [in]
  143.  * @param program_number one of blastn,blastp,blastx,etc. [in]
  144. */
  145. Int2
  146. BlastSetUp_MaskQuery(BLAST_SequenceBlk* query_blk, BlastQueryInfo* query_info,
  147.     BlastMaskLoc *filter_maskloc, Uint1 program_number);
  148. #ifdef __cplusplus
  149. }
  150. #endif
  151. #endif /* !__BLAST_FILTER__ */