HistogramBundle (ImageJ Common 2.1.0 API)

java.lang.Object
- net.imagej.widget.HistogramBundle

```
public class HistogramBundle
extends Object
```
HistogramBundles marry a list of Histogram1ds with addtional rendering information.

Author:

Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

HistogramBundle(Histogram1d<?> hist)

HistogramBundle(List<Histogram1d<?>> histList)

Constructors
Constructor and Description
`HistogramBundle(Histogram1d<?> hist)`
`HistogramBundle(List<Histogram1d<?>> histList)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getDataMax()` Gets the maximum value of the actual data range.
`double`	`getDataMin()` Gets the minimum value of the actual data range.
`Histogram1d<?>`	`getHistogram(int index)` Gets the histogram of interest for this HistogramBundle.
`int`	`getHistogramCount()` Returns the total number of histograms contained in this bundle.
`double`	`getLineIntercept()` Gets the line equation intercept.
`double`	`getLineSlope()` Gets the line equation slope.
`long`	`getMaxBin()` Gets the bin number of the maximum value.
`long`	`getMinBin()` Gets the bin number of the minimum value.
`int`	`getPreferredSizeX()` Gets the preferred X size of the widget for the rendering of this histogram.
`int`	`getPreferredSizeY()` Gets the preferred Y size of the widget for the rendering of this histogram.
`double`	`getTheoreticalMax()` Gets the maximum value of the desired range.
`double`	`getTheoreticalMin()` Gets the minimum value of the desired range.
`boolean`	`hasChanges()` Returns true if the bundle has been changed via use of some of the field setting api.
`void`	`setDataMinMax(double min, double max)` Sets the min/max values of the actual range.
`void`	`setHasChanges(boolean val)` Sets the changes flag.
`void`	`setHistogram(int index, Histogram1d<?> hist)` Sets the histogram of interest for this HistogramBundle.
`void`	`setLineSlopeIntercept(double slope, double intercept)` Sets the line equation for the slope line of a histogram.
`void`	`setMaxBin(long max)` Sets the bin number of the maximum value.
`void`	`setMinBin(long min)` Sets the bin number of the minimum value.
`void`	`setPreferredSize(int x, int y)` Sets the preferred size for the rendering of this histogram as a widget.
`void`	`setTheoreticalMinMax(double min, double max)` Sets the min/max values of the desired range.

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

- Constructor Detail
  - HistogramBundle
```
public HistogramBundle(Histogram1d<?> hist)
```
  - HistogramBundle
```
public HistogramBundle(List<Histogram1d<?>> histList)
```
- Method Detail
  - hasChanges
```
public boolean hasChanges()
```
    Returns true if the bundle has been changed via use of some of the field setting api. This information can be used by renderers to update their UI as appropriate. Note one can also force the change flag via setHasChanges().
  - setHasChanges
```
public void setHasChanges(boolean val)
```
    Sets the changes flag. Called by renderers after they have updated their UI to reflect previous changes.
  - getHistogramCount
```
public int getHistogramCount()
```
    Returns the total number of histograms contained in this bundle.
  - setHistogram
```
public void setHistogram(int index,
                         Histogram1d<?> hist)
```
    Sets the histogram of interest for this HistogramBundle.
  - getHistogram
```
public Histogram1d<?> getHistogram(int index)
```
    Gets the histogram of interest for this HistogramBundle.
  - setMinBin
```
public void setMinBin(long min)
```
    Sets the bin number of the minimum value. Can be used to by renderers to display the minimum line on the histogram for example. A value of -1 notes that the minimum value is not of interest.
  - getMinBin
```
public long getMinBin()
```
    Gets the bin number of the minimum value. A value of -1 notes the minimum value is not of interest.
  - setMaxBin
```
public void setMaxBin(long max)
```
    Sets the bin number of the maximum value. Can be used to by renderers to display the maximum line on the histogram for example. A value of -1 notes that the maximum value is not of interest.
  - getMaxBin
```
public long getMaxBin()
```
    Gets the bin number of the maximum value. A value of -1 notes the maximum value is not of interest.
  - setPreferredSize
```
public void setPreferredSize(int x,
                             int y)
```
    Sets the preferred size for the rendering of this histogram as a widget.
  - getPreferredSizeX
```
public int getPreferredSizeX()
```
    Gets the preferred X size of the widget for the rendering of this histogram.
  - getPreferredSizeY
```
public int getPreferredSizeY()
```
    Gets the preferred Y size of the widget for the rendering of this histogram.
  - setLineSlopeIntercept
```
public void setLineSlopeIntercept(double slope,
                                  double intercept)
```
    Sets the line equation for the slope line of a histogram.
  - getLineSlope
```
public double getLineSlope()
```
    Gets the line equation slope.
  - getLineIntercept
```
public double getLineIntercept()
```
    Gets the line equation intercept. The scale is 1.0 for whole height of the plot. This does NOT mean that value must be between 0 and 1. Intercepts can go outside range of table height.
  - setDataMinMax
```
public void setDataMinMax(double min,
                          double max)
```
    Sets the min/max values of the actual range.
  - getDataMin
```
public double getDataMin()
```
    Gets the minimum value of the actual data range.
  - getDataMax
```
public double getDataMax()
```
    Gets the maximum value of the actual data range.
  - setTheoreticalMinMax
```
public void setTheoreticalMinMax(double min,
                                 double max)
```
    Sets the min/max values of the desired range.
  - getTheoreticalMin
```
public double getTheoreticalMin()
```
    Gets the minimum value of the desired range.
  - getTheoreticalMax
```
public double getTheoreticalMax()
```
    Gets the maximum value of the desired range.

Class HistogramBundle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HistogramBundle

HistogramBundle

Method Detail

hasChanges

setHasChanges

getHistogramCount

setHistogram

getHistogram

setMinBin

getMinBin

setMaxBin

getMaxBin

setPreferredSize

getPreferredSizeX

getPreferredSizeY

setLineSlopeIntercept

getLineSlope

getLineIntercept

setDataMinMax

getDataMin

getDataMax

setTheoreticalMinMax

getTheoreticalMin

getTheoreticalMax