Package vcf
Class SplicedGT
- java.lang.Object
-
- vcf.SplicedGT
-
- All Implemented Interfaces:
GT
public final class SplicedGT extends java.lang.Object implements GT
Class
SplicedGTrepresents genotype emission probabilities for a set of samples. The genotype emission probabilities are determined by aRefGTWindowinstance for the initial markers, and are determined by aGTinstance for the remaining markers. TheisPhased()andisPhased(sample)methods of theSplicedGTclass return the same values as the corresponding methods of theGTinstance.Instances of class
SplicedGTare immutable.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intallele(int marker, int hap)Returns the allele on the specified haplotype for the specified marker or return -1 if the allele is missing.intallele1(int marker, int sample)Returns the first allele for the specified marker and sample or return -1 if the allele is missing.intallele2(int marker, int sample)Returns the second allele for the specified marker and sample or return -1 if the allele is missing.floatgl(int marker, int sample, int allele1, int allele2)Returns the probability of the observed data for the specified marker and sample if the specified pair of ordered alleles is the true ordered genotype.booleanisGTData()Returnstrueif the value returned bythis.gl()is determined by a called or missing genotype, and returnsfalseotherwise.booleanisPhased()Returnstrueif the genotype for each marker and sample is a phased, non-missing genotype, and returnsfalseotherwise.booleanisPhased(int sample)Returnstrueif the genotype for each marker for the specified sample is a phased, nonmissing genotype, and returnsfalseotherwise.booleanisPhased(int marker, int sample)Returnstrueif the genotype for the specified marker and sample is a phased, nonmissing genotype, and returnsfalseotherwise.Markermarker(int marker)Returns the specified marker.Markersmarkers()Returns the list of markers.intnHaps()Returns the number of haplotypes.intnMarkers()Returns the number of markers.intnSamples()Returns the number of samples.Samplessamples()Returns the list of samples.java.lang.StringtoString()
-
-
-
Constructor Detail
-
SplicedGT
public SplicedGT(GT phasedOverlap, GT gt)
Constructs a newSplicedGLinstance.- Parameters:
phasedOverlap- sample haplotype pairs for the initial markersgt- genotype emission probabilities for all markers- Throws:
java.lang.IllegalArgumentException- ifphasedOverlaps.nMarkers() >= gt.nMarkers()java.lang.IllegalArgumentException- ifphasedOverlaps.marker(j).equals(gt.marker(j)) == falsefor anyjsatisfying0 <= j && j < phasedOverlaps.nMarkers()java.lang.IllegalArgumentException- ifphasedOverlaps.samples().equals(gt.samples()) == falsejava.lang.IllegalArgumentException- ifphasedOverlap.isPhased() == falsejava.lang.NullPointerException- ifphasedOverlap == null || gt == null
-
-
Method Detail
-
isPhased
public boolean isPhased()
Description copied from interface:GTReturnstrueif the genotype for each marker and sample is a phased, non-missing genotype, and returnsfalseotherwise.
-
isGTData
public boolean isGTData()
Description copied from interface:GTReturnstrueif the value returned bythis.gl()is determined by a called or missing genotype, and returnsfalseotherwise.
-
isPhased
public boolean isPhased(int sample)
Description copied from interface:GTReturnstrueif the genotype for each marker for the specified sample is a phased, nonmissing genotype, and returnsfalseotherwise.
-
gl
public float gl(int marker, int sample, int allele1, int allele2)Description copied from interface:GTReturns the probability of the observed data for the specified marker and sample if the specified pair of ordered alleles is the true ordered genotype.- Specified by:
glin interfaceGT- Parameters:
marker- the marker indexsample- the sample indexallele1- the first allele indexallele2- the second allele index- Returns:
- the probability of the observed data for the specified marker and sample if the specified pair of ordered alleles is the true ordered genotype
-
isPhased
public boolean isPhased(int marker, int sample)Description copied from interface:GTReturnstrueif the genotype for the specified marker and sample is a phased, nonmissing genotype, and returnsfalseotherwise.
-
allele1
public int allele1(int marker, int sample)Description copied from interface:GTReturns the first allele for the specified marker and sample or return -1 if the allele is missing. The two alleles for a sample are arbitrarily ordered ifthis.unphased(marker, sample) == false.
-
allele2
public int allele2(int marker, int sample)Description copied from interface:GTReturns the second allele for the specified marker and sample or return -1 if the allele is missing. The two alleles for a sample are arbitrarily ordered ifthis.unphased(marker, sample) == false.
-
allele
public int allele(int marker, int hap)Description copied from interface:GTReturns the allele on the specified haplotype for the specified marker or return -1 if the allele is missing. The two alleles for an individual are arbitrarily ordered ifthis.unphased(marker, hap/2) == false.
-
marker
public Marker marker(int marker)
Description copied from interface:GTReturns the specified marker.
-
nMarkers
public int nMarkers()
Description copied from interface:GTReturns the number of markers.
-
nHaps
public int nHaps()
Description copied from interface:GTReturns the number of haplotypes. The returned value is equal to2*this.nSamples().
-
nSamples
public int nSamples()
Description copied from interface:GTReturns the number of samples.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-