Histogram (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.algorithm.histogram.Histogram<T>

All Implemented Interfaces:

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

Author:

Larry Lindsey

Constructor Summary

Constructors
Constructor and Description

Histogram(HistogramBinFactory<T> factory, Cursor<T> c)
Create a Histogram using the given factory, calculating from the given Cursor.

Constructors
Constructor and Description
`Histogram(HistogramBinFactory<T> factory, Cursor<T> c)` Create a Histogram using the given factory, calculating from the given Cursor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkInput()`
`HistogramBin<T>`	`getBin(HistogramKey<T> key)` Returns the bin corresponding to a given `HistogramKey`.
`HistogramBin<T>`	`getBin(T t)` Returns the bin corresponding to a given `Type`.
`String`	`getErrorMessage()`
`ArrayList<HistogramKey<T>>`	`getKeys()` Returns an ArrayList containing the `HistogramKey`s generated when calculating this Histogram.
`ArrayList<T>`	`getKeyTypes()` Returns the center `Type` corresponding to each `HistogramKey` generated when calculating this Histogram.
`long`	`getProcessingTime()`
`boolean`	`process()`

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

- Constructor Detail
  - Histogram
```
public Histogram(HistogramBinFactory<T> factory,
                 Cursor<T> c)
```
    Create a Histogram using the given factory, calculating from the given Cursor.
    
    Parameters:
    
    factory - the HistogramBinFactory used to generate HistogramKeys and HistogramBins
    
    c - a Cursor corresponding to the Image from which the Histogram will be calculated
- Method Detail
  - getKeys
```
public ArrayList<HistogramKey<T>> getKeys()
```
    Returns an ArrayList containing the HistogramKeys generated when calculating this Histogram.
    
    Returns:
    
    an ArrayList containing the HistogramKeys generated when calculating this Histogram.
  - getKeyTypes
```
public ArrayList<T> getKeyTypes()
```
    Returns the center Type corresponding to each HistogramKey generated when calculating this Histogram.
    
    Returns:
  - getBin
```
public HistogramBin<T> getBin(T t)
```
    Returns the bin corresponding to a given Type.
    
    Parameters:
    
    t - the Type corresponding to the requested HistogramBin
    
    Returns:
    
    The requested HistogramBin.
  - getBin
```
public HistogramBin<T> getBin(HistogramKey<T> key)
```
    Returns the bin corresponding to a given HistogramKey.
    
    Parameters:
    
    key - the HistogramKey corresponding to the requested HistogramBin
    
    Returns:
    
    The requested HistogramBin.
  - 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 extends Type<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Histogram

Method Detail

getKeys

getKeyTypes

getBin

getBin

checkInput

getErrorMessage

process

getProcessingTime