edu.sysu.pmglab.gbc.variant.genotype

枚举 EncodeType

java.lang.Object

java.lang.Enum<EncodeType>

edu.sysu.pmglab.gbc.variant.genotype.EncodeType

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<EncodeType>

public enum EncodeType
extends java.lang.Enum<EncodeType>

基因编码类型 类型编码为 1 个字节, 表示 (向型码 + (类型码 << 1))

枚举常量概要

枚举常量

枚举常量和说明
BEG 单字节编码, 适用于可变等位基因数 [3, 15], 采用 1 byte 储存基因型 [类型魔术编码][AC][AN][genotype num][基因型 1 byte per genotype][基因型 1 byte per genotype]...
DBEG 双字节基因型编码, 适用于可变等位基因数 [16, 255], 采用 2 bytes 储存基因型 [类型魔术编码][AC][AN][genotype num][基因型 2 bytes per genotype][基因型 2 bytes per genotype]...
EBEG Enumerated BEG 枚举的字节编码, 定义为某种基因型占据了 RBEG_THRESHOLD 及以上的情况, 也包含了仅有一种基因型的情况 由于扫描基因型需要遍历、储存计数信息, 我们主要考虑这三种情况: 0/0, 1/1, ./.
MBEG 最简基因型字节编码, 适用于可变等位基因数为 2, 采用组合编码存储基因型 [类型魔术编码][AC][AN][genotype num][基因型 3 or 4 genotypes per byte][基因型 3 or 4 genotypes per byte]...
NBEG None BEG 无基因型占位编码 (genotype num == 0) [类型魔术编码]

方法概要

限定符和类型	方法和说明
static int	getAC(edu.sysu.pmglab.container.ByteCode encodedSequence) 快速获取 AC
static float	getAF(edu.sysu.pmglab.container.ByteCode encodedSequence) 快速获取 AF
static int	getAN(edu.sysu.pmglab.container.ByteCode encodedSequence) 快速获取 AN
static int	getGenotypeNum(edu.sysu.pmglab.container.ByteCode encodedSequence) 快速获取 基因型个数 (序列长度)
byte	getMagicCode(boolean phased) 获取该编码类型的魔术编码
edu.sysu.pmglab.container.ByteCode	getMagicSequence(boolean phased, int AC, int AN, int genotypeNum) 获取该编码类型的魔术序列
static boolean	isPhased(byte magicCode) 根据魔术编码获取向型 (第一个位是否为 1)
static EncodeType	of(byte magicCode) 根据魔术编码获取编码类型 (第2-7位的值)
static EncodeType	valueOf(java.lang.String name) 返回带有指定名称的该类型的枚举常量。
static EncodeType[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

NBEG

public static final EncodeType NBEG

None BEG 无基因型占位编码 (genotype num == 0) [类型魔术编码]

EBEG

public static final EncodeType EBEG

Enumerated BEG 枚举的字节编码, 定义为某种基因型占据了 RBEG_THRESHOLD 及以上的情况, 也包含了仅有一种基因型的情况 由于扫描基因型需要遍历、储存计数信息, 我们主要考虑这三种情况: 0/0, 1/1, ./. [类型魔术编码][AC][AN][genotype num][主要基因型][次要基因型1:索引1,索引2,索引3]...

MBEG

public static final EncodeType MBEG

最简基因型字节编码, 适用于可变等位基因数为 2, 采用组合编码存储基因型 [类型魔术编码][AC][AN][genotype num][基因型 3 or 4 genotypes per byte][基因型 3 or 4 genotypes per byte]...

BEG

public static final EncodeType BEG

单字节编码, 适用于可变等位基因数 [3, 15], 采用 1 byte 储存基因型 [类型魔术编码][AC][AN][genotype num][基因型 1 byte per genotype][基因型 1 byte per genotype]...

DBEG

public static final EncodeType DBEG

双字节基因型编码, 适用于可变等位基因数 [16, 255], 采用 2 bytes 储存基因型 [类型魔术编码][AC][AN][genotype num][基因型 2 bytes per genotype][基因型 2 bytes per genotype]...

方法详细资料

values

public static EncodeType[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (EncodeType c : EncodeType.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static EncodeType valueOf(java.lang.String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

java.lang.NullPointerException - 如果参数为空值

getMagicCode

public byte getMagicCode(boolean phased)

获取该编码类型的魔术编码

参数:

phased - 基因型向型

返回:

魔术编码

getMagicSequence

public edu.sysu.pmglab.container.ByteCode getMagicSequence(boolean phased,
                                                           int AC,
                                                           int AN,
                                                           int genotypeNum)

获取该编码类型的魔术序列

参数:

phased - 基因型向型

AC - 等位基因数, 用于描述基因型序列摘要信息

AN - 有效等位基因总数, 用于描述基因型序列摘要信息

genotypeNum - 基因型序列长度

返回:

魔术序列

getAC

public static int getAC(edu.sysu.pmglab.container.ByteCode encodedSequence)

快速获取 AC

参数:

encodedSequence - 基因型编码序列

返回:

基因型编码流

getAN

public static int getAN(edu.sysu.pmglab.container.ByteCode encodedSequence)

快速获取 AN

参数:

encodedSequence - 基因型编码序列

返回:

基因型编码流

getGenotypeNum

public static int getGenotypeNum(edu.sysu.pmglab.container.ByteCode encodedSequence)

快速获取 基因型个数 (序列长度)

参数:

encodedSequence - 基因型编码序列

返回:

基因型编码流

getAF

public static float getAF(edu.sysu.pmglab.container.ByteCode encodedSequence)

快速获取 AF

参数:

encodedSequence - 基因型编码序列

返回:

基因型编码流

of

public static EncodeType of(byte magicCode)

根据魔术编码获取编码类型 (第2-7位的值)

参数:

magicCode - 魔术编码

返回:

编码类型

isPhased

public static boolean isPhased(byte magicCode)

根据魔术编码获取向型 (第一个位是否为 1)

参数:

magicCode - 魔术编码

返回:

向型