org.diirt.graphene

Class GraphBuffer

java.lang.Object

org.diirt.graphene.GraphBuffer

public class GraphBuffer
extends Object

Provides low level drawing operations, at the right granularity to perform them efficiently, but without performing any high level decisions (e.g. formatting, layout)

This class takes care of putting the pixels where it is told. It specifically does not concerns itself with the calculation of what/where to draw. It provides the drawing of aggregated data structures, so that the plotting can be efficient and clean.

It also serves as a wrapper around Java2D (Graphics2D) so that the drawing can be re-implemented efficiently on other engines in the future, such as JavaFX.

Author:

carcassi, sjdallst, asbarber, jkfeng

Constructor Summary

Constructors

Constructor and Description
GraphBuffer(Graph2DRenderer<?> renderer) Creates a GraphBuffer suitable for the given renderer.
GraphBuffer(int width, int height) Creates a GraphBuffer with the given width and height.

Method Summary

Modifier and Type	Method and Description
void	drawDataImage(int xStartPoint, int yStartPoint, int[] xPointToDataMap, int[] yPointToDataMap, Cell2DDataset data, NumberColorMapInstance colorMap) Plots a two dimensional array of values encoded by color.
void	drawValueExplicitLine(Point2DDataset data, InterpolationScheme interpolation, ReductionScheme reduction, ProcessValue pv)
void	drawValueLine(ListNumber xValues, ListNumber yValues, InterpolationScheme interpolation, ProcessValue pv)
Graphics2D	getGraphicsContext() Temporary method to retrieve the graphics context.
BufferedImage	getImage() Temporary method to retrieve the image buffer.
void	setPixel(int x, int y, int color) Changes the pixel at the given coordinates to the given color.
void	setXScaleAsCell(Range range, int xMinPixel, int xMaxPixel, ValueScale xValueScale) Sets the scaling data for the x axis assuming values are going to represent cells.
void	setXScaleAsPoint(Range range, int xMinPixel, int xMaxPixel, ValueScale xValueScale) Sets the scaling data for the x axis assuming values are going to represent points.
void	setYScaleAsCell(Range range, int yMinPixel, int yMaxPixel, ValueScale yValueScale) Sets the scaling data for the y axis assuming values are going to represent cells.
void	setYScaleAsPoint(Range range, int yMinPixel, int yMaxPixel, ValueScale yValueScale) Sets the scaling data for the y axis assuming values are going to represent points.
double	xPixelCenterToValue(int pixelValue) Converts the center of given pixel position to the actual value.
double	xPixelLeftToValue(int pixelValue) Converts the left side of given pixel position to the actual value.
double	xPixelRightToValue(int pixelValue) Converts the right side of given pixel position to the actual value.
int	xValueToPixel(double value) Converts the given value to the pixel position.
double	yPixelBottomToValue(int pixelValue) Converts the bottom side of given pixel position to the actual value.
double	yPixelCenterToValue(int pixelValue) Converts the center of given pixel position to the actual value.
double	yPixelTopToValue(int pixelValue) Converts the top side of given pixel position to the actual value.
int	yValueToPixel(double value) Converts the given value to the pixel position.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphBuffer

public GraphBuffer(int width,
                   int height)

Creates a GraphBuffer with the given width and height.

Parameters:

width - width of the graph

height - height of the graph

GraphBuffer

public GraphBuffer(Graph2DRenderer<?> renderer)

Creates a GraphBuffer suitable for the given renderer. Makes sure all the parameters from the renderer are consistent with the buffer itself.

Parameters:

renderer - the graph renderer

Method Detail

setPixel

public void setPixel(int x,
                     int y,
                     int color)

Changes the pixel at the given coordinates to the given color. TODO: make sure all other plotting functions use this.

Parameters:

x - x-coordinate of a pixel

y - y-coordinate of a pixel

color - color-value of the pixel

getImage

public BufferedImage getImage()

Temporary method to retrieve the image buffer. Will be removed once this class is finished.

Returns:

the rendering buffer

getGraphicsContext

public Graphics2D getGraphicsContext()

Temporary method to retrieve the graphics context. Will be removed once this class is finished.

Returns:

the graphics context

drawDataImage

public void drawDataImage(int xStartPoint,
                          int yStartPoint,
                          int[] xPointToDataMap,
                          int[] yPointToDataMap,
                          Cell2DDataset data,
                          NumberColorMapInstance colorMap)

