org.openimaj.image.renderer

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

java.lang.Object

org.openimaj.image.renderer.ImageRenderer<Q,I>

Type Parameters:

Q - Pixel type

I - Image type

Direct Known Subclasses:

FImageRenderer, MultiBandRenderer, SVGRenderer

public abstract class ImageRenderer<Q,I extends Image<Q,I>>
extends Object

ImageRenderer is the abstract base class for all renderers capable of drawing to images.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected RenderHints	hints
protected I	targetImage

Constructor Summary

Constructors

Constructor and Description
ImageRenderer(I targetImage) Construct with given target image.
ImageRenderer(I targetImage, RenderHints hints) Construct with given target image and rendering hints.

Method Summary

Modifier and Type	Method and Description
abstract Q	defaultBackgroundColour() Get the default foreground colour.
abstract Q	defaultForegroundColour() Get the default foreground colour.
void	drawConnectedPoints(List<? extends Point2d> pts, Q col) Draw onto this image lines drawn with the given colour between the points given.
Point2d[]	drawCubicBezier(Point2d p1, Point2d p2, Point2d c1, Point2d c2, int thickness, Q col) Draw a cubic Bezier curve into the image with 100 point accuracy.
protected abstract void	drawHorizLine(int x1, int x2, int y, Q col) Draw a horizontal line with the specified colour.
void	drawImage(I image, int x, int y) Draw into this image the provided image at the given coordinates.
void	drawImage(I image, int x, int y, Q... ignoreList) Draw into this image the provided image at the given coordinates ignoring certain pixels.
abstract void	drawLine(float x0, float y0, float x1, float y1, int thickness, Q col) Draw a line from the coordinates specified by (x0,y0) to the coordinates specified by (x1,y1) using the given color and thickness.
abstract void	drawLine(int x1, int y1, double theta, int length, int thickness, Q col) Draw a line from the coordinates specified by (x1,y1) at an angle of theta with the given length, thickness and colour.
void	drawLine(int x1, int y1, double theta, int length, Q col) Draw a line from the coordinates specified by (x1,y1) at an angle of theta with the given length and colour.
abstract void	drawLine(int x0, int y0, int x1, int y1, int thickness, Q col) Draw a line from the coordinates specified by (x0,y0) to the coordinates specified by (x1,y1) using the given color and thickness.
void	drawLine(int x0, int y0, int x1, int y1, Q col) Draw a line from the coordinates specified by (x0,y0) to (x1,y1) using the given colour.
void	drawLine(Path2d line, int thickness, Q col) Draw a line from the specified Path2d object
void	drawLine(Point2d p1, Point2d p2, int thickness, Q col) Draw a line from the coordinates specified by (x0,y0) to (x1,y1) using the given colour and thickness.
void	drawLine(Point2d p1, Point2d p2, Q col) Draw a line from the coordinates specified by (x0,y0) to (x1,y1) using the given colour.
void	drawLines(Iterable<? extends Path2d> lines, int thickness, Q col) Draw the given list of lines using drawLine(Path2d, int, Object) with the given colour and thickness.
void	drawPath(Path2d path, int thickness, Q col) Draw a path from the specified Path2d object
void	drawPaths(Iterable<? extends Path2d> paths, int thickness, Q col) Draw the given list of lines using drawLine(Path2d, int, Object) with the given colour and thickness.
abstract void	drawPoint(Point2d p, Q col, int size) Draw a dot centered on the given location (rounded to nearest integer location) at the given size and with the given color.
void	drawPoints(Iterable<? extends Point2d> pts, Q col, int size) Draw the given list of points using drawPoint(Point2d, Object, int) with the given colour and size.
abstract void	drawPolygon(Polygon p, int thickness, Q col) Draw the given polygon in the specified colour with the given thickness lines.
void	drawPolygon(Polygon p, Q col) Draw the given polygon in the specified colour.
void	drawPolygonFilled(Polygon p, Q col) Draw the given polygon, filled with the specified colour.
Point2d[]	drawQuadBezier(Point2d p1, Point2d p2, Point2d c1, int thickness, Q colour) Draw a Quadratic Bezier curve
void	drawShape(Shape s, int thickness, Q col) Draw the given shape in the specified colour with the given thickness lines.
void	drawShape(Shape p, Q col) Draw the given shape in the specified colour.
void	drawShapeFilled(Shape s, Q col) Draw the given shape, filled with the specified colour.
void	drawText(AttributedString text, int x, int y) Render the text using its attributes.
void	drawText(AttributedString text, Point2d pt) Render the text using its attributes.
<F extends Font<F>> void	drawText(String text, int x, int y, F f, int sz) Render the text in the given font with the default style.
<F extends Font<F>> void	drawText(String text, int x, int y, F f, int sz, Q col) Render the text in the given font in the given colour with the default style.
void	drawText(String text, int x, int y, FontStyle<Q> f) Render the text with the given FontStyle.
<F extends Font<F>> void	drawText(String text, Point2d pt, F f, int sz) Render the text in the given font with the default style.
<F extends Font<F>> void	drawText(String text, Point2d pt, F f, int sz, Q col) Render the text in the given font in the given colour with the default style.
void	drawText(String text, Point2d pt, FontStyle<Q> f) Render the text with the given FontStyle.
I	getImage() Get the target image
RenderHints	getRenderHints() Get the render hints object associated with this renderer
protected abstract Q	sanitise(Q colour) Sanitize the colour given to fit this image's pixel type.
void	setImage(I image) Change the target image of this renderer.
void	setRenderHints(RenderHints hints) Set the render hints associated with this renderer

