org.epics.graphene.profile

Class ProfileGraph2D<T extends Graph2DRenderer,S>

java.lang.Object

org.epics.graphene.profile.Profiler

org.epics.graphene.profile.ProfileGraph2D<T,S>

Type Parameters:

T - type of graph render being profiled that is subclass of Graph2DRenderer

S - dataset type that is associated with the graph renderer

Direct Known Subclasses:

ProfileAreaGraph2D, ProfileBubbleGraph2D, ProfileHistogram1D, ProfileIntensityGraph2D, ProfileLineGraph2D, ProfileMultilineGraph2D, ProfileMultiYAxisGraph2D, ProfileNLineGraphs2D, ProfileScatterGraph2D, ProfileSparklineGraph2D

public abstract class ProfileGraph2D<T extends Graph2DRenderer,S>
extends Profiler

Handles the profiling for testing rendering (specifically the draw) of a Graph2DRenderer. The base class for all graph profilers. Has parameter T that is a graph renderer. Has parameter S that is the dataset associated with T. A profiler creates a loop in which a Graph2DRenderer perform multiple render operations. Various options are provided to handle the profile statistics.

Author:

asbarber

Field Summary

Fields

Modifier and Type	Field and Description
protected S	data
static String	LOG_FILEPATH Default file path for all CSV log files of statistics.
protected T	renderer

Fields inherited from class org.epics.graphene.profile.Profiler

nTries, stopWatch

Constructor Summary

Constructors

Constructor and Description
ProfileGraph2D() Creates a graph profiler.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract S	getDataset() The data that to be rendered in the render loop.
abstract String	getGraphTitle() Gets the type of graph renderer.
String	getLogFileName() Gets the name of the CSV file to save statistics to.
int	getNumDataPoints() Gets the size of the data set.
String	getProfileTitle()
protected abstract T	getRenderer(int imageWidth, int imageHeight) The renderer used in the render loop.
RenderSettings	getRenderSettings()
Resolution	getResolution()
SaveSettings	getSaveSettings() Gets the settings to be saved to the output file for a profile.
abstract LinkedHashMap<String,Graph2DRendererUpdate>	getVariations() Gets the updates associated with the renderer in a map, linking a description of the update to the update object.
protected void	iterationAction()
protected void	postIterationAction()
protected void	preLoopAction()
protected abstract void	render(Graphics2D graphics, T renderer, S data) The primary method in the profiling render loop.
void	saveImage()
void	saveStatistics() Writes the profile statistics to a CSV file designated to the profile graph.
void	setNumDataPoints(int nPoints) Sets the size of the data set.

Methods inherited from class org.epics.graphene.profile.Profiler

getProfileSettings, getStatistics, graphStatistics, printStatistics, profile, saveStatistics

Methods inherited from class java.lang.Object

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

Field Detail

LOG_FILEPATH

public static final String LOG_FILEPATH

Default file path for all CSV log files of statistics.

See Also:

Constant Field Values

data

protected S data

renderer

protected T extends Graph2DRenderer renderer

Constructor Detail

ProfileGraph2D

public ProfileGraph2D()

Creates a graph profiler.

Method Detail

preLoopAction

protected void preLoopAction()

Overrides:

preLoopAction in class Profiler

iterationAction

protected void iterationAction()

Specified by:

iterationAction in class Profiler

postIterationAction

protected void postIterationAction()

Overrides:

postIterationAction in class Profiler

getDataset

protected abstract S getDataset()

The data that to be rendered in the render loop. Precondition: getRenderer() is capable of rendering getDataset(). Thus type T is capable of rendering type S. A useful helper method is getNumDataPoints. The size of the returned data set should match the size specified by getNumDataPoints.

Returns:

a set of data associated with T

getRenderer

protected abstract T getRenderer(int imageWidth,
            int imageHeight)

The renderer used in the render loop. Precondition: getRenderer() is capable of rendering getDataset(). Thus type T is capable of rendering type S.

Parameters:

imageWidth - pixel width of rendered image

imageHeight - pixel height of rendered image

Returns:

a Graph2DRenderer associated with data S

render

protected abstract void render(Graphics2D graphics,
          T renderer,
          S data)

The primary method in the profiling render loop. Override this method to test the draw method of 'renderer'.

Parameters:

graphics - where image draws to

renderer - what draws the image

data - what is drawn

getVariations

public abstract LinkedHashMap<String,Graph2DRendererUpdate> getVariations()

Gets the updates associated with the renderer in a map, linking a description of the update to the update object.

Returns:

map with description of update paired with an update

saveStatistics

public void saveStatistics()

Writes the profile statistics to a CSV file designated to the profile graph. Appends the statistics to the end of the CSV file. The file name is designated by getLogFileName(). Each subclass should thus have its own CSV file. If a CSV file does not exist, the file is created. If statistics do no exist, no operations are performed. If errors occur in IO, a console message is printed. The delimiting is:

• Non-numeric components enclosed in quotes
• Numeric components not enclosed
• Components separated by commas (no spaces)

The components are:

1. Graph title (type of graph)
2. Date
3. Average time rendering
4. Total time rendering
5. Number of render attempts
6. Number of data points
7. Width of image rendered
8. Height of image rendered
9. Timing Type
10. Update Applied
11. Comment about the data set rendered (useful for multi-dimensional or unusual data sets)
12. Comment about the author performing the profile
13. General comment about rendering

saveImage

public void saveImage()

getProfileTitle

public String getProfileTitle()

Specified by:

getProfileTitle in class Profiler

getGraphTitle

public abstract String getGraphTitle()

Gets the type of graph renderer. Used in printing and saving statistics. Example: "LineGraph2D"

Returns:

the title of the graph renderer being profiled

getLogFileName

public String getLogFileName()

Gets the name of the CSV file to save statistics to. Derived from getGraphTitle().

Returns:

the file name (not file path) of the CSV log file

getSaveSettings

public SaveSettings getSaveSettings()

Gets the settings to be saved to the output file for a profile. Some settings include:

• Author
• Dataset message
• Save message

Returns:

the messages about settings information to be saved to an output file

getRenderSettings

public RenderSettings getRenderSettings()

getResolution

public Resolution getResolution()

getNumDataPoints

public int getNumDataPoints()

Gets the size of the data set. Useful for creating the data set of the appropriate size. Used in saving statistics to the CSV log file.

Returns:

size of the data set in rendering

setNumDataPoints

public void setNumDataPoints(int nPoints)

Sets the size of the data set. Useful for creating the data set of the appropriate size. Used in saving statistics to the CSV log file.

Parameters:

nPoints - size of the data set in rendering