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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: cn3d_threader.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/04/12 17:31:52  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.19
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: cn3d_threader.hpp,v 1000.2 2004/04/12 17:31:52 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:  Paul Thiessen
  35. *
  36. * File Description:
  37. *       class to isolate and run the threader
  38. *
  39. * ===========================================================================
  40. */
  41. #ifndef CN3D_THREADER__HPP
  42. #define CN3D_THREADER__HPP
  43. #include <corelib/ncbistd.hpp>
  44. #include <corelib/ncbistl.hpp>
  45. #include <map>
  46. #include <list>
  47. #include <vector>
  48. #include <thrdatd.h>
  49. #include <blastkar.h>
  50. #include "vector_math.hpp"
  51. BEGIN_SCOPE(Cn3D)
  52. // for convenience, optional threading parameters are all specified in this block
  53. class ThreaderOptions
  54. {
  55. public:
  56.     bool mergeAfterEachSequence;
  57.     bool freezeIsolatedBlocks;
  58.     double weightPSSM;
  59.     double loopLengthMultiplier;
  60.     int nRandomStarts;
  61. int nResultAlignments;
  62.     int terminalResidueCutoff;
  63.     ThreaderOptions(void);
  64. };
  65. extern ThreaderOptions globalThreaderOptions;
  66. class BlockMultipleAlignment;
  67. class Sequence;
  68. class StructureBase;
  69. class Threader
  70. {
  71. public:
  72.     Threader(void);
  73.     ~Threader(void);
  74.     static const int SCALING_FACTOR;
  75.     static const std::string ThreaderResidues;
  76.     // create new BlockMultipleAlignments from the given multiple and master/slave pairs; returns
  77.     // true if threading successful. If so, depending on options, nRowsAddedToMultiple will be
  78.     // merged into the multiple, and newAlignments will contain all un-merged master/slave pairs
  79.     typedef std::list < BlockMultipleAlignment * > AlignmentList;
  80.     bool Realign(const ThreaderOptions& options, BlockMultipleAlignment *masterMultiple,
  81.         const AlignmentList *originalAlignments,
  82.         int *nRowsAddedToMultiple, AlignmentList *newAlignments);
  83.     // calculate scores for each row in the alignment (and store them in the alignment itself)
  84.     bool CalculateScores(const BlockMultipleAlignment *multiple, double weightPSSM);
  85.     // geometry violations - for each row of an alignment, get a list of seqIndex
  86.     // (from, to) pairs for offending regions; return total number of violations
  87.     typedef std::list < std::pair < int, int > > IntervalList;
  88.     typedef std::vector < IntervalList > GeometryViolationsForRow;
  89.     int GetGeometryViolations(const BlockMultipleAlignment *multiple,
  90.         GeometryViolationsForRow *violations);
  91.     // estimate the number of random starts needed to thread an alignment based on
  92.     // the number of blocks to be aligned
  93.     static int EstimateNRandomStarts(const BlockMultipleAlignment *coreAlignment,
  94.         const BlockMultipleAlignment *toBeThreaded);
  95.     // to hold virtual residue, sidechain positions
  96.     enum { MISSING_COORDINATE = 0, VIRTUAL_RESIDUE, VIRTUAL_PEPTIDE };
  97.     typedef struct {
  98.         unsigned char type;
  99.         Vector coord;
  100.         int disulfideWith;    // if Cysteine, virtual coord index of any disulfide-bound Cys; -1 otherwise
  101.     } VirtualCoordinate;
  102.     typedef std::vector < VirtualCoordinate > VirtualCoordinateList;
  103.     // for (temporary) storage of contacts
  104.     typedef struct {
  105.         int
  106.           vc1, vc2,     // virtual coord index
  107.           distanceBin;
  108.     } Contact;
  109.     typedef std::list < Contact > ContactList;
  110. private:
  111.     // holds Fld_Mtf structures already calculated for a given object (Molecule or Sequence)
  112.     typedef std::map < const StructureBase *, Fld_Mtf * > ContactMap;
  113.     ContactMap contacts;
  114.     // threading structure setups
  115.     Cor_Def * CreateCorDef(const BlockMultipleAlignment *multiple, double loopLengthMultiplier);
  116.     Qry_Seq * CreateQrySeq(const BlockMultipleAlignment *multiple,
  117.         const BlockMultipleAlignment *pairwise, int terminalCutoff);
  118.     Rcx_Ptl * CreateRcxPtl(double weightContacts);
  119.     Gib_Scd * CreateGibScd(bool fast, int nRandomStarts);
  120.     Fld_Mtf * CreateFldMtf(const Sequence *masterSequence);
  121. public:
  122.     // also used by blast module
  123.     static Seq_Mtf * CreateSeqMtf(const BlockMultipleAlignment *multiple,
  124.         double weightPSSM, BLAST_KarlinBlkPtr karlinBlock);
  125. };
  126. END_SCOPE(Cn3D)
  127. #endif // CN3D_THREADER__HPP
  128. /*
  129. * ---------------------------------------------------------------------------
  130. * $Log: cn3d_threader.hpp,v $
  131. * Revision 1000.2  2004/04/12 17:31:52  gouriano
  132. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.19
  133. *
  134. * Revision 1.19  2004/02/19 17:04:52  thiessen
  135. * remove cn3d/ from include paths; add pragma to disable annoying msvc warning
  136. *
  137. * Revision 1.18  2003/11/06 18:52:32  thiessen
  138. * make geometry violations shown on/off; allow multiple pmid entry in ref dialog
  139. *
  140. * Revision 1.17  2003/02/03 19:20:03  thiessen
  141. * format changes: move CVS Log to bottom of file, remove std:: from .cpp files, and use new diagnostic macros
  142. *
  143. * Revision 1.16  2003/01/23 20:03:05  thiessen
  144. * add BLAST Neighbor algorithm
  145. *
  146. * Revision 1.15  2002/07/12 13:24:10  thiessen
  147. * fixes for PSSM creation to agree with cddumper/RPSBLAST
  148. *
  149. * Revision 1.14  2002/03/28 14:06:02  thiessen
  150. * preliminary BLAST/PSSM ; new CD startup style
  151. *
  152. * Revision 1.13  2002/02/21 12:26:30  thiessen
  153. * fix row delete bug ; remember threader options
  154. *
  155. * Revision 1.12  2001/10/08 00:00:02  thiessen
  156. * estimate threader N random starts; edit CDD name
  157. *
  158. * Revision 1.11  2001/09/27 15:36:48  thiessen
  159. * decouple sequence import and BLAST
  160. *
  161. * Revision 1.10  2001/06/01 21:48:02  thiessen
  162. * add terminal cutoff to threading
  163. *
  164. * Revision 1.9  2001/04/12 18:54:22  thiessen
  165. * fix memory leak for PSSM-only threading
  166. *
  167. * Revision 1.8  2001/04/12 18:09:40  thiessen
  168. * add block freezing
  169. *
  170. * Revision 1.7  2001/04/05 22:54:50  thiessen
  171. * change bg color handling ; show geometry violations
  172. *
  173. * Revision 1.6  2001/04/04 00:27:21  thiessen
  174. * major update - add merging, threader GUI controls
  175. *
  176. * Revision 1.5  2001/03/30 03:07:08  thiessen
  177. * add threader score calculation & sorting
  178. *
  179. * Revision 1.4  2001/03/28 23:01:38  thiessen
  180. * first working full threading
  181. *
  182. * Revision 1.3  2001/03/22 00:32:36  thiessen
  183. * initial threading working (PSSM only); free color storage in undo stack
  184. *
  185. * Revision 1.2  2001/02/13 01:03:03  thiessen
  186. * backward-compatible domain ID's in output; add ability to delete rows
  187. *
  188. * Revision 1.1  2001/02/08 23:01:24  thiessen
  189. * hook up C-toolkit stuff for threading; working PSSM calculation
  190. *
  191. */