mpicbg.imglib.algorithm.histogram

Class HistogramKey<T extends Type<T>>

java.lang.Object

mpicbg.imglib.algorithm.histogram.HistogramKey<T>

Type Parameters:

T - the type of Type that this HistogramKey pertains to.

public class HistogramKey<T extends Type<T>>
extends Object

HistogramKeys are used by Histogram to key HistogramBins into a HashTable.

Author:

Larry Lindsey

Constructor Summary

Constructors

Constructor and Description
HistogramKey(int hc, T t, HistogramBinFactory<T> factory) Create a HistogramKey with hash code hc, representative t, and HistogramBinFactory factory.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determines whether this HistogramKey is equal to the given Object.
T	getType()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramKey

public HistogramKey(int hc,
                    T t,
                    HistogramBinFactory<T> factory)

Create a HistogramKey with hash code hc, representative t, and HistogramBinFactory factory.

Parameters:

hc - the hash code to be returned by this HistogramKey's hashCode().

t - the representative Type. Preferably, this should be the center Type of the HistogramBin to be keyed, but it only need be one that would be binned into that bin.

factory - the HistogramBinFactory corresponding to this key. Typically, this should be the HistogramBinFactory that generated this key.

See Also:

Object.hashCode()

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Determines whether this HistogramKey is equal to the given Object. This HistogramKey is equal to o iff o is also a HistogramKey, and HistogramBinFactory.equivalent(Type, Type) returns true when called with this HistogramKey's representative type and the one corresponding to o.

Overrides:

equals in class Object

Parameters:

o - the Object against which to check for equality.

Returns:

true if this HistogramKey is equal to o.

getType

public T getType()