Package hec.chart

Class Histogram

java.lang.Object

hec.chart.Histogram

public class Histogram
extends Object

Copyright (C) 2014 Hydrologic Engineering Center, United States Army Corps of Engineers, All Rights Reserved HEC-Java NEXGEN Version 1.0beta

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTOMATIC
static final double	HUGE_DOUBLE
static final int	IRREGULAR
static final double	TINY_DOUBLE
static final double	UNDEFINED_DOUBLE
static final int	UNDEFINED_INT
static final int	UNIFORM

Constructor Summary

Constructors

Constructor	Description
Histogram(double[] x, double binSize)
Histogram(double[] x, double[] uBins)
Histogram(double[] x, double binSize, double xMin, double xMax)
Histogram(double[] x, int nbins)
Histogram(double[] x, int nbins, double xMin, double xMax)
Histogram(double[] X, int nbins, double binSize, double Xmin, double Xmax)
Histogram(double[] X, HistogramWeightProvider histWeightProvider, int nbins, double binSize, double xMin, double xMax)

Method Summary

Modifier and Type	Method	Description
static double[]	arange(double xmin, double xmax, double dx)
void	clearBins()
void	computeHistogram()
double	frequencyCheck()
double[]	getBinCenters()
double[]	getBinMaximums()
double[]	getBinMinimums()
double	getBinSize()
double[]	getCounts()
double[]	getCumlativeFrequencies()
double[]	getData()
double[]	getFrequencies()
int	getMethod()
int	getNumBins()
double	getPercentile(int rank)
double	getPlottingPercentile(int rankM, double A, double B)	Deprecated.
double	getPlottingPercentile(int rankM, hec.statistics.PlottingPositions plotPositions)
double[]	getSortedData()
boolean	isUniform(double[] bins)
int	length()
double	max()
double	max(double[] x)
double	mean()
double	min()
double	min(double[] x)
void	print()
void	print(boolean plotHist)
void	printArray(double[] x)
void	printSummaryStats()
double	range()
void	setBins()
void	setBins(double[] uBins)
void	setBinSize(double binSize)
void	setBinsOverrideMinAndMax(double[] uBins)
void	setNumBins(int nbins)
double	stdDev()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

TINY_DOUBLE

public static final double TINY_DOUBLE

See Also:

• Constant Field Values

HUGE_DOUBLE

public static final double HUGE_DOUBLE

See Also:

• Constant Field Values

AUTOMATIC

public static final int AUTOMATIC

See Also:

• Constant Field Values

UNIFORM

public static final int UNIFORM

See Also:

• Constant Field Values

IRREGULAR

public static final int IRREGULAR

See Also:

• Constant Field Values

UNDEFINED_DOUBLE

public static final double UNDEFINED_DOUBLE

See Also:

• Constant Field Values

UNDEFINED_INT

public static final int UNDEFINED_INT

See Also:

• Constant Field Values

Constructor Details

Histogram

public Histogram(double[] X,
 HistogramWeightProvider histWeightProvider,
 int nbins,
 double binSize,
 double xMin,
 double xMax)

Histogram

public Histogram(double[] X,
 int nbins,
 double binSize,
 double Xmin,
 double Xmax)

Histogram

public Histogram(double[] x,
 double[] uBins)

Histogram

public Histogram(double[] x,
 int nbins,
 double xMin,
 double xMax)

Histogram

public Histogram(double[] x,
 double binSize,
 double xMin,
 double xMax)

Histogram

public Histogram(double[] x,
 int nbins)

Histogram

public Histogram(double[] x,
 double binSize)

Method Details

isUniform

public boolean isUniform(double[] bins)

computeHistogram

public void computeHistogram()

max

public double max(double[] x)

min

public double min(double[] x)

length

public int length()

max

public double max()

min

public double min()

range

public double range()

mean

public double mean()

frequencyCheck

public double frequencyCheck()

stdDev

public double stdDev()

setBins

public void setBins()

setBins

public void setBins(double[] uBins)

setBinsOverrideMinAndMax

public void setBinsOverrideMinAndMax(double[] uBins)

getMethod

public int getMethod()

getData

public double[] getData()

getSortedData

public double[] getSortedData()

getBinMinimums

public double[] getBinMinimums()

getBinMaximums

public double[] getBinMaximums()

getBinCenters

public double[] getBinCenters()

getCounts

public double[] getCounts()

getFrequencies

public double[] getFrequencies()

getCumlativeFrequencies

public double[] getCumlativeFrequencies()

getNumBins

public int getNumBins()

getBinSize

public double getBinSize()

setNumBins

public void setNumBins(int nbins)

setBinSize

public void setBinSize(double binSize)

arange

public static double[] arange(double xmin,
 double xmax,
 double dx)

printArray

public void printArray(double[] x)

print

public void print(boolean plotHist)

print

public void print()

toString

public String toString()

Overrides:

toString in class Object

printSummaryStats

public void printSummaryStats()

getPercentile

public double getPercentile(int rank)

getPlottingPercentile

@Deprecated
public double getPlottingPercentile(int rankM,
 double A,
 double B)

Deprecated.

Use getPlottingPercentile(int rankM, PlottingPositions plotPositions) instead

Parameters:

rankM -

A -

B -

Returns:

getPlottingPercentile

public double getPlottingPercentile(int rankM,
 hec.statistics.PlottingPositions plotPositions)

clearBins

public void clearBins()