AxesRenderer2D (OpenIMAJ master project 1.3.10 API)

java.lang.Object
- org.openimaj.vis.general.AxesRenderer2D<Q,I>

Type Parameters:

Q - The pixel type of the image you'll be drawing the axes to

I - The type of image being drawn to

All Implemented Interfaces:

DataUnitsTransformer<Q,double[],int[]>
```
public class AxesRenderer2D<Q,I extends Image<Q,I>>
extends Object
implements DataUnitsTransformer<Q,double[],int[]>
```
TODO: javadoc

Author:

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

Created:

3 Jun 2013

Constructor Summary

Constructors
Constructor and Description

AxesRenderer2D()
Default constructor

Constructors
Constructor and Description
`AxesRenderer2D()` Default constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`calculatePosition(double[] units)` For a given coordinate in the units of the data, will calculate the render coordinates
`Point2d`	`calculatePosition(double x, double y)` Helper function to calulate the render position of a data unit
`double[]`	`calculateUnitsAt(int[] position)` Calculates the data unit coordinate at the given render coordinates
`int`	`getAxisPaddingBottom()`
`int`	`getAxisPaddingLeft()`
`int`	`getAxisPaddingRight()`
`int`	`getAxisPaddingTop()`
`double`	`getMaxYValue()` Returns the maximum value of the y axis
`DataUnitsTransformer<Q,double[],int[]>`	`getRelativePixelTransformer(int xOffset, int yOffset)` Returns a data pixel transformer that is based on this axes renderer but has its values offset by the given number of pixels.
`AxisConfig<Q>`	`getxAxisConfig()`
`double`	`getxAxisPosition()` The y position of the x axis.
`AxisRenderer2D<Q>`	`getxAxisRenderer()`
`AxisConfig<Q>`	`getyAxisConfig()`
`AxisRenderer2D<Q>`	`getyAxisRenderer()`
`boolean`	`isAutoScaleAxes()`
`static void`	`main(String[] args)`
`void`	`precalc()` Config may be null as it is not used.
`void`	`renderAxis(I image)` Render the axis to the given image
`int[]`	`scaleDimension(double[] dimension)` Given a specific data dimension, calculates a render dimension.
`double[]`	`scaleDimensions(double xs, double ys)` Given two dimensions, returns the dimensions scaled to the appropriate sizes.
`void`	`setAutoScaleAxes(boolean autoScaleAxes)`
`void`	`setAutoSpaceLabels(boolean autoSpaceLabels)`
`void`	`setAutoSpaceTicks(boolean autoSpaceTicks)`
`void`	`setAxisPaddingBottom(int axisPaddingBottom)`
`void`	`setAxisPaddingLeft(int axisPaddingLeft)`
`void`	`setAxisPaddingRight(int axisPaddingRight)`
`void`	`setAxisPaddingTop(int axisPaddingTop)`
`void`	`setDrawMajorTickGrid(boolean drawMajorTickGrid)`
`void`	`setDrawMinorTickGrid(boolean drawMinorTickGrid)`
`void`	`setDrawXAxis(boolean drawXAxis)`
`void`	`setDrawXAxisName(boolean drawXAxisName)`
`void`	`setDrawXTickLabels(boolean drawXTickLabels)`
`void`	`setDrawXTicks(boolean drawXTicks)`
`void`	`setDrawYAxis(boolean drawYAxis)`
`void`	`setDrawYAxisName(boolean drawYAxisName)`
`void`	`setDrawYTickLabels(boolean drawYTickLabels)`
`void`	`setDrawYTicks(boolean drawYTicks)`
`void`	`setImage(I image)`
`void`	`setMajorGridColour(Q majorGridColour)`
`void`	`setMajorGridThickness(int majorGridThickness)`
`void`	`setMajorTickColour(Q majorTickColour)`
`void`	`setMajorTickLength(int majorTickLength)`
`void`	`setMajorTickThickness(int majorTickThickness)`
`void`	`setMaxXValue(double maxXValue)`
`void`	`setMaxYValue(double maxYValue)`
`void`	`setMinorGridColour(Q minorGridColour)`
`void`	`setMinorGridThickness(int minorGridThickness)`
`void`	`setMinorTickColour(Q minorTickColour)`
`void`	`setMinorTickLength(int minorTickLength)`
`void`	`setMinorTickThickenss(int minorTickThickness)`
`void`	`setMinTickSpacing(int minTickSpacing)`
`void`	`setMinXValue(double minXValue)`
`void`	`setMinYValue(double minYValue)`
`void`	`setOrientation(double rads)` Set the orientation of the x axis
`void`	`setxAxisColour(Q xAxisColour)`
`void`	`setxAxisConfig(AxisConfig<Q> xAxisConfig)`
`void`	`setxAxisLabelTransformer(LabelTransformer xAxisLabelTransformer)`
`void`	`setxAxisName(String xAxisName)`
`void`	`setxAxisNameColour(Q xAxisNameColour)`
`void`	`setxAxisNameSize(int xAxisNameSize)`
`void`	`setxAxisPosition(double xAxisPosition)`
`void`	`setxAxisThickness(int xAxisThickness)`
`void`	`setxLabelSpacing(double xLabelSpacing)`
`void`	`setxMajorTickSpacing(double xMajorTickSpacing)`
`void`	`setxMinorTickSpacing(double xMinorTickSpacing)`
`void`	`setxTickLabelColour(Q xTickLabelColour)`
`void`	`setxTickLabelSize(int xTickLabelSize)`
`void`	`setyAxisColour(Q yAxisColour)`
`void`	`setyAxisConfig(AxisConfig<Q> yAxisConfig)`
`void`	`setyAxisLabelTransformer(LabelTransformer yAxisLabelTransformer)`
`void`	`setyAxisName(String yAxisName)`
`void`	`setyAxisNameColour(Q yAxisNameColour)`
`void`	`setyAxisNameSize(int yAxisNameSize)`
`void`	`setyAxisThickness(int yAxisThickness)`
`void`	`setyLabelSpacing(double yLabelSpacing)`
`void`	`setyMajorTickSpacing(double yMajorTickSpacing)`
`void`	`setyMinorTickSpacing(double yMinorTickSpacing)`
`void`	`setyTickLabelColour(Q yTickLabelColour)`
`void`	`setyTickLabelSize(int yTickLabelSize)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AxesRenderer2D
```
public AxesRenderer2D()
```
    Default constructor
- Method Detail
  - setOrientation
```
public void setOrientation(double rads)
```
    Set the orientation of the x axis
    
    Parameters:
    
    rads - angle in radians
  - renderAxis
```
public void renderAxis(I image)
```
    Render the axis to the given image
    
    Parameters:
    
    image - The image to draw the axes to
  - setDrawXAxis
```
public void setDrawXAxis(boolean drawXAxis)
```
    Parameters:
    
    drawXAxis - the drawXAxis to set
  - setDrawYAxis
```
public void setDrawYAxis(boolean drawYAxis)
```
    Parameters:
    
    drawYAxis - the drawYAxis to set
  - getAxisPaddingLeft
```
public int getAxisPaddingLeft()
```
    Returns:
    
    the axisPaddingLeft
  - setAxisPaddingLeft
```
public void setAxisPaddingLeft(int axisPaddingLeft)
```
    Parameters:
    
    axisPaddingLeft - the axisPaddingLeft to set
  - getAxisPaddingRight
```
public int getAxisPaddingRight()
```
    Returns:
    
    the axisPaddingRight
  - setAxisPaddingRight
```
public void setAxisPaddingRight(int axisPaddingRight)
```
    Parameters:
    
    axisPaddingRight - the axisPaddingRight to set
  - getAxisPaddingTop
```
public int getAxisPaddingTop()
```
    Returns:
    
    the axisPaddingTop
  - setAxisPaddingTop
```
public void setAxisPaddingTop(int axisPaddingTop)
```
    Parameters:
    
    axisPaddingTop - the axisPaddingTop to set
  - getAxisPaddingBottom
```
public int getAxisPaddingBottom()
```
    Returns:
    
    the axisPaddingBottom
  - setAxisPaddingBottom
```
public void setAxisPaddingBottom(int axisPaddingBottom)
```
    Parameters:
    
    axisPaddingBottom - the axisPaddingBottom to set
  - setxAxisPosition
```
public void setxAxisPosition(double xAxisPosition)
```
    Parameters:
    
    xAxisPosition - the xAxisPosition to set
  - getxAxisPosition
```
public double getxAxisPosition()
```
    The y position of the x axis.
    
    Returns:
    
    the y position.
  - isAutoScaleAxes
```
public boolean isAutoScaleAxes()
```
    Returns:
    
    the autoScaleAxes
  - setAutoScaleAxes
```
public void setAutoScaleAxes(boolean autoScaleAxes)
```
    Parameters:
    
    autoScaleAxes - the autoScaleAxes to set
  - setxAxisThickness
```
public void setxAxisThickness(int xAxisThickness)
```
    Parameters:
    
    xAxisThickness - the xAxisThickness to set
  - setxAxisColour
```
public void setxAxisColour(Q xAxisColour)
```
    Parameters:
    
    xAxisColour - the xAxisColour to set
  - setyAxisThickness
```
public void setyAxisThickness(int yAxisThickness)
```
    Parameters:
    
    yAxisThickness - the yAxisThickness to set
  - setyAxisColour
```
public void setyAxisColour(Q yAxisColour)
```
    Parameters:
    
    yAxisColour - the yAxisColour to set
  - setMaxXValue
```
public void setMaxXValue(double maxXValue)
```
    Parameters:
    
    maxXValue - the maxXValue to set
  - setMinXValue
```
public void setMinXValue(double minXValue)
```
    Parameters:
    
    minXValue - the minXValue to set
  - setMaxYValue
```
public void setMaxYValue(double maxYValue)
```
    Parameters:
    
    maxYValue - the maxYValue to set
  - getMaxYValue
```
public double getMaxYValue()
```
    Returns the maximum value of the y axis
    
    Returns:
    
    The y axis maximum value
  - setMinYValue
```
public void setMinYValue(double minYValue)
```
    Parameters:
    
    minYValue - the minYValue to set
  - setxMinorTickSpacing
```
public void setxMinorTickSpacing(double xMinorTickSpacing)
```
    Parameters:
    
    xMinorTickSpacing - the xMinorTickSpacing to set
  - setyMinorTickSpacing
```
public void setyMinorTickSpacing(double yMinorTickSpacing)
```
    Parameters:
    
    yMinorTickSpacing - the yMinorTickSpacing to set
  - setxMajorTickSpacing
```
public void setxMajorTickSpacing(double xMajorTickSpacing)
```
    Parameters:
    
    xMajorTickSpacing - the xMajorTickSpacing to set
  - setyMajorTickSpacing
```
public void setyMajorTickSpacing(double yMajorTickSpacing)
```
    Parameters:
    
    yMajorTickSpacing - the yMajorTickSpacing to set
  - setMinorTickLength
```
public void setMinorTickLength(int minorTickLength)
```
    Parameters:
    
    minorTickLength - the minorTickLength to set
  - setMajorTickLength
```
public void setMajorTickLength(int majorTickLength)
```
    Parameters:
    
    majorTickLength - the majorTickLength to set
  - setMinorTickColour
```
public void setMinorTickColour(Q minorTickColour)
```
    Parameters:
    
    minorTickColour - the minorTickColour to set
  - setMajorTickColour
```
public void setMajorTickColour(Q majorTickColour)
```
    Parameters:
    
    majorTickColour - the majorTickColour to set
  - setMajorTickThickness
```
public void setMajorTickThickness(int majorTickThickness)
```
    Parameters:
    
    majorTickThickness - the majorTickThickness to set
  - setMinorTickThickenss
```
public void setMinorTickThickenss(int minorTickThickness)
```
    Parameters:
    
    minorTickThickness - the minorTickThickenss to set
  - setDrawXTickLabels
```
public void setDrawXTickLabels(boolean drawXTickLabels)
```
    Parameters:
    
    drawXTickLabels - the drawXTickLabels to set
  - setDrawYTickLabels
```
public void setDrawYTickLabels(boolean drawYTickLabels)
```
    Parameters:
    
    drawYTickLabels - the drawYTickLabels to set
  - setxTickLabelSize
```
public void setxTickLabelSize(int xTickLabelSize)
```
    Parameters:
    
    xTickLabelSize - the xTickLabelSize to set
  - setxTickLabelColour
```
public void setxTickLabelColour(Q xTickLabelColour)
```
    Parameters:
    
    xTickLabelColour - the xTickLabelColour to set
  - setyTickLabelSize
```
public void setyTickLabelSize(int yTickLabelSize)
```
    Parameters:
    
    yTickLabelSize - the yTickLabelSize to set
  - setyTickLabelColour
```
public void setyTickLabelColour(Q yTickLabelColour)
```
    Parameters:
    
    yTickLabelColour - the yTickLabelColour to set
  - setAutoSpaceLabels
```
public void setAutoSpaceLabels(boolean autoSpaceLabels)
```
    Parameters:
    
    autoSpaceLabels - the autoSpaceLabels to set
  - setAutoSpaceTicks
```
public void setAutoSpaceTicks(boolean autoSpaceTicks)
```
    Parameters:
    
    autoSpaceTicks - the autoSpaceTicks to set
  - setMinTickSpacing
```
public void setMinTickSpacing(int minTickSpacing)
```
    Parameters:
    
    minTickSpacing - the minTickSpacing to set
  - setxLabelSpacing
```
public void setxLabelSpacing(double xLabelSpacing)
```
    Parameters:
    
    xLabelSpacing - the xLabelSpacing to set
  - setyLabelSpacing
```
public void setyLabelSpacing(double yLabelSpacing)
```
    Parameters:
    
    yLabelSpacing - the yLabelSpacing to set
  - setxAxisName
```
public void setxAxisName(String xAxisName)
```
    Parameters:
    
    xAxisName - the xAxisName to set
  - setyAxisName
```
public void setyAxisName(String yAxisName)
```
    Parameters:
    
    yAxisName - the yAxisName to set
  - setDrawYAxisName
```
public void setDrawYAxisName(boolean drawYAxisName)
```
    Parameters:
    
    drawYAxisName - the drawYAxisName to set
  - setDrawXAxisName
```
public void setDrawXAxisName(boolean drawXAxisName)
```
    Parameters:
    
    drawXAxisName - the drawXAxisName to set
  - setxAxisNameSize
```
public void setxAxisNameSize(int xAxisNameSize)
```
    Parameters:
    
    xAxisNameSize - the xAxisNameSize to set
  - setxAxisNameColour
```
public void setxAxisNameColour(Q xAxisNameColour)
```
    Parameters:
    
    xAxisNameColour - the xAxisNameColour to set
  - setyAxisNameSize
```
public void setyAxisNameSize(int yAxisNameSize)
```
    Parameters:
    
    yAxisNameSize - the yAxisNameSize to set
  - setyAxisNameColour
```
public void setyAxisNameColour(Q yAxisNameColour)
```
    Parameters:
    
    yAxisNameColour - the yAxisNameColour to set
  - setDrawXTicks
```
public void setDrawXTicks(boolean drawXTicks)
```
    Parameters:
    
    drawXTicks - the drawXTicks to set
  - setDrawYTicks
```
public void setDrawYTicks(boolean drawYTicks)
```
    Parameters:
    
    drawYTicks - the drawYTicks to set
  - setxAxisLabelTransformer
```
public void setxAxisLabelTransformer(LabelTransformer xAxisLabelTransformer)
```
    Parameters:
    
    xAxisLabelTransformer - the xAxisLabelTransformer to set
  - setyAxisLabelTransformer
```
public void setyAxisLabelTransformer(LabelTransformer yAxisLabelTransformer)
```
    Parameters:
    
    yAxisLabelTransformer - the yAxisLabelTransformer to set
  - setDrawMinorTickGrid
```
public void setDrawMinorTickGrid(boolean drawMinorTickGrid)
```
    Parameters:
    
    drawMinorTickGrid - the drawMinorTickGrid to set
  - setDrawMajorTickGrid
```
public void setDrawMajorTickGrid(boolean drawMajorTickGrid)
```
    Parameters:
    
    drawMajorTickGrid - the drawMajorTickGrid to set
  - setMinorGridColour
```
public void setMinorGridColour(Q minorGridColour)
```
    Parameters:
    
    minorGridColour - the minorGridColour to set
  - setMajorGridColour
```
public void setMajorGridColour(Q majorGridColour)
```
    Parameters:
    
    majorGridColour - the majorGridColour to set
  - setMajorGridThickness
```
public void setMajorGridThickness(int majorGridThickness)
```
    Parameters:
    
    majorGridThickness - the majorGridThickness to set
  - setMinorGridThickness
```
public void setMinorGridThickness(int minorGridThickness)
```
    Parameters:
    
    minorGridThickness - the minorGridThickness to set
  - getRelativePixelTransformer
```
public DataUnitsTransformer<Q,double[],int[]> getRelativePixelTransformer(int xOffset,
                                                                          int yOffset)
