org.openimaj.image.analysis.pyramid

Class SimplePyramid<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>

java.lang.Object

org.openimaj.image.analysis.pyramid.SimplePyramid<IMAGE>

Type Parameters:

IMAGE - the underlying image type

All Implemented Interfaces:

Iterable<IMAGE>, ImageAnalyser<IMAGE>, ImageProcessor<IMAGE>, Processor<IMAGE>

public class SimplePyramid<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>
extends Object
implements ImageAnalyser<IMAGE>, ImageProcessor<IMAGE>, Iterable<IMAGE>

A simple image pyramid built as a stack of images. For convenience, when applied to an image as an ImageProcessor, the last level of the pyramid will be assigned to the input image. SimplePyramids also allow you to specify a processor that is applied between levels. For example, a Gaussian blur could be applied to make a Gaussian pyramid. SimplePyramids are @link{Iterable}, so you can iterate over the levels.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
IMAGE[]	pyramid The images forming the pyramid

Constructor Summary

Constructors

Constructor and Description
SimplePyramid(float power) Construct a pyramid with the given scale factor.
SimplePyramid(float power, int nlevels) Construct a pyramid with the given scale factor and number of levels.
SimplePyramid(float power, int nlevels, Processor<IMAGE> processor) Construct a pyramid with the given scale factor and number of levels.
SimplePyramid(float power, Processor<IMAGE> processor) Construct a pyramid with the given scale factor.

Method Summary

Methods

Modifier and Type	Method and Description
void	analyseImage(IMAGE image) Analyse an image.
protected int	computeLevels(int size) compute the number of levels such that the minimum size is at least 8.
static <T extends Image<?,T> & SinglebandImageProcessor.Processable<Float,FImage,T>> SimplePyramid<T>	createGaussianPyramid(T image, float sigma, int nLevels) Convenience method to create a gaussian pyramid from an image.
Iterator<IMAGE>	iterator()
void	processImage(IMAGE image) Process an image.

Methods inherited from class java.lang.Object

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

Field Detail

pyramid

public IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>[] pyramid

The images forming the pyramid

Constructor Detail

SimplePyramid

public SimplePyramid(float power)

Construct a pyramid with the given scale factor. The number of levels is such that the lowest level of the pyramid is a minimum of 8 pixels on its shortest side.

Parameters:

power - scale factor between levels

SimplePyramid

public SimplePyramid(float power,
             int nlevels)

Construct a pyramid with the given scale factor and number of levels. If the number of levels is zero or less, then the actual number of levels will be calculated dynamically so the shortest side of the bottom level has at least 8 pixels.

Parameters:

power - scale factor between levels

nlevels - number of levels

SimplePyramid

public SimplePyramid(float power,
             Processor<IMAGE> processor)

Construct a pyramid with the given scale factor. The number of levels is such that the lowest level of the pyramid is a minimum of 8 pixels on its shortest side. The processor will be applied before subsampling occurs.

Parameters:

power - scale factor between levels

processor - a processor to apply before subsampling

SimplePyramid

public SimplePyramid(float power,
             int nlevels,
             Processor<IMAGE> processor)

Construct a pyramid with the given scale factor and number of levels. If the number of levels is zero or less, then the actual number of levels will be calculated dynamically so the shortest side of the bottom level has at least 8 pixels. The processor will be applied before subsampling occurs.

Parameters:

power - scale factor between levels

nlevels - number of levels

processor - a processor to apply before subsampling

Method Detail

computeLevels

protected int computeLevels(int size)

compute the number of levels such that the minimum size is at least 8.

Parameters:

size - size

Returns:

number of levels

analyseImage

public void analyseImage(IMAGE image)

Description copied from interface: ImageAnalyser

Analyse an image.

Specified by:

analyseImage in interface ImageAnalyser<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>

Parameters:

image - The image to process in place.

processImage

public void processImage(IMAGE image)

Description copied from interface: ImageProcessor

Process an image. Implementing classes must alter the image passed in-place or assign the output to the input using Image.internalAssign(Image).

Specified by:

processImage in interface ImageProcessor<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>

Parameters:

image - The image to process in place.

iterator

public Iterator<IMAGE> iterator()

Specified by:

iterator in interface Iterable<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>

createGaussianPyramid

public static <T extends Image<?,T> & SinglebandImageProcessor.Processable<Float,FImage,T>> SimplePyramid<T> createGaussianPyramid(T image,
                                                                                                                  float sigma,
                                                                                                                  int nLevels)

Convenience method to create a gaussian pyramid from an image. There is a fixed number of levels with powers of two between levels.

Type Parameters:

T - The type of image

Parameters:

image - the image

sigma - the amount of blurring

nLevels - the number of levels

Returns:

the pyramid