org.openimaj.image.pixel.sampling

Class RectangleSampler

java.lang.Object

org.openimaj.image.pixel.sampling.RectangleSampler

All Implemented Interfaces:

Iterable<Rectangle>

public class RectangleSampler
extends Object
implements Iterable<Rectangle>

A RectangleSampler provides an easy way to generate a sliding window of rectangle over an image or other domain.

Author:

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

Constructor Summary

Constructors

Constructor and Description
RectangleSampler(float minx, float maxx, float miny, float maxy, float stepx, float stepy, float width, float height) Construct the sampler with the given parameters
RectangleSampler(Image<?,?> img, float stepx, float stepy, float width, float height) Construct the sampler with the given parameters
RectangleSampler(Rectangle bounds, float stepx, float stepy, float width, float height) Construct the sampler with the given parameters

Method Summary

Modifier and Type	Method and Description
List<Rectangle>	allRectangles() Get a list of all the rectangles that can be produced by this sampler
Iterator<Rectangle>	iterator()
void	setBounds(float minx, float maxx, float miny, float maxy) Adjust the bounds of the sampler
void	setBounds(Image<?,?> img) Adjust the bounds of the sampler
void	setBounds(Rectangle r) Adjust the bounds of the sampler
<I extends Image<?,I>> Iterator<I>	subImageIterator(I image) Create an iterator to extract sub-images from an image based on the rectangles defined by this sampler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RectangleSampler

public RectangleSampler(float minx,
                        float maxx,
                        float miny,
                        float maxy,
                        float stepx,
                        float stepy,
                        float width,
                        float height)

Construct the sampler with the given parameters

Parameters:

minx - starting x-ordinate

maxx - finishing x-ordinate

miny - starting y-ordinate

maxy - finishing y-ordinate

stepx - step size in x direction

stepy - step size in y direction

width - width of sample window

height - height of sample window

RectangleSampler

public RectangleSampler(Rectangle bounds,
                        float stepx,
                        float stepy,
                        float width,
                        float height)

Construct the sampler with the given parameters

Parameters:

bounds - the bounds in which the window must remain; it will start in the top-left corner

stepx - step size in x direction

stepy - step size in y direction

width - width of sample window

height - height of sample window

RectangleSampler

public RectangleSampler(Image<?,?> img,
                        float stepx,
                        float stepy,
                        float width,
                        float height)

Construct the sampler with the given parameters

Parameters:

img - the image from which to set the sampler bounds (will be set to the complete image)

stepx - step size in x direction

stepy - step size in y direction

width - width of sample window

height - height of sample window

Method Detail

setBounds

public void setBounds(float minx,
                      float maxx,
                      float miny,
                      float maxy)

Adjust the bounds of the sampler

Parameters:

minx - starting x-ordinate

maxx - finishing x-ordinate

miny - starting y-ordinate

maxy - finishing y-ordinate

setBounds

public void setBounds(Rectangle r)

Adjust the bounds of the sampler

Parameters:

r - the new bounds rectangle

setBounds

public void setBounds(Image<?,?> img)

Adjust the bounds of the sampler

Parameters:

img - the image to determine the bounds from

allRectangles

public List<Rectangle> allRectangles()

Get a list of all the rectangles that can be produced by this sampler

Returns:

all the rectangles

iterator

public Iterator<Rectangle> iterator()

Specified by:

iterator in interface Iterable<Rectangle>

subImageIterator

public <I extends Image<?,I>> Iterator<I> subImageIterator(I image)

Create an iterator to extract sub-images from an image based on the rectangles defined by this sampler.

Parameters:

image - the image to extract from

Returns:

an iterator over the extracted sub-images.