net.imglib2.algorithm.stats

Class IntBinMapper<T extends net.imglib2.type.numeric.IntegerType<T>>

java.lang.Object

net.imglib2.algorithm.stats.IntBinMapper<T>

All Implemented Interfaces:

HistogramBinMapper<T>

public class IntBinMapper<T extends net.imglib2.type.numeric.IntegerType<T>>
extends Object
implements HistogramBinMapper<T>

A HistogramBinMapper over IntegerTypes, using the values themselves as the histogram bin centers.

Author:

2011 Larry Lindsey, Larry Lindsey

Constructor Summary

Constructors

Constructor and Description
IntBinMapper(T type) Create an IntBinMapper with minimum and maximum bin centers corresponding to the minimal and maximal Type values.
IntBinMapper(T min, T max) Create an IntBinMapper with the given minimum and maximum bins.

Method Summary

Modifier and Type	Method and Description
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

IntBinMapper

public IntBinMapper(T min,
                    T max)

Create an IntBinMapper with the given minimum and maximum bins.

Parameters:

min - the minimum bin center.

max - the maximum bin center.

IntBinMapper

public IntBinMapper(T type)

Create an IntBinMapper with minimum and maximum bin centers corresponding to the minimal and maximal Type values.

Parameters:

type - a representative Type object.

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 net.imglib2.type.numeric.IntegerType<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 net.imglib2.type.numeric.IntegerType<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 net.imglib2.type.numeric.IntegerType<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 net.imglib2.type.numeric.IntegerType<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 net.imglib2.type.numeric.IntegerType<T>>

Parameters:

type - the Type to map.

Returns:

the histogram bin index.