RealBinMapper (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

HistogramBinMapper<T>
```
public class RealBinMapper<T extends RealType<T>>
extends Object
implements HistogramBinMapper<T>
```
A HistogramBinMapper over RealType, using arbitrary-width histogram bins.

Author:

2011 Larry Lindsey, Larry Lindsey

Constructor Summary

Constructors
Constructor and Description
`RealBinMapper(T minBin, T maxBin, int numBins)` Creates a RealBinMapper for a histogram with the given minimum bin center, maximum bin center, and number of bins.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getBinWidth()`
`T`	`getMaxBin()` Returns the maximum bin for the histogram.
`T`	`getMinBin()` Returns the minimum bin for the histogram.
`int`	`getNumBins()` Returns the number of bins for the histogram.
`T`	`invMap(int i)` Maps a given histogram bin index to a Type containing the bin center value.
`int`	`map(T type)` Maps a given Type to its histogram bin.

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

- Constructor Detail
  - RealBinMapper
```
public RealBinMapper(T minBin,
                     T maxBin,
                     int numBins)
```
    Creates a RealBinMapper for a histogram with the given minimum bin center, maximum bin center, and number of bins.
    
    Parameters:
    
    minBin - the minimal bin center.
    
    maxBin - the maximal bin center.
    
    numBins - the number of histogram bins to use.
- Method Detail
  - getMaxBin
```
public T getMaxBin()
```
    Description copied from interface: HistogramBinMapper
    
    Returns the maximum bin for the histogram. This value may not be relevant for histograms over Type's that do not have a natural order.
    
    Specified by:
    
    getMaxBin in interface HistogramBinMapper<T extends RealType<T>>
    
    Returns:
    
    the maximum bin Type for the histogram.
  - getMinBin
```
public T getMinBin()
```
    Description copied from interface: HistogramBinMapper
    
    Returns the minimum bin for the histogram. This value may not be relevant for histograms over Type's that do not have a natural order.
    
    Specified by:
    
    getMinBin in interface HistogramBinMapper<T extends RealType<T>>
    
    Returns:
    
    the minimum bin Type for the histogram.
  - getNumBins
```
public int getNumBins()
```
    Description copied from interface: HistogramBinMapper
    
    Returns the number of bins for the histogram.
    
    Specified by:
    
    getNumBins in interface HistogramBinMapper<T extends RealType<T>>
    
    Returns:
    
    the number of bins for the histogram.
  - invMap
```
public T invMap(int i)
```
    Description copied from interface: HistogramBinMapper
    
    Maps a given histogram bin index to a Type containing the bin center value.
    
    Specified by:
    
    invMap in interface HistogramBinMapper<T extends RealType<T>>
    
    Parameters:
    
    i - the histogram bin index to map.
    
    Returns:
    
    a Type containing the bin center value.
  - map
```
public int map(T type)
```
    Description copied from interface: HistogramBinMapper
    
    Maps a given Type to its histogram bin.
    
    Specified by:
    
    map in interface HistogramBinMapper<T extends RealType<T>>
    
    Parameters:
    
    type - the Type to map.
    
    Returns:
    
    the histogram bin index.
  - getBinWidth
```
public double getBinWidth()
```

Class RealBinMapper<T extends RealType<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RealBinMapper

Method Detail

getMaxBin

getMinBin

getNumBins

invMap

map

getBinWidth