Plots a two dimensional array of values encoded by color.

Parameters:

xStartPoint - the horizontal coordinate for the first pixel of the image

yStartPoint - the vertical coordinate for the first pixel of the image

xPointToDataMap - a map from pixel horizontal offset to data index

yPointToDataMap - a map from pixel vertical offset to data index

data - the dataset to be plotted

colorMap - the color map

setXScaleAsCell

public void setXScaleAsCell(Range range,
                            int xMinPixel,
                            int xMaxPixel,
                            ValueScale xValueScale)

Sets the scaling data for the x axis assuming values are going to represent cells. The minimum value is going to be positioned at the left of the xMinPixel while the maximum value is going to be position at the right of the xMaxPixel.

Parameters:

range - the range to be displayed

xMinPixel - the pixel corresponding to the minimum

xMaxPixel - the pixel corresponding to the maximum

xValueScale - the scale used to transform values to pixel

setXScaleAsPoint

public void setXScaleAsPoint(Range range,
                             int xMinPixel,
                             int xMaxPixel,
                             ValueScale xValueScale)

Sets the scaling data for the x axis assuming values are going to represent points. The minimum value is going to be positioned in the center of the xMinPixel while the maximum value is going to be position in the middle of the xMaxPixel.

Parameters:

range - the range to be displayed

xMinPixel - the pixel corresponding to the minimum

xMaxPixel - the pixel corresponding to the maximum

xValueScale - the scale used to transform values to pixel

xValueToPixel

public int xValueToPixel(double value)

Converts the given value to the pixel position.

Parameters:

value - the value

Returns:

the pixel where the value should be mapped

xPixelLeftToValue

public double xPixelLeftToValue(int pixelValue)

Converts the left side of given pixel position to the actual value.

Parameters:

pixelValue - the pixel

Returns:

the value at the pixel

xPixelRightToValue

public double xPixelRightToValue(int pixelValue)

Converts the right side of given pixel position to the actual value.

Parameters:

pixelValue - the pixel

Returns:

the value at the pixel

xPixelCenterToValue

public double xPixelCenterToValue(int pixelValue)

Converts the center of given pixel position to the actual value.

Parameters:

pixelValue - the pixel

Returns:

the value at the pixel

setYScaleAsCell

public void setYScaleAsCell(Range range,
                            int yMinPixel,
                            int yMaxPixel,
                            ValueScale yValueScale)

Sets the scaling data for the y axis assuming values are going to represent cells. The minimum value is going to be positioned at the bottom of the yMinPixel while the maximum value is going to be position at the top of the yMaxPixel.

Parameters:

range - the range to be displayed

yMinPixel - the pixel corresponding to the minimum

yMaxPixel - the pixel corresponding to the maximum

yValueScale - the scale used to transform values to pixel

setYScaleAsPoint

public void setYScaleAsPoint(Range range,
                             int yMinPixel,
                             int yMaxPixel,
                             ValueScale yValueScale)

Sets the scaling data for the y axis assuming values are going to represent points. The minimum value is going to be positioned in the center of the yMinPixel while the maximum value is going to be position in the center of the yMaxPixel.

Parameters:

range - the range to be displayed

yMinPixel - the pixel corresponding to the minimum

yMaxPixel - the pixel corresponding to the maximum

yValueScale - the scale used to transform values to pixel

yValueToPixel

public int yValueToPixel(double value)

Converts the given value to the pixel position.

Parameters:

value - the value

Returns:

the pixel where the value should be mapped

yPixelTopToValue

public double yPixelTopToValue(int pixelValue)

Converts the top side of given pixel position to the actual value.

Parameters:

pixelValue - the pixel

Returns:

the value at the pixel

yPixelCenterToValue

public double yPixelCenterToValue(int pixelValue)

Converts the center of given pixel position to the actual value.

Parameters:

pixelValue - the pixel

Returns:

the value at the pixel

yPixelBottomToValue

public double yPixelBottomToValue(int pixelValue)

Converts the bottom side of given pixel position to the actual value.

Parameters:

pixelValue - the pixel

Returns:

the value at the pixel

drawValueLine

public void drawValueLine(ListNumber xValues,
                          ListNumber yValues,
                          InterpolationScheme interpolation,
                          ProcessValue pv)

drawValueExplicitLine

public void drawValueExplicitLine(Point2DDataset data,
                                  InterpolationScheme interpolation,
                                  ReductionScheme reduction,
                                  ProcessValue pv)