MultiLevelProfiler (diirt 3.0.1-SNAPSHOT API)

java.lang.Object
- org.diirt.graphene.profile.MultiLevelProfiler

```
public class MultiLevelProfiler
extends Object
```
Handles the profiling for testing rendering (specifically the draw) of a Graph2DRenderer through sets of testing settings. Has a ProfileGraph2D with the type of the Graph2DRenderer being profiled.
Enables the profile object to be profile at various image resolutions and dataset sizes. These statistics may then be graphed or saved.

Author:

asbarber

Constructor Summary

Constructors
Constructor and Description
`MultiLevelProfiler(ProfileGraph2D profiler)` Creates a object to profile a `Graph2DRenderer` using a `ProfileGraph2D` and analyzing performance through various sets of renderings at specified intervals of data sizes and image resolution sizes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`defaultProfile(ProfileGraph2D profiler)` Sample multi-level profiling for a given renderer.
`Map<Resolution,Map<Integer,Statistics>>`	`getResults()` A mapping that gets the results of profiler that maps a statistics result to every dataset size that is mapped to every resolution.
`SaveSettings`	`getSaveSettings()` Gets the settings to be saved to the output file for a profile.
`List<Point2DDataset>`	`getStatisticLineData()` Forms a set of point 2D data for each resolution profiled where the point is composed of the number of data points profiled and the average profile time.
`void`	`graphStatistics()` Displays a separate `frame` for every profile operation performed.
`void`	`processPreResult(Resolution resolution, int datasetSize)` Performed every iteration of profiling and is the action undertaken before knowing the statistics about the profile.
`void`	`processResult(Resolution resolution, int datasetSize, Statistics stats)` Performed every iteration of profiling and is the action undertaken after knowing the statistics about the profile.
`void`	`processTimeWarning(int estimatedTime)` Performed after the call to `profile` but prior to actual image rendering.
`void`	`profile()` Runs through the list of dataset sizes paired with every element from the list of image resolutions to profile a `ProfileGraph2D` to analyze the performance of the graph renderer and how the performance is effected by data size and image size.
`void`	`saveImages()` Saves the images generated by the profiling.
`void`	`saveStatistics()` Creates a table (.CSV format) to display the results, with the dataset sizes as the row heading and the resolution as the column heading.
`void`	`setDatasetSizes(List<Integer> nPoints)` Sets the dataset sizes to be profiled.
`void`	`setImageSizes(List<Resolution> resolutions)` Sets the resolution sizes to be profiled.

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

- Constructor Detail
  - MultiLevelProfiler
```
public MultiLevelProfiler(ProfileGraph2D profiler)
```
    Creates a object to profile a Graph2DRenderer using a ProfileGraph2D and analyzing performance through various sets of renderings at specified intervals of data sizes and image resolution sizes.
    
    Parameters:
    
    profiler - graph renderer with given profile settings to do extensive testing on
- Method Detail
  - profile
```
public void profile()
```
    Runs through the list of dataset sizes paired with every element from the list of image resolutions to profile a ProfileGraph2D to analyze the performance of the graph renderer and how the performance is effected by data size and image size.
    Precondition: the set of dataset sizes and the set of resolutions to test are both not null and not empty.
    A mapping of results is created to link dataset size, resolution, and statistics. This is done by creating a map, map_A, for a link between the statistics and the dataset size, and mapping map_A to a second map for every resolution.
    
    See Also:
    
    getResults()
  - getResults
```
public Map<Resolution,Map<Integer,Statistics>> getResults()
```
    A mapping that gets the results of profiler that maps a statistics result to every dataset size that is mapped to every resolution.
    The keys to the outer map are the set of resolutions. The keys to the inner map are the set of dataset sizes. The value of the outer map is the inner map. The value of the inner map is the statistics of the profiling. Precondition: #profile() has been called.
    
    Returns:
    
    a mapping that gets the results of running the profiler associated resolution sizes to dataset sizes to statistical timing results
  - getStatisticLineData
```
public List<Point2DDataset> getStatisticLineData()
```
    Forms a set of point 2D data for each resolution profiled where the point is composed of the number of data points profiled and the average profile time. Each point has the form (size, time).
    
    Returns:
    
    lines for each resolution composed of average profile time and dataset size points, with the point have the form (size, time)
  - graphStatistics
```
public void graphStatistics()
```
    Displays a separate frame for every profile operation performed. Plots the sizes on the x-axis and the times on the y-axis. Precondition: #profile() has been called.
  - saveStatistics
```
public void saveStatistics()
```
    Creates a table (.CSV format) to display the results, with the dataset sizes as the row heading and the resolution as the column heading.
    Saves the CSV file to the same directory as general profile results, with the specific profile graph type as well as the date. Precondition: results is non-null and not empty, meaning profiling has been completed.
  - saveImages
```
public void saveImages()
```
    Saves the images generated by the profiling. Saves the image files to a directory with the specific profile graph type as well as the date. Precondition: images is non-null and not empty, meaning profiling has been completed.
  - processTimeWarning
```
public void processTimeWarning(int estimatedTime)
```
    Performed after the call to profile but prior to actual image rendering.
    Default behavior will display the estimated time based on the number of resolutions, number of dataset sizes, and the test time.
    
    Parameters:
    
    estimatedTime - estimated time to profile
    
    See Also:
    
    profile()
  - processPreResult
```
public void processPreResult(Resolution resolution,
                             int datasetSize)
```
    Performed every iteration of profiling and is the action undertaken before knowing the statistics about the profile.
    Default behavior is to print the resolution and dataset size to the console.
    Override this to provide custom behaviors.
    
    Parameters:
    
    resolution - resolution about to be profiled (image width, height)
    
    datasetSize - size of data about to be profiled
  - processResult
```
public void processResult(Resolution resolution,
                          int datasetSize,
                          Statistics stats)
```
    Performed every iteration of profiling and is the action undertaken after knowing the statistics about the profile.
    Default behavior is to print the average time to the console.
    Override this to provide custom behaviors.
    
    Parameters:
    
    resolution - resolution just profiled (image width, height)
    
    datasetSize - size of data just profiled
    
    stats - results of the profiling
  - setImageSizes
```
public void setImageSizes(List<Resolution> resolutions)
```
    Sets the resolution sizes to be profiled. Precondition: resolution set is not null and not empty
    
    Parameters:
    
    resolutions - set of resolutions to profile
  - setDatasetSizes
```
public void setDatasetSizes(List<Integer> nPoints)
```
    Sets the dataset sizes to be profiled. The ProfileGraph2D field of this object will profile repeatedly updating the number of data points in rendering.
    
    Parameters:
    
    nPoints -
  - 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
  - defaultProfile
```
public static void defaultProfile(ProfileGraph2D profiler)
```
    Sample multi-level profiling for a given renderer. Uses the default resolutions and default datasets as data.
    Graphs and saves the data.
    
    Parameters:
    
    profiler - renderer to profile at multiple levels

Class MultiLevelProfiler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiLevelProfiler

Method Detail

profile

getResults

getStatisticLineData

graphStatistics

saveStatistics

saveImages

processTimeWarning

processPreResult

processResult

setImageSizes

setDatasetSizes

getSaveSettings

defaultProfile