public final class BitSetGT extends java.lang.Object implements VcfEmission
Class BitSetGT represents genotype emission
probabilities for a list of samples at a single marker.
The genotype emission probabilities are determined by the called
genotypes for the samples.
Class BitSetGT stores alleles using
java.util.BitSet objects.
Instances of class BitSetGT are immutable.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
GT_FORMAT
The VCF FORMAT code for genotype data: "GT".
|
| Constructor and Description |
|---|
BitSetGT(VcfHeader vcfHeader,
java.lang.String vcfRecord)
Constructs a new
BitSetGT instance representing
the specified VCF record's GT format field data. |
| Modifier and Type | Method and Description |
|---|---|
int |
allele(int hap)
Returns the allele on the specified haplotype or -1 if the
allele is missing.
|
int |
allele1(int sample)
Returns the first allele for the specified sample or -1 if the
allele is missing.
|
int |
allele2(int sample)
Returns the second allele for the specified sample or -1 if the
allele is missing.
|
int |
alleleCount(int allele)
Returns the number of haplotypes that carry the specified allele.
|
float |
gl(int sample,
int a1,
int a2)
Returns the probability of the observed data if the specified pair
of ordered alleles is the true genotype in the specified sample.
|
int |
hapIndex(int allele,
int copy)
Returns index of the haplotype that carries the specified copy of the
specified allele.
|
boolean |
isPhased(int sample)
Returns
true if the genotype emission probabilities for
the specified sample are determined by a phased, nonmissing genotype,
and returns false otherwise. |
boolean |
isRefData()
Returns
true if the genotype emission probabilities
for each sample are determined by a phased called genotype
that has no missing alleles, and returns false otherwise. |
int |
majorAllele()
Returns the index of the major allele.
|
Marker |
marker()
Returns the marker.
|
int |
nAlleles()
Returns the number of marker alleles.
|
int |
nHapPairs()
Returns the number of haplotype pairs.
|
int |
nHaps()
Returns the number of haplotypes.
|
int |
nSamples()
Returns the number of samples.
|
Samples |
samples()
Returns the list of samples.
|
boolean |
storesNonMajorIndices()
Returns
true if this instance stores the indices of haplotypes
that carry non-major alleles, and returns false otherwise. |
java.lang.String |
toString()
Returns the data represented by
this as a VCF
record with a GT format field. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waittoVcfRecpublic static final java.lang.String GT_FORMAT
public BitSetGT(VcfHeader vcfHeader, java.lang.String vcfRecord)
BitSetGT instance representing
the specified VCF record's GT format field data.vcfHeader - meta-information lines and header line for the
specified VCF record.vcfRecord - a VCF record corresponding to the specified
vcfHeader objectjava.lang.IllegalArgumentException - if a format error is detected
in the VCF recordjava.lang.IllegalArgumentException - if rec.nSamples() == 0java.lang.IllegalArgumentException - if the header line
or VCF record does not have a "GT" format fieldjava.lang.NullPointerException - if
vcfHeader == null || vcfRecord == nullpublic int nSamples()
VcfEmissionnSamples in interface VcfEmissionpublic Samples samples()
VcfEmissionsamples in interface VcfEmissionpublic int nHaps()
HapsMarker2*this.nHapPairs().nHaps in interface HapsMarkerpublic int nHapPairs()
HapsMarkerthis.nHaps()/2.nHapPairs in interface HapsMarkerpublic Marker marker()
HapsMarkermarker in interface HapsMarkermarker in interface MarkerContainerpublic boolean isRefData()
VcfEmissiontrue if the genotype emission probabilities
for each sample are determined by a phased called genotype
that has no missing alleles, and returns false otherwise.isRefData in interface VcfEmissiontrue if the genotype emission probabilities
for each sample are determined by a phased called genotype
that has no missing allelespublic boolean isPhased(int sample)
VcfEmissiontrue if the genotype emission probabilities for
the specified sample are determined by a phased, nonmissing genotype,
and returns false otherwise.isPhased in interface VcfEmissionsample - the sample indextrue if the genotype emission probabilities
for the specified sample are determined by a phased, nonmissing genotypepublic int allele1(int sample)
VcfEmissionallele1 in interface HapsMarkerallele1 in interface VcfEmissionsample - the sample indexpublic int allele2(int sample)
VcfEmissionallele2 in interface HapsMarkerallele2 in interface VcfEmissionsample - the sample indexpublic int allele(int hap)
VcfEmissionallele in interface HapsMarkerallele in interface VcfEmissionhap - the haplotype indexpublic float gl(int sample,
int a1,
int a2)
VcfEmissiongl in interface VcfEmissionsample - the sample indexa1 - the first allele indexa2 - the second allele indexpublic int nAlleles()
VcfEmissionnAlleles in interface VcfEmissionpublic boolean storesNonMajorIndices()
VcfEmissiontrue if this instance stores the indices of haplotypes
that carry non-major alleles, and returns false otherwise.storesNonMajorIndices in interface VcfEmissiontrue if this instance stores the indices of haplotypes
that carry non-major alleles, and returns false otherwisepublic int majorAllele()
VcfEmissionmajorAllele in interface VcfEmissionpublic int alleleCount(int allele)
VcfEmissionalleleCount in interface VcfEmissionallele - an allele indexpublic int hapIndex(int allele,
int copy)
VcfEmissionhapIndex in interface VcfEmissionallele - an allele indexcopy - a copy indexpublic java.lang.String toString()
this as a VCF
record with a GT format field. The returned VCF record
will have missing QUAL and INFO fields, will have "PASS"
in the filter field, and will have a GT format field.toString in class java.lang.Objectthis as a VCF
record with a GT format field