Methods inherited from class java.lang.Object

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

Field Detail

hints

protected RenderHints hints

targetImage

protected I extends Image<Q,I> targetImage

Constructor Detail

ImageRenderer

public ImageRenderer(I targetImage)

Construct with given target image.

Parameters:

targetImage - the target image.

ImageRenderer

public ImageRenderer(I targetImage,
                     RenderHints hints)

Construct with given target image and rendering hints.

Parameters:

targetImage - the target image.

hints - the render hints

Method Detail

drawConnectedPoints

public void drawConnectedPoints(List<? extends Point2d> pts,
                                Q col)

Draw onto this image lines drawn with the given colour between the points given. No points are drawn.

Parameters:

pts - The point list to draw onto this image.

col - The colour to draw the lines

drawImage

public void drawImage(I image,
                      int x,
                      int y)

Draw into this image the provided image at the given coordinates. Parts of the image outside the bounds of this image will be ignored.

Parameters:

image - The image to draw.

x - The x-coordinate of the top-left of the image

y - The y-coordinate of the top-left of the image

drawImage

public void drawImage(I image,
                      int x,
                      int y,
                      Q... ignoreList)

Draw into this image the provided image at the given coordinates ignoring certain pixels. Parts of the image outside the bounds of this image will be ignored. Pixels in the ignore list will be stripped from the image to draw.

Parameters:

image - The image to draw.

x - The x-coordinate of the top-left of the image

y - The y-coordinate of the top-left of the image

ignoreList - The list of pixels to ignore when copying the image

drawLine

public abstract void drawLine(int x1,
                              int y1,
                              double theta,
                              int length,
                              int thickness,
                              Q col)

Draw a line from the coordinates specified by (x1,y1) at an angle of theta with the given length, thickness and colour.

Parameters:

x1 - The x-coordinate to start the line.

y1 - The y-coordinate to start the line.

theta - The angle at which to draw the line.

length - The length to draw the line.

thickness - The thickness to draw the line.

col - The colour to draw the line.

drawLine

public void drawLine(int x1,
                     int y1,
                     double theta,
                     int length,
                     Q col)

Draw a line from the coordinates specified by (x1,y1) at an angle of theta with the given length and colour. Line-thickness will be 1.

Parameters:

x1 - The x-coordinate to start the line.

y1 - The y-coordinate to start the line.

theta - The angle at which to draw the line.

length - The length to draw the line.

col - The colour to draw the line.

drawLine

public abstract void drawLine(int x0,
                              int y0,
                              int x1,
                              int y1,
                              int thickness,
                              Q col)

Draw a line from the coordinates specified by (x0,y0) to the coordinates specified by (x1,y1) using the given color and thickness.

Parameters:

x0 - The x-coordinate at the start of the line.

y0 - The y-coordinate at the start of the line.

x1 - The x-coordinate at the end of the line.

y1 - The y-coordinate at the end of the line.

thickness - The thickness which to draw the line.

col - The colour in which to draw the line.

drawLine

public abstract void drawLine(float x0,
                              float y0,
                              float x1,
                              float y1,
                              int thickness,
                              Q col)

Draw a line from the coordinates specified by (x0,y0) to the coordinates specified by (x1,y1) using the given color and thickness.

Parameters:

x0 - The x-coordinate at the start of the line.

y0 - The y-coordinate at the start of the line.

x1 - The x-coordinate at the end of the line.

y1 - The y-coordinate at the end of the line.

thickness - The thickness which to draw the line.

col - The colour in which to draw the line.

drawLine

public void drawLine(int x0,
                     int y0,
                     int x1,
                     int y1,
                     Q col)

Draw a line from the coordinates specified by (x0,y0) to (x1,y1) using the given colour. The line thickness will be 1 pixel.

Parameters:

x0 - The x-coordinate at the start of the line.

y0 - The y-coordinate at the start of the line.

x1 - The x-coordinate at the end of the line.

y1 - The y-coordinate at the end of the line.

col - The colour in which to draw the line.

drawLine

public void drawLine(Point2d p1,
                     Point2d p2,
                     Q col)

Draw a line from the coordinates specified by (x0,y0) to (x1,y1) using the given colour. The line thickness will be 1 pixel.

Parameters:

p1 - The coordinate of the start of the line.

p2 - The coordinate of the end of the line.

col - The colour in which to draw the line.

drawLine

public void drawLine(Point2d p1,
                     Point2d p2,
                     int thickness,
                     Q col)

Draw a line from the coordinates specified by (x0,y0) to (x1,y1) using the given colour and thickness.

Parameters:

p1 - The coordinate of the start of the line.

p2 - The coordinate of the end of the line.

thickness - the stroke width

col - The colour in which to draw the line.

drawLine

public void drawLine(Path2d line,
                     int thickness,
                     Q col)

Draw a line from the specified Path2d object

Parameters:

line - the line

thickness - the stroke width

col - The colour in which to draw the line.

drawPath

public void drawPath(Path2d path,
                     int thickness,
                     Q col)

Draw a path from the specified Path2d object

Parameters:

path - the path

thickness - the stroke width

col - The colour in which to draw the line.

drawLines

public void drawLines(Iterable<? extends Path2d> lines,
                      int thickness,
                      Q col)

Draw the given list of lines using drawLine(Path2d, int, Object) with the given colour and thickness.

Parameters:

lines - The list of lines to draw.

thickness - the stroke width

col - The colour to draw each point.

drawPaths

public void drawPaths(Iterable<? extends Path2d> paths,
                      int thickness,
                      Q col)

Draw the given list of lines using drawLine(Path2d, int, Object) with the given colour and thickness.

Parameters:

paths - The list of paths to draw.

thickness - the stroke width

col - The colour to draw each point.

drawPoint

public abstract void drawPoint(Point2d p,
                               Q col,
                               int size)

Draw a dot centered on the given location (rounded to nearest integer location) at the given size and with the given color.

Parameters:

p - The coordinates at which to draw the point

col - The colour to draw the point

size - The size at which to draw the point.

drawPoints

public void drawPoints(Iterable<? extends Point2d> pts,
                       Q col,
                       int size)

Draw the given list of points using drawPoint(Point2d, Object, int) with the given colour and size.

Parameters:

pts - The list of points to draw.

col - The colour to draw each point.

size - The size to draw each point.

drawPolygon

public abstract void drawPolygon(Polygon p,
                                 int thickness,
                                 Q col)

Draw the given polygon in the specified colour with the given thickness lines.

Parameters:

p - The polygon to draw.

thickness - The thickness of the lines to use

col - The colour to draw the lines in

drawPolygon

public void drawPolygon(Polygon p,
                        Q col)

Draw the given polygon in the specified colour. Uses drawPolygon(Polygon, int, Object) with line thickness 1.

Parameters:

p - The polygon to draw.

col - The colour to draw the polygon in.

drawHorizLine

protected abstract void drawHorizLine(int x1,
                                      int x2,
                                      int y,
                                      Q col)

Draw a horizontal line with the specified colour.

Parameters:

x1 - starting x (inclusive)

x2 - ending x (inclusive)

y - y

col - the colour

drawPolygonFilled

public void drawPolygonFilled(Polygon p,
                              Q col)

Draw the given polygon, filled with the specified colour.

Parameters:

p - The polygon to draw.

col - The colour to fill the polygon with.

drawShape

public void drawShape(Shape s,
                      int thickness,
                      Q col)

