Skip to content

Latest commit

 

History

History
84 lines (74 loc) · 6.08 KB

instructions_plot_lines.md

File metadata and controls

84 lines (74 loc) · 6.08 KB

Instructions for plot_lines.exe

This application is used to plot one or more series of XY data on a single set of axes.

Table of Contents

Input files

CSV data file

  • This file contains the xy data to be plotted.
  • There are two accepted CSV data formats (specified via data_format setting):
    • xyxy:
      • Each data series may have different x coordinates.
      • Rows alternate between x and y coordinates for the same data series.
    • xyy:
      • All series use the same x coordinates, which are written in the first row.
      • Subsequent rows contain the y data for each series.
  • File is set via the path_input_data setting.

Settings file

  • This file contains all of the user-configurable settings for the application.
  • Input file: input/plot_lines.cfg
  • The description of each setting is provided in the Settings Table below.
  • Default values are indicated where applicable.
    • To use default values, do not delete settings, simply leave the value blank.

Output files

Figure file

  • This file contains the plotted output generated by the application.
  • File is set via the path_output_figure setting.
    • Include the desired file output type (e.g. output/output_trend.png vs. output/output_trend.eps, etc.)

Settings:

Name Default value description
border_width 5 Line width of plot border.
color_series #000000,#4556d2,#C63822,
#55A961,#75298e,#9ba5b1,
#2fb5d4,#E79A9F,#4be0b0,
#cb66ed		 Specify color of series using comma-delimited list of HEX color values. Pattern repeats if there are more series than colors specified.
data_format xyy Specify format of the data rows read in from CSV {xyy,xyxy}.
grayscale 0 If grayscale=0: plot in color. If grayscale=1: plot in grayscale.
legend 1 If legend=1: show legend. If legend=0: no legend.
legend_border_size 1 Line width of legend border.
legend_coords 0.15,0.75,0.365,0.85 Comma-delimited coordinates of the legend (format: lower x, lower y, upper x, upper y). Rule of thumb: add 0.05 between upper and lower y for each data series.
legend_entries row headers in input file Comma-delimited series names. e.g: series 1,series 2,series 3
legend_text_size 0.035 Height of the legend text in fractional percent of the canvas.
line_style 1 Comma-delimited list of series line styles, if using plot_type=l or plot_type=c. See Root docs. If only a single value, apply to all series.
line_width 5 Comma-delimited list of series line widths, if using plot_type=l or plot_type=c. See Root docs. If only a single value, apply to all series.
margin_bottom 0.1 Whitespace margin to add to bottom of plot area, as a fractional percent of the canvas.
margin_left 0.1 Whitespace margin to add to left of plot area, as a fractional percent of the canvas.
margin_right 0.1 Whitespace margin to add to right of plot area, as a fractional percent of the canvas.
margin_top 0.1 Whitespace margin to add to top of plot area, as a fractional percent of the canvas.
marker_size 5 Comma-delimited list of data marker sizes, if using plot_type=m. See Root docs. If only a single value, apply to all series.
marker_style 20 Comma-delimited list of data marker styles, if using plot_type=m. See Root docs. If only a single value, apply to all series.
path_input_data output/output_trend.csv Pathname to input CSV data file.
path_output_figure output/output_trend.png Pathname to ouput figure file.
plot_type l Specify whether to plot only the data points (m), a polyline between data points (l), or a smooth curve between data points (c).
textbox 0 If textbox=1: include a textbox. If textbox=0: no textbox.
textbox_coords 0.15,0.4,0.4,0.6 Comma-delimited coordinates of the textbox (format: lower x, lower y, upper x, upper y).
textbox_text N/A Comma-delimited text to include in text box. Commas delineate new lines.
title N/A Title of the plot.
x_grid 0 If x_grid=0: do not include gridlines. If x_grid=1: include gridlines.
x_label N/A X-axis label.
x_label_offset 1.0 Double value to shift the x-axis label up or down.
x_log 0 If x_log=0: x-axis is linear. If x_log=1: x-axis is log-scale.
x_max max x value in input file Max x-axis value.
x_min min x value in input file Min x-axis value.
x_num_divs N/A 3 digit number that specifies number of major and minor divisions (tick marks). See Root docs.
x_res 3200 Horizontal resolution (dimension). Only applicable to rasterized image formats (e.g. PNG not EPS).
y_grid 0 If y_grid=0: do not include gridlines. If y_grid=1: include gridlines.
y_label N/A Y-axis label
y_label_offset 0.0 Double value to shift the y-axis label left or right.
y_log 0 If y_log=0: y-axis is linear. If y_log=1: y-axis is log-scale.
y_max max y value in input file Max y-axis value.
y_min min y value in input file Min y-axis value.
y_num_divs N/A 3 digit number that specifies number of major and minor divisions (tick marks). See Root docs.
y_res 2400 Vertical resolution (dimension). Only applicable to rasterized image formats (e.g. PNG not EPS).