org.broadinstitute.hellbender.utils

Class Histogram

java.lang.Object

org.broadinstitute.hellbender.utils.Histogram

public class Histogram
extends java.lang.Object

Class used for storing a list of doubles as a run length encoded histogram that compresses the data into bins spaced at defined intervals.

Constructor Summary

Constructors

Constructor and Description
Histogram() Create an empty histogram object with a default bin size of 0.1
Histogram(java.lang.Double binSize) Create an empty histogram object with a with a specified bin size

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Double d) Add a value to be stored in the histogram
void	add(java.lang.Double d, int count) Add multiple copies of the same value into the histogram to be stored in the histogram
void	add(Histogram h) Combine two histogram objects that have the same bin by adding the values to each bin
java.lang.Integer	get(java.lang.Double d) Return the count of items in the bin corresponding to the provided value
boolean	isEmpty()
java.lang.Double	median()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Histogram

public Histogram()

Create an empty histogram object with a default bin size of 0.1

Histogram

public Histogram(java.lang.Double binSize)

Create an empty histogram object with a with a specified bin size

Parameters:

binSize - size of the bins to compress the data into

Method Detail

add

public void add(java.lang.Double d)

Add a value to be stored in the histogram

Parameters:

d - Data to be added to the histogram

add

public void add(java.lang.Double d,
                int count)

Add multiple copies of the same value into the histogram to be stored in the histogram

Parameters:

d - Data to be added to the histogram

count - number of repetitions of the value to add to the histogram

add

public void add(Histogram h)

Combine two histogram objects that have the same bin by adding the values to each bin

Parameters:

h - histogram to add

get

public java.lang.Integer get(java.lang.Double d)

Return the count of items in the bin corresponding to the provided value

Parameters:

d - Value to test

Returns:

Number of items in the bin mapped by the provided key

median

public java.lang.Double median()

Returns:

may be null if Histogram is empty

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isEmpty

public boolean isEmpty()

Returns:

true if there is no data in this histogram