src/api/BamWriter.cpp

   1 // ***************************************************************************\r
   2 // BamWriter.cpp (c) 2009 Michael Str�mberg, Derek Barnett\r
   3 // Marth Lab, Department of Biology, Boston College\r
   4 // ---------------------------------------------------------------------------\r
   5 // Last modified: 4 October 2011 (DB)\r
   6 // ---------------------------------------------------------------------------\r
   7 // Provides the basic functionality for producing BAM files\r
   8 // ***************************************************************************\r
   9 \r
  10 #include <api/BamAlignment.h>\r
  11 #include <api/BamWriter.h>\r
  12 #include <api/SamHeader.h>\r
  13 #include <api/internal/BamWriter_p.h>\r
  14 using namespace BamTools;\r
  15 using namespace BamTools::Internal;\r
  16 using namespace std;\r
  17 \r
  18 /*! \class BamTools::BamWriter\r
  19     \brief Provides write access for generating BAM files.\r
  20 */\r
  21 /*! \enum BamTools::BamWriter::CompressionMode\r
  22     \brief This enum describes the compression behaviors for output BAM files.\r
  23 */\r
  24 /*! \var BamWriter::CompressionMode BamWriter::Compressed\r
  25     \brief Use normal BAM compression\r
  26 */\r
  27 /*! \var BamWriter::CompressionMode BamWriter::Uncompressed\r
  28     \brief Disable BAM compression\r
  29 \r
  30     Useful in situations where the BAM data is streamed (e.g. piping).\r
  31     It would be wasteful to compress, and then immediately decompress\r
  32     the data.\r
  33 */\r
  34 \r
  35 /*! \fn BamWriter::BamWriter(void)\r
  36     \brief constructor\r
  37 */\r
  38 BamWriter::BamWriter(void)\r
  39     : d(new BamWriterPrivate)\r
  40 { }\r
  41 \r
  42 /*! \fn BamWriter::~BamWriter(void)\r
  43     \brief destructor\r
  44 */\r
  45 BamWriter::~BamWriter(void) {\r
  46     delete d;\r
  47     d = 0;\r
  48 }\r
  49 \r
  50 /*! \fn BamWriter::Close(void)\r
  51     \brief Closes the current BAM file.\r
  52     \sa Open()\r
  53 */\r
  54 void BamWriter::Close(void) {\r
  55     d->Close();\r
  56 }\r
  57 \r
  58 // returns a human-readable description of the last error that occurred\r
  59 std::string BamWriter::GetErrorString(void) const {\r
  60     return d->GetErrorString();\r
  61 }\r
  62 \r
  63 /*! \fn bool BamWriter::IsOpen(void) const\r
  64     \brief Returns \c true if BAM file is open for writing.\r
  65     \sa Open()\r
  66 */\r
  67 bool BamWriter::IsOpen(void) const {\r
  68     return d->IsOpen();\r
  69 }\r
  70 \r
  71 /*! \fn bool BamWriter::Open(const std::string& filename,\r
  72                              const std::string& samHeaderText,\r
  73                              const RefVector& referenceSequences)\r
  74     \brief Opens a BAM file for writing.\r
  75 \r
  76     Will overwrite the BAM file if it already exists.\r
  77 \r
  78     \param filename           name of output BAM file\r
  79     \param samHeaderText      header data, as SAM-formatted string\r
  80     \param referenceSequences list of reference entries\r
  81 \r
  82     \return \c true if opened successfully\r
  83     \sa Close(), IsOpen(), BamReader::GetHeaderText(), BamReader::GetReferenceData()\r
  84 */\r
  85 bool BamWriter::Open(const std::string& filename,\r
  86                      const std::string& samHeaderText,\r
  87                      const RefVector& referenceSequences)\r
  88 {\r
  89     return d->Open(filename, samHeaderText, referenceSequences);\r
  90 }\r
  91 \r
  92 /*! \fn bool BamWriter::Open(const std::string& filename,\r
  93                              const SamHeader& samHeader,\r
  94                              const RefVector& referenceSequences)\r
  95     \brief Opens a BAM file for writing.\r
  96 \r
  97     This is an overloaded function.\r
  98 \r
  99     Will overwrite the BAM file if it already exists.\r
 100 \r
 101     \param filename           name of output BAM file\r
 102     \param samHeader          header data, wrapped in SamHeader object\r
 103     \param referenceSequences list of reference entries\r
 104 \r
 105     \return \c true if opened successfully\r
 106     \sa Close(), IsOpen(), BamReader::GetHeader(), BamReader::GetReferenceData()\r
 107 */\r
 108 bool BamWriter::Open(const std::string& filename,\r
 109                      const SamHeader& samHeader,\r
 110                      const RefVector& referenceSequences)\r
 111 {\r
 112     return d->Open(filename, samHeader.ToString(), referenceSequences);\r
 113 }\r
 114 \r
 115 /*! \fn void BamWriter::SaveAlignment(const BamAlignment& alignment)\r
 116     \brief Saves an alignment to the BAM file.\r
 117 \r
 118     \param alignment BamAlignment record to save\r
 119     \sa BamReader::GetNextAlignment(), BamReader::GetNextAlignmentCore()\r
 120 */\r
 121 bool BamWriter::SaveAlignment(const BamAlignment& alignment) {\r
 122     return d->SaveAlignment(alignment);\r
 123 }\r
 124 \r
 125 /*! \fn void BamWriter::SetCompressionMode(const BamWriter::CompressionMode& compressionMode)\r
 126     \brief Sets the output compression mode.\r
 127 \r
 128     Default mode is BamWriter::Compressed.\r
 129 \r
 130     N.B. - Changing the compression mode is disabled on open files (i.e. the request will be ignored).\r
 131     Be sure to call this function before opening the BAM file.\r
 132 \r
 133     \code\r
 134         BamWriter writer;\r
 135         writer.SetCompressionMode(BamWriter::Uncompressed);\r
 136         writer.Open( ... );\r
 137         // ...\r
 138     \endcode\r
 139 \r
 140     \param compressionMode desired output compression behavior\r
 141     \sa IsOpen(), Open()\r
 142 */\r
 143 void BamWriter::SetCompressionMode(const BamWriter::CompressionMode& compressionMode) {\r
 144     d->SetWriteCompressed( compressionMode == BamWriter::Compressed );\r
 145 }\r