SSJ  3.3.1
Stochastic Simulation in Java
List of all members
PlotFormat Class Reference

Provide tools to import and export data set tables to and from Gnuplot, MATLAB and Mathematica compatible formats, or customized format. More...

Static Public Member Functions

Data import functions
static double [][] fromGNUPlot (String data)
 Parses data according to the standard GNUPlot format and stores the extracted values in the returned table. More...
 
static double [][] fromCSV (String data)
 Parses data according to the standard CSV format and stores the extracted values in the returned table. More...
 
static double [][] fromCustomizedFormat (String betweenValues, String endLine, String data)
 Parses data according to a user defined format and stores the extracted values in the returned table. More...
 

Data export functions

static String toGNUPlot (double[]... data)
 Stores data tables data into a String, with format understandable by GNUPlot. More...
 
static String toGNUPlot (XYSeriesCollection data)
 Stores series collection data into a String, with format understandable by GNUPlot. More...
 
static String toCSV (double[]...data)
 Stores data tables data into a String with format CSV (comma-separated value tabular data). More...
 
static String toCSV (XYSeriesCollection data)
 Stores series collection data into a String with format CSV (comma-separated value tabular data). More...
 
static String toCustomizedFormat (String heading, String footer, String betweenValues, String endLine, int precision, double[]...data)
 Stores data tables data into a String with customized format. More...
 
static String toCustomizedFormat (String heading, String footer, String betweenValues, String endLine, int precision, XYSeriesCollection data)
 Stores data tables data into a String with customized format from an XYSeriesCollection variable. More...
 

Detailed Description

Provide tools to import and export data set tables to and from Gnuplot, MATLAB and Mathematica compatible formats, or customized format.

Member Function Documentation

◆ fromCSV()

static double [][] fromCSV ( String  data)
static

Parses data according to the standard CSV format and stores the extracted values in the returned table.

Parameters
dataString to parse.
Returns
Table that represent data contained in data.
Exceptions
IllegalArgumentExceptionif each line of the input String doesn’t share the same number of values

◆ fromCustomizedFormat()

static double [][] fromCustomizedFormat ( String  betweenValues,
String  endLine,
String  data 
)
static

Parses data according to a user defined format and stores the extracted values in the returned table.

betweenValues sets characters between values on the same line and endLine sets characters which separates each line of the input data set. Usually, this parameter contains the classic end of line character n. This method uses regular expressions, so it is possible to use regular characters as defined in the standard java API, specially in the class Pattern (package java.util.regex).

Parameters
betweenValuesString which separates values on the same line.
endLineString which separates lines.
dataString to parse.
Returns
Table that represent data contained in data.
Exceptions
IllegalArgumentExceptionif each line of the input String doesn’t share the same number of values

◆ fromGNUPlot()

static double [][] fromGNUPlot ( String  data)
static

Parses data according to the standard GNUPlot format and stores the extracted values in the returned table.

All unrecognized characters and empty lines will be cut. Deleting comments inside the input String is recommended.

Parameters
dataString to parse.
Returns
Table that represent data contained in data.
Exceptions
IllegalArgumentExceptionif each line of the input String doesn’t share the same number of values

◆ toCSV() [1/2]

static String toCSV ( double... []  data)
static

Stores data tables data into a String with format CSV (comma-separated value tabular data).

The output string could be imported from a file to a matrix into Mathematica with Mathematica’s function Import["fileName", "CSV"], or into MATLAB with MATLAB’s function csvread(’fileName’).

Parameters
datadata tables.
Returns
String that represent data tables in CSV format.

◆ toCSV() [2/2]

static String toCSV ( XYSeriesCollection  data)
static

Stores series collection data into a String with format CSV (comma-separated value tabular data).

Parameters
datadata tables.
Returns
String that represent data tables in CSV format.

◆ toCustomizedFormat() [1/2]

static String toCustomizedFormat ( String  heading,
String  footer,
String  betweenValues,
String  endLine,
int  precision,
double... []  data 
)
static

Stores data tables data into a String with customized format.

heading sets the head of the returned String, footer sets its end, betweenValues sets characters between values on the same line and finally endLine sets characters which separates each line of the input data set. Normally, this parameter contains the classic end of line character ‘n’.

Parameters
headinghead of the returned String.
footerend of the returned String.
betweenValuesString which separates values on the same line.
endLineString which separates lines.
precisionnumber of decimal
datadata tables.
Returns
String that represent data tables in customized format.

◆ toCustomizedFormat() [2/2]

static String toCustomizedFormat ( String  heading,
String  footer,
String  betweenValues,
String  endLine,
int  precision,
XYSeriesCollection  data 
)
static

Stores data tables data into a String with customized format from an XYSeriesCollection variable.

Parameters
headinghead of the returned String.
footerend of the returned String.
betweenValuesString which separates values on the same line.
endLineString which separates lines.
precisionnumber of decimal
datadata tables.
Returns
String that represent data tables in customized format.

◆ toGNUPlot() [1/2]

static String toGNUPlot ( double... []  data)
static

Stores data tables data into a String, with format understandable by GNUPlot.

Parameters
datadata tables.
Returns
String that represent data tables in GNUPlot format.

◆ toGNUPlot() [2/2]

static String toGNUPlot ( XYSeriesCollection  data)
static

Stores series collection data into a String, with format understandable by GNUPlot.

Parameters
datadata tables.
Returns
String that represent data tables in GNUPlot format.

The documentation for this class was generated from the following file: