org.openimaj.image

Class Plotter<Q,I extends Image<Q,I>>

java.lang.Object

org.openimaj.image.Plotter<Q,I>

Type Parameters:

Q - The pixel type that is processed

I - The image type that is processed

public class Plotter<Q,I extends Image<Q,I>>
extends Object

A simple 2d plotter

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected I	image
protected Q	penColour
protected Pixel	penPosition
protected int	penThickness
protected ImageRenderer<Q,I>	renderer

Constructor Summary

Constructors

Constructor and Description
Plotter(I image) Construct a plotter that writes to the given image.
Plotter(I image, Q colour) Construct a plotter that writes to the given image with the given initial pen colour.
Plotter(I image, Q colour, int thickness) Construct a plotter that writes to the given image.

Method Summary

Modifier and Type	Method and Description
I	getImage()
Q	getPenColour()
Pixel	getPenPosition()
int	getPenThickness()
void	lineTo(int x, int y) Draw a line from the current position to a point
void	lineTo(Pixel p) Draw a line from the current position to a pixel
void	moveTo(int x, int y) Move to a point
void	moveTo(Pixel p) Move to a pixel
void	setImage(I image)
void	setPenColour(Q penColour)
void	setPenPosition(Pixel penPosition)
void	setPenThickness(int penThickness)

Methods inherited from class java.lang.Object

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

Field Detail

penPosition

protected Pixel penPosition

penColour

protected Q penColour

penThickness

protected int penThickness

image

protected I extends Image<Q,I> image

renderer

protected ImageRenderer<Q,I extends Image<Q,I>> renderer

Constructor Detail

Plotter

public Plotter(I image)

Construct a plotter that writes to the given image. The pen colour is set to the value of the pixel at (0,0) and the pen thickness is set to 1.

Parameters:

image - the image

Plotter

public Plotter(I image,
               Q colour)

Construct a plotter that writes to the given image with the given initial pen colour. The pen thickness is set to 1.

Parameters:

image - the image

colour - the pen colour

Plotter

public Plotter(I image,
               Q colour,
               int thickness)

Construct a plotter that writes to the given image.

Parameters:

image - the image

colour - the pen colour

thickness - the pen thickness

Method Detail

moveTo

public void moveTo(Pixel p)

Move to a pixel

Parameters:

p - the pixel

moveTo

public void moveTo(int x,
                   int y)

Move to a point

Parameters:

x - x-position

y - y-position

lineTo

public void lineTo(Pixel p)

Draw a line from the current position to a pixel

Parameters:

p - the pixel to draw to

lineTo

public void lineTo(int x,
                   int y)

Draw a line from the current position to a point

Parameters:

x - the x position

y - the y position

getPenPosition

public Pixel getPenPosition()

Returns:

the penPosition

setPenPosition

public void setPenPosition(Pixel penPosition)

Parameters:

penPosition - the penPosition to set

getPenColour

public Q getPenColour()

Returns:

the penColour

setPenColour

public void setPenColour(Q penColour)

Parameters:

penColour - the penColour to set

getPenThickness

public int getPenThickness()

Returns:

the penThickness

setPenThickness

public void setPenThickness(int penThickness)

Parameters:

penThickness - the penThickness to set

getImage

public I getImage()

Returns:

the image

setImage

public void setImage(I image)

Parameters:

image - the image to set