org.openimaj.image.analysis.algorithm.histogram

Class HistogramAnalyser

java.lang.Object

org.openimaj.image.analysis.algorithm.histogram.HistogramAnalyser

All Implemented Interfaces:

ImageAnalyser<FImage>

public class HistogramAnalyser
extends Object
implements ImageAnalyser<FImage>

An ImageAnalyser that processes an image and generates a Histogram.

You can get the histogram for an image like so:

        
 		FImage img = new FImage( ... );
 		HistogramProcessor hp = new HistogramProcessor( 64 );
 		img.analyse( hp );
 		Histogram h = hp.getHistogram();
 	
        

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

See Also:

Image.process(ImageProcessor)

Constructor Summary

Constructors

Constructor and Description
HistogramAnalyser(int nbins) Default constructor that builds a histogram processor that will create histograms with the given number of bins.

Method Summary

Modifier and Type	Method and Description
void	analyseImage(FImage image) Computes the Histogram for this image.
Histogram	getHistogram() Returns the histogram that was built having run the processing function.
static Histogram	getHistogram(FImage image, int nbins) Quickly create a histogram from an image.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramAnalyser

public HistogramAnalyser(int nbins)

Default constructor that builds a histogram processor that will create histograms with the given number of bins.

Parameters:

nbins - The number of bins.

Method Detail

analyseImage

public void analyseImage(FImage image)

Computes the Histogram for this image. The assumption is that the image has been normalised to the range 0..1. Values greater than 1 will be placed in the top bin.

Specified by:

analyseImage in interface ImageAnalyser<FImage>

Parameters:

image - The image from which to extract histogram

getHistogram

public Histogram getHistogram()

Returns the histogram that was built having run the processing function. This will return null if the processing has not yet been run.

Returns:

The Histogram that was built.

getHistogram

public static Histogram getHistogram(FImage image,
                                     int nbins)

Quickly create a histogram from an image.

Parameters:

image - the image

nbins - the number of bins per band

Returns:

a histogram