```
    Returns a data pixel transformer that is based on this axes renderer but has its values offset by the given number of pixels. // TODO: This method doesn't work at the moment
    
    Parameters:
    
    xOffset - The x location
    
    yOffset - The y location
    
    Returns:
    
    A new data pixel transformer
  - getxAxisConfig
```
public AxisConfig<Q> getxAxisConfig()
```
    Returns:
    
    the xAxisConfig
  - setxAxisConfig
```
public void setxAxisConfig(AxisConfig<Q> xAxisConfig)
```
    Parameters:
    
    xAxisConfig - the xAxisConfig to set
  - getyAxisConfig
```
public AxisConfig<Q> getyAxisConfig()
```
    Returns:
    
    the yAxisConfig
  - setyAxisConfig
```
public void setyAxisConfig(AxisConfig<Q> yAxisConfig)
```
    Parameters:
    
    yAxisConfig - the yAxisConfig to set
  - calculatePosition
```
public int[] 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[],int[]>
    
    Parameters:
    
    units - The unit to convert to render coordinates
    
    Returns:
    
    Render coordinates
    
    See Also:
    
    DataUnitsTransformer.calculatePosition(java.lang.Object)
  - calculateUnitsAt
```
public double[] calculateUnitsAt(int[] position)
```
    Calculates the data unit coordinate at the given render coordinates
    
    Specified by:
    
    calculateUnitsAt in interface DataUnitsTransformer<Q,double[],int[]>
    
    Parameters:
    
    position - The data rendered position to convert
    
    Returns:
    
    the data units on the given axis
    
    See Also:
    
    DataUnitsTransformer.calculateUnitsAt(java.lang.Object)
  - scaleDimensions