Draw the given shape in the specified colour with the given thickness lines.

Parameters:

s - The shape to draw.

thickness - The thickness of the lines to use

col - The colour to draw the lines in

drawShape

public void drawShape(Shape p,
                      Q col)

Draw the given shape in the specified colour. Uses drawPolygon(Polygon, int, Object) with line thickness 1.

Parameters:

p - The shape to draw.

col - The colour to draw the polygon in.

drawShapeFilled

public void drawShapeFilled(Shape s,
                            Q col)

Draw the given shape, filled with the specified colour.

Parameters:

s - The shape to draw.

col - The colour to fill the polygon with.

drawText

public <F extends Font<F>> void drawText(String text,
                                         int x,
                                         int y,
                                         F f,
                                         int sz)

Render the text in the given font with the default style.

Type Parameters:

F - the font

Parameters:

text - the text

x - the x-ordinate

y - the y-ordinate

f - the font

sz - the size

drawText

public <F extends Font<F>> void drawText(String text,
                                         int x,
                                         int y,
                                         F f,
                                         int sz,
                                         Q col)

Render the text in the given font in the given colour with the default style.

Type Parameters:

F - the font

Parameters:

text - the text

x - the x-ordinate

y - the y-ordinate

f - the font

sz - the size

col - the font color

drawText

public <F extends Font<F>> void drawText(String text,
                                         Point2d pt,
                                         F f,
                                         int sz)

Render the text in the given font with the default style.

Type Parameters:

F - the font

Parameters:

text - the text

pt - the coordinate to render at

f - the font

sz - the size

drawText

public <F extends Font<F>> void drawText(String text,
                                         Point2d pt,
                                         F f,
                                         int sz,
                                         Q col)

Render the text in the given font in the given colour with the default style.

Type Parameters:

F - the font

Parameters:

text - the text

pt - the coordinate to render at

f - the font

sz - the size

col - the font colour

drawText

public void drawText(String text,
                     int x,
                     int y,
                     FontStyle<Q> f)

Render the text with the given FontStyle.

Parameters:

text - the text

x - the x-ordinate

y - the y-ordinate

f - the font style

drawText

public void drawText(String text,
                     Point2d pt,
                     FontStyle<Q> f)

Render the text with the given FontStyle.

Parameters:

text - the text

pt - the coordinate to render at

f - the font style

drawText

public void drawText(AttributedString text,
                     int x,
                     int y)

Render the text using its attributes.

Parameters:

text - the text

x - the x-ordinate

y - the y-ordinate

drawText

public void drawText(AttributedString text,
                     Point2d pt)

Render the text using its attributes.

Parameters:

text - the text

pt - the coordinate to render at

drawCubicBezier

public Point2d[] drawCubicBezier(Point2d p1,
                                 Point2d p2,
                                 Point2d c1,
                                 Point2d c2,
                                 int thickness,
                                 Q col)

Draw a cubic Bezier curve into the image with 100 point accuracy.

Parameters:

p1 - One end point of the line

p2 - The other end point of the line

c1 - The control point associated with p1

c2 - The control point associated with p2

thickness - The thickness to draw the line

col - The colour to draw the line

Returns:

The points along the bezier curve

drawQuadBezier

public Point2d[] drawQuadBezier(Point2d p1,
                                Point2d p2,
                                Point2d c1,
                                int thickness,
                                Q colour)

Draw a Quadratic Bezier curve

Parameters:

p1 -

p2 -

c1 -

thickness -

colour -

Returns:

a set of points on the curve

defaultForegroundColour

public abstract Q defaultForegroundColour()

Get the default foreground colour.

Returns:

the default foreground colour.

defaultBackgroundColour

public abstract Q defaultBackgroundColour()

Get the default foreground colour.

Returns:

the default foreground colour.

getImage

public I getImage()

Get the target image

Returns:

the image

setImage

public void setImage(I image)

Change the target image of this renderer.

Parameters:

image - new target

getRenderHints

public RenderHints getRenderHints()

Get the render hints object associated with this renderer

Returns:

the render hints

setRenderHints

public void setRenderHints(RenderHints hints)

Set the render hints associated with this renderer

Parameters:

hints - the new hints

sanitise

protected abstract Q sanitise(Q colour)

Sanitize the colour given to fit this image's pixel type.

Parameters:

size - The colour to sanitize

Returns:

The array