org.openimaj.vis.general

Class AxisRenderer2D<Q>

java.lang.Object

org.openimaj.vis.general.AxisRenderer<Q>

org.openimaj.vis.general.AxisRenderer2D<Q>

Type Parameters:

Q -

All Implemented Interfaces:

DataUnitsTransformer<Q,Double,double[]>

public class AxisRenderer2D<Q>
extends AxisRenderer<Q>
implements DataUnitsTransformer<Q,Double,double[]>

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

9 Jul 2013

Field Summary

Fields

Modifier and Type	Field and Description
protected double	axisLength Desired size of the axis in pixels

Fields inherited from class org.openimaj.vis.general.AxisRenderer

config

Constructor Summary

Constructors

Constructor and Description
AxisRenderer2D() Default constructor
AxisRenderer2D(AxisConfig<Q> conf) Constructor to set the config

Method Summary

Modifier and Type	Method and Description
double[]	calculatePosition(Double units) For a given coordinate in the units of the data, will calculate the render coordinates
Double	calculateUnitsAt(double[] position) Calculates the data unit coordinate at the given render coordinates
void	drawAxis(AxisConfig<Q> config) Draw the major axis
void	drawAxisLabel(AxisConfig<Q> config) Draw the axis label
void	drawMajorTick(double location, AxisConfig<Q> config) Draw a tick on the axis at the given location
void	drawMajorTickGridline(double location, AxisConfig<Q> config) Draw a major grid line on the vis
void	drawMinorTick(double location, AxisConfig<Q> config) Draw a minor tick on the axis
void	drawMinorTickGridline(double location, AxisConfig<Q> config) Draw a minor grid on the vis
double	getAxisLength()
AxisConfig<Q>	getConfig()
double	getCurrentScale()
Image<Q,?>	getImage()
static void	main(String[] args) Simple test
void	precalc() Perform any precalculations that will allow the axes to be drawn faster, or to allow the data transformer to work.
double[]	scaleDimension(Double dimension) Given a specific data dimension, calculates a render dimension.
void	setAxisLength(double axisLength)
void	setConfig(AxisConfig<Q> config)
void	setImage(Image<Q,?> image)

Methods inherited from class org.openimaj.vis.general.AxisRenderer

nearestHigherMajorTick, nearestLowerMajorTick, renderAxis

Methods inherited from class java.lang.Object

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

Field Detail

axisLength

protected double axisLength

Desired size of the axis in pixels

Constructor Detail

AxisRenderer2D

public AxisRenderer2D()

Default constructor

AxisRenderer2D

public AxisRenderer2D(AxisConfig<Q> conf)

Constructor to set the config

Parameters:

conf - The config

Method Detail

scaleDimension

public double[] scaleDimension(Double dimension)

Description copied from interface: DataUnitsTransformer

Given a specific data dimension, calculates a render dimension.

Specified by:

scaleDimension in interface DataUnitsTransformer<Q,Double,double[]>

Parameters:

dimension - The units/data dimension

Returns:

The scaled dimension

precalc

public void precalc()

Description copied from class: AxisRenderer

Perform any precalculations that will allow the axes to be drawn faster, or to allow the data transformer to work.

Specified by:

precalc in interface DataUnitsTransformer<Q,Double,double[]>

Overrides:

precalc in class AxisRenderer<Q>

drawAxis

public void drawAxis(AxisConfig<Q> config)

Draw the major axis

Specified by:

drawAxis in class AxisRenderer<Q>

Parameters:

config - The axis configuration

See Also:

AxisRenderer.drawAxis(org.openimaj.vis.general.AxisConfig)

drawAxisLabel

public void drawAxisLabel(AxisConfig<Q> config)

Draw the axis label

Specified by:

drawAxisLabel in class AxisRenderer<Q>

Parameters:

config - The axis configuration

See Also:

AxisRenderer.drawAxisLabel(org.openimaj.vis.general.AxisConfig)

drawMajorTick

public void drawMajorTick(double location,
                          AxisConfig<Q> config)

Draw a tick on the axis at the given location

Specified by:

drawMajorTick in class AxisRenderer<Q>

Parameters:

location - The location (in data units)

config - The config

See Also:

AxisRenderer.drawMajorTick(double, org.openimaj.vis.general.AxisConfig)

drawMajorTickGridline

public void drawMajorTickGridline(double location,
                                  AxisConfig<Q> config)

Draw a major grid line on the vis

Specified by:

drawMajorTickGridline in class AxisRenderer<Q>

Parameters:

location - The location (in data units)

config - The config

See Also:

AxisRenderer.drawMajorTickGridline(double, org.openimaj.vis.general.AxisConfig)

drawMinorTick

public void drawMinorTick(double location,
                          AxisConfig<Q> config)

Draw a minor tick on the axis

Specified by:

drawMinorTick in class AxisRenderer<Q>

Parameters:

location - The location (in data units)

config - The configuration

See Also:

AxisRenderer.drawMinorTick(double, org.openimaj.vis.general.AxisConfig)

drawMinorTickGridline

public void drawMinorTickGridline(double location,
                                  AxisConfig<Q> config)

Draw a minor grid on the vis

Specified by:

drawMinorTickGridline in class AxisRenderer<Q>

Parameters:

location - The location (in data units)

config - The axis configuration

See Also:

AxisRenderer.drawMinorTickGridline(double, org.openimaj.vis.general.AxisConfig)

getAxisLength

public double getAxisLength()

Returns:

the axisLength

setAxisLength

public void setAxisLength(double axisLength)

Parameters:

axisLength - the axisLength to set

calculatePosition

public double[] calculatePosition(Double units)

For a given coordinate in the units of the data, will calculate the render coordinates

Specified by:

calculatePosition in interface DataUnitsTransformer<Q,Double,double[]>

Parameters:

units - The unit to convert to render coordinates

Returns:

Render coordinates

See Also:

DataUnitsTransformer.calculatePosition(java.lang.Object)

calculateUnitsAt

public Double calculateUnitsAt(double[] position)

Calculates the data unit coordinate at the given render coordinates

Specified by:

calculateUnitsAt in interface DataUnitsTransformer<Q,Double,double[]>

Parameters:

position - The data rendered position to convert

Returns:

the data units on the given axis

See Also:

DataUnitsTransformer.calculateUnitsAt(java.lang.Object)

getImage

public Image<Q,?> getImage()

Returns:

the image

setImage

public void setImage(Image<Q,?> image)

Parameters:

image - the image to set

getCurrentScale

public double getCurrentScale()

Returns:

the currentScale

getConfig

public AxisConfig<Q> getConfig()

Overrides:

getConfig in class AxisRenderer<Q>

Returns:

the config

setConfig

public void setConfig(AxisConfig<Q> config)

Overrides:

setConfig in class AxisRenderer<Q>

Parameters:

config - the config to set

main

public static void main(String[] args)

Simple test

Parameters:

args - command-line args (not used)