HistogramReweightedData

java.lang.Object
- etomica.data.histogram.HistogramReweightedData

All Implemented Interfaces:

Histogram, java.io.Serializable
```
public class HistogramReweightedData
extends java.lang.Object
implements Histogram, java.io.Serializable
```
Histogram implementation with a static x range and number of bins for reweighted data. If an x value is given that falls outside the histogram's x range, the value is dropped. The x range and number of bins can be changed explicitly, but doing so will reset the histogram (losing all previously collected data). e.g. sum [x * w]/ sum [ w ] x : measurements w : weight

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected double`	`deltaX`
`protected double[]`	`histogram`
`protected int`	`nBins`
`protected double[]`	`sums`
`protected double`	`weightSum`
`protected double`	`xMax`
`protected double`	`xMin`
`protected double[]`	`xValues`

Constructor Summary

Constructors
Constructor	Description
`HistogramReweightedData(int n, DoubleRange xRange)`	Makes a new histogram instance, with the range of x values given by xRange and n bins.
`HistogramReweightedData(DoubleRange xRange)`	Makes a new histogram instance, with the range of x values given by xRange.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addValue(double x)`	Adds the given value to the Histogram
`void`	`addValue(double x, double y)`
`long`	`getCount()`	Returns the number of times the Histogram's addValue method was called.
`double[]`	`getHistogram()`	Returns the histogram as an array of doubles
`int`	`getNBins()`	Returns the number of bins in the histogram.
`DoubleRange`	`getXRange()`	Returns the range of x values (min and max) used in the histogram.
`void`	`reset()`	resets all histogram values and counts to zero
`void`	`setNBins(int n)`	Sets the number of bins used by the Histogram.
`void`	`setXRange(DoubleRange xRange)`	Sets the range of x values used in the histogram (min and max).
`double[]`	`xValues()`	Returns the x values from the histogram as an array of doubles

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - deltaX
```
protected double deltaX
```
  - weightSum
```
protected double weightSum
```
  - sums
```
protected double[] sums
```
  - histogram
```
protected double[] histogram
```
  - xValues
```
protected double[] xValues
```
  - xMin
```
protected double xMin
```
  - xMax
```
protected double xMax
```
  - nBins
```
protected int nBins
```
- Constructor Detail
  - HistogramReweightedData
```
public HistogramReweightedData(DoubleRange xRange)
```
    Makes a new histogram instance, with the range of x values given by xRange.
  - HistogramReweightedData
```
public HistogramReweightedData(int n,
                               DoubleRange xRange)
```
    Makes a new histogram instance, with the range of x values given by xRange and n bins.
- Method Detail
  - reset
```
public void reset()
```
    Description copied from interface: Histogram
    
    resets all histogram values and counts to zero
    
    Specified by:
    
    reset in interface Histogram
  - addValue
```
public void addValue(double x,
                     double y)
```
  - addValue
```
public void addValue(double x)
```
    Description copied from interface: Histogram
    
    Adds the given value to the Histogram
    
    Specified by:
    
    addValue in interface Histogram
  - setXRange
```
public void setXRange(DoubleRange xRange)
```
    Description copied from interface: Histogram
    
    Sets the range of x values used in the histogram (min and max). The existing histogram may be dropped or redistributed to the new bins.
    
    Specified by:
    
    setXRange in interface Histogram
  - getXRange
```
public DoubleRange getXRange()
```
    Description copied from interface: Histogram
    
    Returns the range of x values (min and max) used in the histogram.
    
    Specified by:
    
    getXRange in interface Histogram
  - getNBins
```
public int getNBins()
```
    Description copied from interface: Histogram
    
    Returns the number of bins in the histogram.
    
    Specified by:
    
    getNBins in interface Histogram
  - setNBins
```
public void setNBins(int n)
```
    Description copied from interface: Histogram
    
    Sets the number of bins used by the Histogram. The existing histogram may be dropped or redistributed to the new bins.
    
    Specified by:
    
    setNBins in interface Histogram
  - getHistogram
```
public double[] getHistogram()
```
    Description copied from interface: Histogram
    
    Returns the histogram as an array of doubles
    
    Specified by:
    
    getHistogram in interface Histogram
  - getCount
```
public long getCount()
```
    Description copied from interface: Histogram
    
    Returns the number of times the Histogram's addValue method was called.
    
    Specified by:
    
    getCount in interface Histogram
  - xValues
```
public double[] xValues()
```
    Description copied from interface: Histogram
    
    Returns the x values from the histogram as an array of doubles
    
    Specified by:
    
    xValues in interface Histogram

Class HistogramReweightedData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

deltaX

weightSum

sums

histogram

xValues

xMin

xMax

nBins

Constructor Detail

HistogramReweightedData

HistogramReweightedData

Method Detail

reset

addValue

addValue

setXRange

getXRange

getNBins

setNBins

getHistogram

getCount

xValues