org.broadinstitute.hellbender.utils.mcmc

Class PosteriorSummary

java.lang.Object

org.broadinstitute.hellbender.utils.mcmc.PosteriorSummary

All Implemented Interfaces:

java.io.Serializable

public final class PosteriorSummary
extends java.lang.Object
implements java.io.Serializable

Represents central tendency and upper/lower credible-interval bounds of the posterior of a univariate model parameter, along with optional deciles.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PosteriorSummary(double center, double lower, double upper) Constructs a PosteriorSummary with only given central tendency and upper/lower credible-interval bounds.

Method Summary

Modifier and Type	Method and Description
double	getCenter()
DecileCollection	getDeciles() Gets the DecileCollection if it was set previously by setDeciles(DecileCollection).
double	getLower()
double	getUpper()
void	setDeciles(DecileCollection deciles)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PosteriorSummary

public PosteriorSummary(double center,
                        double lower,
                        double upper)

Constructs a PosteriorSummary with only given central tendency and upper/lower credible-interval bounds.

Parameters:

center - central tendency

lower - lower credible-interval bound

upper - upper credible-interval bound

Method Detail

getCenter

public double getCenter()

getLower

public double getLower()

getUpper

public double getUpper()

getDeciles

public DecileCollection getDeciles()

Gets the DecileCollection if it was set previously by setDeciles(DecileCollection).

Throws:

java.lang.IllegalStateException - if deciles were not set previously

setDeciles

public void setDeciles(DecileCollection deciles)