src/api/internal/BamRandomAccessController_p.cpp

   1 // ***************************************************************************
   2 // BamRandomAccessController_p.cpp (c) 2011 Derek Barnett
   3 // Marth Lab, Department of Biology, Boston College
   4 // All rights reserved.
   5 // ---------------------------------------------------------------------------
   6 // Last modified: 5 April 2011(DB)
   7 // ---------------------------------------------------------------------------
   8 // Manages random access operations in a BAM file
   9 // **************************************************************************
  10
  11 #include <api/BamIndex.h>
  12 #include <api/internal/BamRandomAccessController_p.h>
  13 #include <api/internal/BamReader_p.h>
  14 #include <api/internal/BamIndexFactory_p.h>
  15 using namespace BamTools;
  16 using namespace BamTools::Internal;
  17
  18 #include <iostream>
  19 using namespace std;
  20
  21 BamRandomAccessController::BamRandomAccessController(void)
  22     : m_index(0)
  23     , m_indexCacheMode(BamIndex::LimitedIndexCaching)
  24     , m_hasAlignmentsInRegion(true)
  25 { }
  26
  27 BamRandomAccessController::~BamRandomAccessController(void) {
  28     Close();
  29 }
  30
  31 void BamRandomAccessController::AdjustRegion(const int& referenceCount) {
  32
  33     // skip if no index available
  34     if ( m_index == 0 )
  35         return;
  36
  37     // see if any references in region have alignments
  38     m_hasAlignmentsInRegion = false;
  39     int currentId = m_region.LeftRefID;
  40     const int rightBoundRefId = ( m_region.isRightBoundSpecified() ? m_region.RightRefID : referenceCount - 1 );
  41     while ( currentId <= rightBoundRefId ) {
  42         m_hasAlignmentsInRegion = m_index->HasAlignments(currentId);
  43         if ( m_hasAlignmentsInRegion ) break;
  44         ++currentId;
  45     }
  46
  47     // if no data found on any reference in region
  48     if ( !m_hasAlignmentsInRegion )
  49         return;
  50
  51     // if left bound of desired region had no data, use first reference that had data
  52     // otherwise, leave requested region as-is
  53     if ( currentId != m_region.LeftRefID ) {
  54         m_region.LeftRefID = currentId;
  55         m_region.LeftPosition = 0;
  56     }
  57 }
  58
  59 // returns alignments' "RegionState": { Before|Overlaps|After } current region
  60 BamRandomAccessController::RegionState
  61 BamRandomAccessController::AlignmentState(const BamAlignment& alignment) const {
  62
  63     // if region has no left bound at all
  64     if ( !m_region.isLeftBoundSpecified() )
  65         return OverlapsRegion;
  66
  67     // handle unmapped reads - return AFTER region to halt processing
  68     if ( alignment.RefID == -1 )
  69         return AfterRegion;
  70
  71     // if alignment is on any reference before left bound reference
  72     if ( alignment.RefID < m_region.LeftRefID )
  73         return BeforeRegion;
  74
  75     // if alignment is on left bound reference
  76     else if ( alignment.RefID == m_region.LeftRefID ) {
  77
  78         // if alignment starts at or after left bound position
  79         if ( alignment.Position >= m_region.LeftPosition) {
  80
  81             if ( m_region.isRightBoundSpecified() &&            // right bound is specified AND
  82                  m_region.LeftRefID == m_region.RightRefID &&   // left & right bounds on same reference AND
  83                  alignment.Position > m_region.RightPosition )  // alignment starts after right bound position
  84                 return AfterRegion;
  85
  86             // otherwise, alignment overlaps region
  87             else return OverlapsRegion;
  88         }
  89
  90         // alignment starts before left bound position
  91         else {
  92
  93             // if alignment overlaps left bound position
  94             if ( alignment.GetEndPosition() >= m_region.LeftPosition )
  95                 return OverlapsRegion;
  96             else
  97                 return BeforeRegion;
  98         }
  99     }
 100
 101     // otherwise alignment is on a reference after left bound reference
 102     else {
 103
 104         // if region has a right bound
 105         if ( m_region.isRightBoundSpecified() ) {
 106
 107             // alignment is on any reference between boundaries
 108             if ( alignment.RefID < m_region.RightRefID )
 109                 return OverlapsRegion;
 110
 111             // alignment is on any reference after right boundary
 112             else if ( alignment.RefID > m_region.RightRefID )
 113                 return AfterRegion;
 114
 115             // alignment is on right bound reference
 116             else {
 117
 118                 // if alignment starts on or before right bound position
 119                 if ( alignment.Position <= m_region.RightPosition )
 120                     return OverlapsRegion;
 121                 else
 122                     return AfterRegion;
 123             }
 124         }
 125
 126         // otherwise, alignment starts after left bound and there is no right bound
 127         else return OverlapsRegion;
 128     }
 129 }
 130
 131 void BamRandomAccessController::Close(void) {
 132     ClearIndex();
 133     ClearRegion();
 134 }
 135
 136 void BamRandomAccessController::ClearIndex(void) {
 137     delete m_index;
 138     m_index = 0;
 139 }
 140
 141 void BamRandomAccessController::ClearRegion(void) {
 142     m_region.clear();
 143     m_hasAlignmentsInRegion = true;
 144 }
 145
 146 bool BamRandomAccessController::CreateIndex(BamReaderPrivate* reader,
 147                                             const BamIndex::IndexType& type) {
 148
 149     // skip if reader is invalid
 150     if ( reader == 0 )
 151         return false;
 152
 153     // create new index of requested type
 154     BamIndex* newIndex = BamIndexFactory::CreateIndexOfType(type, reader);
 155     if ( newIndex == 0 ) {
 156         cerr << "BamRandomAccessController ERROR: could not create index of type " << type << endl;
 157         return false;
 158     }
 159
 160     // attempt to build index from current BamReader file
 161     if ( !newIndex->Create() ) {
 162         cerr << "BamRandomAccessController ERROR: could not create index for BAM file: "
 163              << reader->Filename() << endl;
 164         return false;
 165     }
 166
 167     // save new index
 168     SetIndex(newIndex);
 169
 170     // set new index's cache mode & return success
 171     newIndex->SetCacheMode(m_indexCacheMode);
 172     return true;
 173 }
 174
 175 bool BamRandomAccessController::HasIndex(void) const {
 176     return ( m_index != 0 );
 177 }
 178
 179 bool BamRandomAccessController::HasRegion(void) const  {
 180     return ( !m_region.isNull() );
 181 }
 182
 183 bool BamRandomAccessController::IndexHasAlignmentsForReference(const int& refId) {
 184     return m_index->HasAlignments(refId);
 185 }
 186
 187 bool BamRandomAccessController::LocateIndex(BamReaderPrivate* reader,
 188                                             const BamIndex::IndexType& preferredType)
 189 {
 190     // look up index filename, deferring to preferredType if possible
 191     const string& indexFilename = BamIndexFactory::FindIndexFilename(reader->Filename(), preferredType);
 192
 193     // if no index file found (of any type)
 194     if ( indexFilename.empty() ) {
 195         cerr << "BamRandomAccessController WARNING: "
 196              << "could not find index file for BAM: "
 197              << reader->Filename() << endl;
 198         return false;
 199     }
 200
 201     // otherwise open & use index file that was found
 202     return OpenIndex(indexFilename, reader);
 203 }
 204
 205 bool BamRandomAccessController::OpenIndex(const string& indexFilename, BamReaderPrivate* reader) {
 206
 207     // attempt create new index of type based on filename
 208     BamIndex* index = BamIndexFactory::CreateIndexFromFilename(indexFilename, reader);
 209     if ( index == 0 ) {
 210         cerr << "BamRandomAccessController ERROR: could not create index for file: " << indexFilename << endl;
 211         return false;
 212     }
 213
 214     // set cache mode
 215     index->SetCacheMode(m_indexCacheMode);
 216
 217     // attempt to load data from index file
 218     if ( !index->Load(indexFilename) ) {
 219         cerr << "BamRandomAccessController ERROR: could not load index data from file: " << indexFilename << endl;
 220         return false;
 221     }
 222
 223     // save new index & return success
 224     SetIndex(index);
 225     return true;
 226 }
 227
 228 bool BamRandomAccessController::RegionHasAlignments(void) const {
 229     return m_hasAlignmentsInRegion;
 230 }
 231
 232 void BamRandomAccessController::SetIndex(BamIndex* index) {
 233     if ( m_index )
 234         ClearIndex();
 235     m_index = index;
 236 }
 237
 238 void BamRandomAccessController::SetIndexCacheMode(const BamIndex::IndexCacheMode& mode) {
 239     m_indexCacheMode = mode;
 240     if ( m_index )
 241         m_index->SetCacheMode(mode);
 242 }
 243
 244 bool BamRandomAccessController::SetRegion(BamReaderPrivate* reader,
 245                                           const BamRegion& region,
 246                                           const int& referenceCount)
 247 {
 248     // store region
 249     m_region = region;
 250
 251     // cannot jump when no index is available
 252     if ( !HasIndex() )
 253         return false;
 254
 255     // adjust region as necessary to reflect where data actually begins
 256     AdjustRegion(referenceCount);
 257
 258     // if no data present, return true
 259     //   * Not an error, but future attempts to access alignments in this region will not return data
 260     //     Returning true is useful in a BamMultiReader setting where some BAM files may
 261     //     lack alignments in regions where other BAMs do have data.
 262     if ( !m_hasAlignmentsInRegion )
 263         return true;
 264
 265     // return success/failure of jump to specified region,
 266     //
 267     //  * Index::Jump() is allowed to modify the m_hasAlignmentsInRegion flag
 268     //    This covers 'corner case' where a region is requested that lies beyond the last
 269     //    alignment on a reference. If this occurs, any subsequent calls to GetNextAlignment[Core]
 270     //    will not return data. BamMultiReader will still be able to successfully pull alignments
 271     //    from a region from multiple files even if one or more have no data.
 272     return m_index->Jump(m_region, &m_hasAlignmentsInRegion);
 273 }