From Genome Analysis Wiki
Jump to navigationJump to search
4 bytes added
, 17:35, 29 July 2010
Line 87: |
Line 87: |
| Pass in -1 in order to read the section of the bam file not associated with any reference ID. | | Pass in -1 in order to read the section of the bam file not associated with any reference ID. |
| | | |
− | Must be called after <code>ReadHeader</code>. | + | Must be called after <code>OpenForRead</code>. |
| | | |
| Returns true if the read section was successfully set, false if not. False is returned if the BAM Index File has not yet been read or if a BAM file is not open for reading. | | Returns true if the read section was successfully set, false if not. False is returned if the BAM Index File has not yet been read or if a BAM file is not open for reading. |
Line 95: |
Line 95: |
| Pass in -1 in order to read the section of the bam file not associated with any reference ID. | | Pass in -1 in order to read the section of the bam file not associated with any reference ID. |
| | | |
− | Must be called after <code>ReadHeader</code>. | + | Must be called after <code>OpenForRead</code>. |
| | | |
| Returns true if the read section was successfully set, false if not. False is returned if the BAM Index File has not yet been read or if a BAM file is not open for reading. | | Returns true if the read section was successfully set, false if not. False is returned if the BAM Index File has not yet been read or if a BAM file is not open for reading. |
Line 102: |
Line 102: |
| | Sets what part of the BAM file should be read. Fails if this is not a BAM file &/or the index file has not yet been read. This version will set it to only read a specific reference id and start(inclusive)/end(exclusive) region. The records for this section will be retrieved on each <code>ReadRecord</code> call. When all records have been retrieved for the specified section, ReadRecord will return failure until a new read section is set. | | | Sets what part of the BAM file should be read. Fails if this is not a BAM file &/or the index file has not yet been read. This version will set it to only read a specific reference id and start(inclusive)/end(exclusive) region. The records for this section will be retrieved on each <code>ReadRecord</code> call. When all records have been retrieved for the specified section, ReadRecord will return failure until a new read section is set. |
| | | |
− | Must be called after <code>ReadHeader</code>. | + | Must be called after <code>OpenForRead</code>. |
| | | |
| Return Value: true = success; false = failure. | | Return Value: true = success; false = failure. |
Line 109: |
Line 109: |
| | Sets what part of the BAM file should be read. Fails if this is not a BAM file &/or the index file has not yet been read. This version will set it to only read a specific reference name and start(inclusive)/end(exclusive) region. The records for this section will be retrieved on each <code>ReadRecord</code> call. When all records have been retrieved for the specified section, ReadRecord will return failure until a new read section is set. | | | Sets what part of the BAM file should be read. Fails if this is not a BAM file &/or the index file has not yet been read. This version will set it to only read a specific reference name and start(inclusive)/end(exclusive) region. The records for this section will be retrieved on each <code>ReadRecord</code> call. When all records have been retrieved for the specified section, ReadRecord will return failure until a new read section is set. |
| | | |
− | Must be called after <code>ReadHeader</code>. | + | Must be called after <code>OpenForRead</code>. |
| | | |
| Return Value: true = success; false = failure. | | Return Value: true = success; false = failure. |