org.openimaj.image.pixel.util

Class LineIterators

java.lang.Object

org.openimaj.image.pixel.util.LineIterators

public class LineIterators
extends Object

Iterators for producing discrete pixel positions along a line.

Author:

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

Constructor Summary

Constructors

Constructor and Description
LineIterators()

Method Summary

Modifier and Type	Method and Description
static Iterator<Pixel>	bresenham(int x0, int y0, float fdx, float fdy) Pixel iterator based on Bresenham's algorithm for a line starting at a given point, with an angle given by the provided x and y deltas.
static Iterator<Pixel>	bresenham(int x0, int y0, int x1, int y1) Pixel iterator based on Bresenham's algorithm for a line between two discrete endpoints.
static Iterator<Pixel>	bresenham(Pixel start, Pixel end) Pixel iterator based on Bresenham's algorithm for a line between two discrete endpoints.
static Iterator<Pixel>	supercover(int x1, int y1, int x2, int y2) Generate the pixels for the supercover of the line between two points.
static List<Pixel>	supercoverAsList(int x1, int y1, int x2, int y2) Generate the pixels for the supercover of the line between two points.
static List<Pixel>	supercoverAsList(Pixel start, Pixel end) Generate the pixels for the supercover of the line between two points.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineIterators

public LineIterators()

Method Detail

bresenham

public static Iterator<Pixel> bresenham(Pixel start,
                                        Pixel end)

Pixel iterator based on Bresenham's algorithm for a line between two discrete endpoints. The pixel returned by the iterator will always be the same object for efficiency; if you need to hold on to it, you should clone it first.

Parameters:

start - the coordinate of the start point

end - the coordinate of the end point

Returns:

an iterator over the pixels in the line

bresenham

public static Iterator<Pixel> bresenham(int x0,
                                        int y0,
                                        int x1,
                                        int y1)

Pixel iterator based on Bresenham's algorithm for a line between two discrete endpoints. The pixel returned by the iterator will always be the same object for efficiency; if you need to hold on to it, you should clone it first.

Parameters:

x0 - the x-ordinate of the start point

y0 - the y-ordinate of the start point

x1 - the x-ordinate of the end point

y1 - the y-ordinate of the end point

Returns:

an iterator over the pixels in the line

bresenham

public static Iterator<Pixel> bresenham(int x0,
                                        int y0,
                                        float fdx,
                                        float fdy)

Pixel iterator based on Bresenham's algorithm for a line starting at a given point, with an angle given by the provided x and y deltas. The pixel returned by the iterator will always be the same object for efficiency; if you need to hold on to it, you should clone it first. Note: The returned iterator is infinite; that is it won't ever end.

Parameters:

x0 - the x-ordinate of the start point

y0 - the y-ordinate of the start point

fdx - the x-gradient

fdy - the y-gradient

Returns:

an iterator over the pixels in the line

supercover

public static Iterator<Pixel> supercover(int x1,
                                         int y1,
                                         int x2,
                                         int y2)

Generate the pixels for the supercover of the line between two points. Based directly on code from Eugen Dedu.

Parameters:

x1 - the x-ordinate of the start point

y1 - the y-ordinate of the start point

x2 - the x-ordinate of the end point

y2 - the y-ordinate of the end point

Returns:

the iterator of pixels representing the supercover line

See Also:

"http://lifc.univ-fcomte.fr/~dedu/projects/bresenham/index.html"

supercoverAsList

public static List<Pixel> supercoverAsList(int x1,
                                           int y1,
                                           int x2,
                                           int y2)

Generate the pixels for the supercover of the line between two points. Based directly on code from Eugen Dedu.

Parameters:

x1 - the x-ordinate of the start point

y1 - the y-ordinate of the start point

x2 - the x-ordinate of the end point

y2 - the y-ordinate of the end point

Returns:

the list of pixels representing the supercover line

See Also:

"http://lifc.univ-fcomte.fr/~dedu/projects/bresenham/index.html"

supercoverAsList

public static List<Pixel> supercoverAsList(Pixel start,
                                           Pixel end)

Generate the pixels for the supercover of the line between two points. Based directly on code from Eugen Dedu.

Parameters:

start - the coordinate of the start point

end - the coordinate of the end point

Returns:

the list of pixels representing the supercover line

See Also:

"http://lifc.univ-fcomte.fr/~dedu/projects/bresenham/index.html"