Package phase
Class Ibs2
- java.lang.Object
-
- phase.Ibs2
-
public final class Ibs2 extends java.lang.Object
Class
Ibs2
stores IBS2 segments that any target sample shares with another target or reference sample.Instances of
Ibs2
are immutable.
-
-
Constructor Summary
Constructors Constructor Description Ibs2(GT targGT, MarkerMap map, FloatArray maf)
Constructs a newIbs2
instance from the specified data.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
areIbs2(int targSample, int otherSample, int marker)
Returnstrue
if the specified target samples are estimated to be IBS2 at the specified marker or if(otherSample >= this.nTargSamples()
, and returnsfalse
otherwise.int
nMarkers()
Returns the number of markers.int
nTargSamples()
Returns the number of target samples.
-
-
-
Constructor Detail
-
Ibs2
public Ibs2(GT targGT, MarkerMap map, FloatArray maf)
Constructs a newIbs2
instance from the specified data.- Parameters:
targGT
- the target genotype datamap
- a list whosej
-th element is the genetic map position of thej
-th the markermaf
- a list whosej
-th element is the estimated minor allele frequency of thej
-th the marker- Throws:
java.lang.IllegalArgumentException
- iftargGT.nMarkers() != map.genPos().size()
java.lang.IllegalArgumentException
- iftargGT.nMarkers() != maf.size()
java.lang.NullPointerException
- if(targGT == null || map == null || maf == null)
-
-
Method Detail
-
nMarkers
public int nMarkers()
Returns the number of markers.- Returns:
- the number of markers
-
nTargSamples
public int nTargSamples()
Returns the number of target samples.- Returns:
- the number of target samples
-
areIbs2
public boolean areIbs2(int targSample, int otherSample, int marker)
Returnstrue
if the specified target samples are estimated to be IBS2 at the specified marker or if(otherSample >= this.nTargSamples()
, and returnsfalse
otherwise.- Parameters:
targSample
- a target sample indexotherSample
- a sample indexmarker
- a marker index- Returns:
true
if the specified samples are estimated to be IBD2 at the specified marker- Throws:
java.lang.IndexOutOfBoundsException
- if(targSample < 0 || targSample >= this.nTargSamples())
java.lang.IndexOutOfBoundsException
- if(otherSample < 0
java.lang.IndexOutOfBoundsException
- if(marker < 0 || marker >= this.nMarkers())
-
-