```
public double[] scaleDimensions(double xs,
                                double ys)
```
    Given two dimensions, returns the dimensions scaled to the appropriate sizes.
    
    Parameters:
    
    xs - The x dimension
    
    ys - The y dimension
    
    Returns:
    
    The scaled dimensions
  - scaleDimension
```
public int[] scaleDimension(double[] dimension)
```
    Given a specific data dimension, calculates a render dimension.
    
    Specified by:
    
    scaleDimension in interface DataUnitsTransformer<Q,double[],int[]>
    
    Parameters:
    
    dimension - The units/data dimension
    
    Returns:
    
    The scaled dimension
    
    See Also:
    
    DataUnitsTransformer.scaleDimension(java.lang.Object)
  - calculatePosition
```
public Point2d calculatePosition(double x,
                                 double y)
```
    Helper function to calulate the render position of a data unit
    
    Parameters:
    
    x - The data unit x
    
    y - The data unit y
    
    Returns:
    
    The render position
  - precalc
```
public void precalc()
```
    Config may be null as it is not used. Force a precalculation of the variables required for the pixel transformation.
    
    Specified by:
    
    precalc in interface DataUnitsTransformer<Q,double[],int[]>
    
    See Also:
    
    DataUnitsTransformer.precalc()
  - setImage
