net.sourceforge.jiu.color.analysis

Class Histogram3DCreator


public class Histogram3DCreator
extends Operation

This class creates three-dimensional histograms for images with integer samples. Only IntegerImage is supported. Existing histogram objects can be given to this operation to be reused.

Note: Before JIU 0.10.0 there was a single HistogramCreator class.

Author:
Marco Schmidt
Since:
0.10.0

Field Summary

private Histogram3D
hist
private IntegerImage
image
private int
index1
private int
index2
private int
index3
private boolean
naive

Fields inherited from class net.sourceforge.jiu.ops.Operation

abort, progressListeners

Method Summary

static Integer
count(IntegerImage image)
Static convenience method to count the number of colors in any three channel IntegerImage object.
private void
createHistogramIfNecessary()
Histogram3D
getHistogram()
Returns the histogram initialized in this operation.
void
process()
void
setHistogram3D(Histogram3D histogram)
Sets the histogram object to be reused for this operation.
void
setImage(IntegerImage newImage)
The image for which a histogram will be initialized.
void
setImage(IntegerImage newImage, int channelIndex1, int channelIndex2, int channelIndex3)
The image for which a histogram will be initialized.

Methods inherited from class net.sourceforge.jiu.ops.Operation

addProgressListener, addProgressListeners, getAbort, process, removeProgressListener, setAbort, setProgress, setProgress

Field Details

hist

private Histogram3D hist

image

private IntegerImage image

index1

private int index1

index2

private int index2

index3

private int index3

naive

private boolean naive

Method Details

count

public static Integer count(IntegerImage image)
Static convenience method to count the number of colors in any three channel IntegerImage object.
Parameters:
image - the IntegerImage whose number of used colors is to be determined
Returns:
the number of colors or null on failure (image does not have three channels, etc.)
Since:
0.15.0

createHistogramIfNecessary

private void createHistogramIfNecessary()

getHistogram

public Histogram3D getHistogram()
Returns the histogram initialized in this operation.

process

public void process()
            throws MissingParameterException,
                   WrongParameterException
Overrides:
process in interface Operation

setHistogram3D

public void setHistogram3D(Histogram3D histogram)
Sets the histogram object to be reused for this operation. If this method is not called, a new histogram will be created.
Parameters:
histogram - the histogram object to be used in this operation

setImage

public void setImage(IntegerImage newImage)
The image for which a histogram will be initialized. Simply calls setImage(IntegerImage,int,int,int) with 0, 1 and 2 as parameters.
Parameters:
newImage - the image for the histogram initialization

setImage

public void setImage(IntegerImage newImage,
                     int channelIndex1,
                     int channelIndex2,
                     int channelIndex3)
The image for which a histogram will be initialized. Simply calls setImage(IntegerImage,int,int,int) with 0, 1 and 2 as parameters.
Parameters:
newImage -