Histogram (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.algorithm.stats.Histogram<T>

All Implemented Interfaces:

Algorithm, Benchmark
```
public class Histogram<T>
extends Object
implements Algorithm, Benchmark
```
Implements a Histogram over an Image.

Author:

2011 Larry Lindsey, Larry Lindsey

Constructor Summary

Constructors
Constructor and Description
`Histogram(HistogramBinMapper<T> mapper, Img<T> image)` Create a Histogram using the given mapper, calculating from the given Image.
`Histogram(HistogramBinMapper<T> mapper, RealCursor<T> c)` Create a Histogram using the given mapper, calculating from the given Cursor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`int`	`getBin(int i)` Returns the bin count given by the indicated bin index.
`int`	`getBin(T t)` Returns the bin count corresponding to a given `Type`.
`T`	`getBinCenter(int i)` Creates and returns the a Type whose value corresponds to the center of the bin indexed by i.
`ArrayList<T>`	`getBinCenters()` Creates and returns a List containing Types that correspond to the centers of the histogram bins.
`HistogramBinMapper<T>`	`getBinMapper()` Returns this Histogram's HistogramBinMapper.
`String`	`getErrorMessage()`
`int[]`	`getHistogram()` Returns the histogram array.
`int`	`getNumBins()` Returns the number of bins in this Histogram.
`long`	`getProcessingTime()`
`boolean`	`process()`
`void`	`reset()` Resets the histogram array and the Cursor.

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

- Constructor Detail
  - Histogram
```
public Histogram(HistogramBinMapper<T> mapper,
                 RealCursor<T> c)
```
    Create a Histogram using the given mapper, calculating from the given Cursor.
    
    Parameters:
    
    mapper - the HistogramBinMapper used to map Type values to histogram bin indices.
    
    c - a Cursor corresponding to the Image from which the Histogram will be calculated
  - Histogram
```
public Histogram(HistogramBinMapper<T> mapper,
                 Img<T> image)
```
    Create a Histogram using the given mapper, calculating from the given Image.
    
    Parameters:
    
    mapper - the HistogramBinMapper used to map Type values to histogram bin indices.
    
    image - an Image from which the Histogram will be calculated
- Method Detail
  - reset
```
public void reset()
```
    Resets the histogram array and the Cursor.
  - getBin
```
public int getBin(T t)
```
    Returns the bin count corresponding to a given Type.
    
    Parameters:
    
    t - the Type corresponding to the requested
    
    Returns:
    
    The requested bin count.
  - getBin
```
public int getBin(int i)
```
    Returns the bin count given by the indicated bin index.
    
    Parameters:
    
    i - the index of the requested bin
    
    Returns:
    
    the bin count at the given index
  - getBinMapper
```
public HistogramBinMapper<T> getBinMapper()
```
    Returns this Histogram's HistogramBinMapper.
    
    Returns:
    
    the HistogramBinMapper associated with this Histogram.
  - getHistogram
```
public int[] getHistogram()
```
    Returns the histogram array.
    
    Returns:
    
    the histogram array.
  - getBinCenter
```
public T getBinCenter(int i)
```
    Creates and returns the a Type whose value corresponds to the center of the bin indexed by i.
    
    Parameters:
    
    i - the requested bin index.
    
    Returns:
    
    a Type whose value corresponds to the requested bin center.
  - getBinCenters
```
public ArrayList<T> getBinCenters()
```
    Creates and returns a List containing Types that correspond to the centers of the histogram bins.
    
    Returns:
    
    a List containing Types that correspond to the centers of the histogram bins.
  - getNumBins
```
public int getNumBins()
```
    Returns the number of bins in this Histogram.
    
    Returns:
    
    the number of bins in this Histogram
  - checkInput
```
public boolean checkInput()
```
    Specified by:
    
    checkInput in interface Algorithm
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface Algorithm
  - process
```
public boolean process()
```
    Specified by:
    
    process in interface Algorithm
  - getProcessingTime
```
public long getProcessingTime()
```
    Specified by:
    
    getProcessingTime in interface Benchmark

Class Histogram<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Histogram

Histogram

Method Detail

reset

getBin

getBin

getBinMapper

getHistogram

getBinCenter

getBinCenters

getNumBins

checkInput

getErrorMessage

process

getProcessingTime