Package phase
Class Ibs2Sets
- java.lang.Object
-
- phase.Ibs2Sets
-
public final class Ibs2Sets extends java.lang.Object
Class
Ibs2Sets
partitions markers into steps, and stores the sets of samples whose genotypes are consistent with IBS2 in each step.Instances of
Ibs2Sets
are immutable.
-
-
Constructor Summary
Constructors Constructor Description Ibs2Sets(GT targGT, Ibs2Markers ibs2Markers)
Constructs a newIbs2Sets
instance from the specified data.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
nTargSamples()
Returns the number of target samples.SampleSeg[]
segList(int sample)
Returns the detected IBS2 sample segments.
-
-
-
Constructor Detail
-
Ibs2Sets
public Ibs2Sets(GT targGT, Ibs2Markers ibs2Markers)
Constructs a newIbs2Sets
instance from the specified data.- Parameters:
targGT
- the target genotype dataibs2Markers
- the markers and intervals that are used to detect IBS2 segments- Throws:
java.lang.IllegalArgumentException
- iftargGT.nMarkers() != ibs2Markers.nMarkers()
java.lang.NullPointerException
- if(targGT == null || ibs2Markers == null)
-
-
Method Detail
-
nTargSamples
public int nTargSamples()
Returns the number of target samples.- Returns:
- the number of target samples
-
segList
public SampleSeg[] segList(int sample)
Returns the detected IBS2 sample segments.- Parameters:
sample
- a sample index- Returns:
- the detected IBS2 sample segments
- Throws:
java.lang.IndexOutOfBoundsException
- ifsample < 0 || sample >= this.nTargSamples()
-
-