net.sourceforge.jiu.color.data

Interface Histogram1D

Known Implementing Classes:
ArrayHistogram1D

public interface Histogram1D

An interface for a one-dimensional histogram.
Author:
Marco Schmidt
See Also:
Histogram3D

Method Summary

void
clear()
Sets all counters to zero.
int
getEntry(int index)
Returns the counter value for the given index.
int
getMaxValue()
Returns the maximum allowed index.
int
getNumUsedEntries()
Returns the number of used entries (those entries with a counter value larger than zero).
void
increaseEntry(int index)
Increases the counter value of the given index by one.
void
setEntry(int index, int newValue)
Sets one counter to a new value.

Method Details

clear

public void clear()
Sets all counters to zero.

getEntry

public int getEntry(int index)
Returns the counter value for the given index.
Parameters:
index - the zero-based index of the desired counter value
Returns:
the counter value

getMaxValue

public int getMaxValue()
Returns the maximum allowed index. The minimum is always 0.
Returns:
the maximum index value

getNumUsedEntries

public int getNumUsedEntries()
Returns the number of used entries (those entries with a counter value larger than zero).
Returns:
number of non-zero counter values

increaseEntry

public void increaseEntry(int index)
Increases the counter value of the given index by one. Same semantics as setEntry(index, getEntry(index) + 1);
Parameters:
index - index into the histogram

setEntry

public void setEntry(int index,
                     int newValue)
Sets one counter to a new value.
Parameters:
index - index of the counter to be changed
newValue - new value for that counter