```
public void setImage(I image)
```
    Parameters:
    
    image - the image to set
  - getxAxisRenderer
```
public AxisRenderer2D<Q> getxAxisRenderer()
```
    Returns:
    
    the xAxisRenderer
  - getyAxisRenderer
```
public AxisRenderer2D<Q> getyAxisRenderer()
```
    Returns:
    
    the yAxisRenderer
  - main
```
public static void main(String[] args)
```
    Parameters:
    
    args -

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AxesRenderer2D

Method Detail

setOrientation

renderAxis

setDrawXAxis

setDrawYAxis

getAxisPaddingLeft

setAxisPaddingLeft

getAxisPaddingRight

setAxisPaddingRight

getAxisPaddingTop

setAxisPaddingTop

getAxisPaddingBottom

setAxisPaddingBottom

setxAxisPosition

getxAxisPosition

isAutoScaleAxes

setAutoScaleAxes

setxAxisThickness

setxAxisColour

setyAxisThickness

setyAxisColour

setMaxXValue

setMinXValue

setMaxYValue

getMaxYValue

setMinYValue

setxMinorTickSpacing

setyMinorTickSpacing

setxMajorTickSpacing

setyMajorTickSpacing

setMinorTickLength

setMajorTickLength

setMinorTickColour

setMajorTickColour

setMajorTickThickness

setMinorTickThickenss

setDrawXTickLabels

setDrawYTickLabels

setxTickLabelSize

setxTickLabelColour

setyTickLabelSize

setyTickLabelColour

setAutoSpaceLabels

setAutoSpaceTicks

setMinTickSpacing

setxLabelSpacing

setyLabelSpacing

setxAxisName

setyAxisName

setDrawYAxisName

setDrawXAxisName

setxAxisNameSize

setxAxisNameColour

setyAxisNameSize

setyAxisNameColour

setDrawXTicks

setDrawYTicks

setxAxisLabelTransformer

setyAxisLabelTransformer

setDrawMinorTickGrid

setDrawMajorTickGrid

setMinorGridColour

setMajorGridColour

setMajorGridThickness

setMinorGridThickness

getRelativePixelTransformer

getxAxisConfig

setxAxisConfig

getyAxisConfig

setyAxisConfig

calculatePosition

calculateUnitsAt

scaleDimensions

scaleDimension