1. BAMRecord
类简介
BAMRecord
类继承自 SAMRecord
类,并扩展了其功能,以便更高效地处理 BAM 文件的二进制数据。它封装了对 BAM 特定格式的读取和写入操作。
2. 主要属性和方法
属性
BAMRecord
类继承了 SAMRecord
类的所有属性,并添加了一些与 BAM 格式相关的特性。SAMRecord
类的主要属性包括:
- readName: 读取的名称。
- flags: 包含 SAM/BAM 标志位的信息,表示该读取的一些属性(如是否是第一个片段、是否是反向互补序列等)。
- referenceName: 读取所比对到的参考序列的名称。
- alignmentStart: 读取比对到参考序列的起始位置。
- mappingQuality: 该读取比对的质量得分。
- cigarString: CIGAR 字符串,描述了读取比对到参考序列的方式。
- mateReferenceName: 配对读取(mate)比对到的参考序列的名称。
- mateAlignmentStart: 配对读取比对到参考序列的起始位置。
- insertSize: 插入片段大小。
- readBases: 读取的碱基序列。
- baseQualities: 碱基质量分数。
方法
BAMRecord
类继承并实现了 SAMRecord
类中的方法,同时也可能包含一些特定于 BAM 格式的方法。主要方法包括:
- getReadName(): 返回读取的名称。
- getFlags(): 返回读取的标志位信息。
- getReferenceName(): 返回读取比对到的参考序列名称。
- getAlignmentStart(): 返回读取比对到参考序列的起始位置。
- getMappingQuality(): 返回读取比对的质量得分。
- getCigarString(): 返回 CIGAR 字符串。
- getMateReferenceName(): 返回配对读取比对到的参考序列名称。
- getMateAlignmentStart(): 返回配对读取比对到参考序列的起始位置。
- getInsertSize(): 返回插入片段大小。
- getReadBases(): 返回读取的碱基序列。
- getBaseQualities(): 返回碱基质量分数。
- setReadName(String readName): 设置读取的名称。
- setFlags(int flags): 设置读取的标志位信息。
- setReferenceName(String referenceName): 设置读取比对到的参考序列名称。
- setAlignmentStart(int alignmentStart): 设置读取比对到参考序列的起始位置。
- setMappingQuality(int mappingQuality): 设置读取比对的质量得分。
- setCigarString(String cigarString): 设置 CIGAR 字符串。
- setMateReferenceName(String mateReferenceName): 设置配对读取比对到的参考序列名称。
- setMateAlignmentStart(int mateAlignmentStart): 设置配对读取比对到参考序列的起始位置。
- setInsertSize(int insertSize): 设置插入片段大小。
- setReadBases(byte[] readBases): 设置读取的碱基序列。
- setBaseQualities(byte[] baseQualities): 设置碱基质量分数。
3. 源代码
/*
* The MIT License
*
* Copyright (c) 2009 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package htsjdk.samtools;
import htsjdk.samtools.util.StringUtil;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import static htsjdk.samtools.SAMTag.CG;
/**
* Wrapper class for binary BAM records.
* Delays unpacking all data binary until requested.
*/
public class BAMRecord extends SAMRecord {
/**
* Offset of the read name in the variable length section of the disk representation of BAMRecord
*/
private static final i