NCBI C++ ToolKit
bam_utils.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef PKG_SEQUENCE___BAM_UTILS__HPP
2 #define PKG_SEQUENCE___BAM_UTILS__HPP
3 
4 /*
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Andrei Shkeda
30  *
31  * File Description:
32  *
33  */
34 
36 
38 
39 class ICanceled;
40 
41 class CBamUtils
42 {
43 public:
44  typedef vector<CConstRef<objects::CSeq_id> > TSeqIdsVector;
45 
47  CreateCoverageGraphs(const string& bam_file,
48  const string& index_file,
49  const string& annot_name,
50  const string& assembly,
51  int bin_size = 1000,
52  TSeqIdsVector* ids = 0,
53  bool is_esitmated = false,
54  ICanceled* canceled = 0);
55  static bool GetCoverageGraphInfo(const objects::CSeq_annot& seq_annot, string& bam_data, string& bam_index, string& assembly);
56  static void UpdateCoverageGraphInfo(objects::CSeq_annot& seq_annot, const string& bam_data, const string& bam_index, const string& assembly);
57 
58 };
59 
60 
62 
63 #endif // PKG_SEQUENCE___BAM_UTILS__HPP
static CRef< objects::CSeq_annot > CreateCoverageGraphs(const string &bam_file, const string &index_file, const string &annot_name, const string &assembly, int bin_size=1000, TSeqIdsVector *ids=0, bool is_esitmated=false, ICanceled *canceled=0)
Definition: bam_utils.cpp:191
static bool GetCoverageGraphInfo(const objects::CSeq_annot &seq_annot, string &bam_data, string &bam_index, string &assembly)
Definition: bam_utils.cpp:261
vector< CConstRef< objects::CSeq_id > > TSeqIdsVector
Definition: bam_utils.hpp:44
static void UpdateCoverageGraphInfo(objects::CSeq_annot &seq_annot, const string &bam_data, const string &bam_index, const string &assembly)
Definition: bam_utils.cpp:302
Interface for testing cancellation request in a long lasting operation.
Definition: icanceled.hpp:51
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Modified on Mon Jul 22 05:04:25 2024 by modify_doxy.py rev. 669887