mpicbg.imglib.algorithm.histogram.discrete

Class DiscreteIntHistogramBinFactory<T extends IntegerType<T>>

java.lang.Object

mpicbg.imglib.algorithm.histogram.discrete.DiscreteIntHistogramBinFactory<T>

Type Parameters:

T - the type of Type corresponding to this factory, implementing IntegerType.

All Implemented Interfaces:

HistogramBinFactory<T>

public class DiscreteIntHistogramBinFactory<T extends IntegerType<T>>
extends Object
implements HistogramBinFactory<T>

A HistogramBinFactory to be used to create a discrete Histogram over integer-valued Type's.

Author:

Larry Lindsey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscreteIntHistogramBinFactory.DiscreteIntHistogramBin

Constructor Summary

Constructors

Constructor and Description
DiscreteIntHistogramBinFactory()

Method Summary

Modifier and Type	Method and Description
HistogramBin<T>	createBin(T type) Create a HistogramBin corresponding to the give Type, in the sense that for the purposes of the Histogram class, the given Type would be binned into the returned HistogramBin.
HistogramKey<T>	createKey(T type) Create a HistogramKey to be used for a HashTable, to key a HistogramBin.
boolean	equivalent(T type1, T type2) Determines whether two Types are equivalent in the sense that they would be binned into the same HistogramBin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscreteIntHistogramBinFactory

public DiscreteIntHistogramBinFactory()

Method Detail

createBin

public HistogramBin<T> createBin(T type)

Description copied from interface: HistogramBinFactory

Create a HistogramBin corresponding to the give Type, in the sense that for the purposes of the Histogram class, the given Type would be binned into the returned HistogramBin.

Specified by:

createBin in interface HistogramBinFactory<T extends IntegerType<T>>

Parameters:

type - the prototype Type used to create the HistogramBin

Returns:

a HistogramBin, into which the given type would be binned.

createKey

public HistogramKey<T> createKey(T type)

Description copied from interface: HistogramBinFactory

Create a HistogramKey to be used for a HashTable, to key a HistogramBin.

Specified by:

createKey in interface HistogramBinFactory<T extends IntegerType<T>>

Parameters:

type - the Type to which the generated HistogramKey will correspond.

Returns:

A HistogramKey corresponding to the given Type.

equivalent

public boolean equivalent(T type1,
                          T type2)

Description copied from interface: HistogramBinFactory

Determines whether two Types are equivalent in the sense that they would be binned into the same HistogramBin.

Specified by:

equivalent in interface HistogramBinFactory<T extends IntegerType<T>>

Parameters:

type1 - the first Type for comparison

type2 - the second Type for comparison

Returns:

true, if the the types in question are equivalent, generally meaning that the values that they contain would be placed into the same histogram bin, and false otherwise.