TinkeCell API  1.0.0
C/Python/Octave/Ruby API
Functions
Graphing

display graphs, save graphs, get graph values More...

Functions

BEGIN_C_DECLS TCAPIEXPORT void tc_surface (tc_matrix z, const char *title)
 plot 3D data. Input matrix has x,y on the first two columns and z on the third column
TCAPIEXPORT void tc_plot (tc_matrix data, const char *title)
 plot the data in the matrix (with headers) with the given x-axis and title
TCAPIEXPORT void tc_scatterplot (tc_matrix data, const char *title)
 plot the data in the matrix (with headers) as a scatter plot
TCAPIEXPORT void tc_errorBars (tc_matrix data, const char *title)
 plot the data in the matrix (with headers) with the given x-axis and title. For each column i, the i+1 and i+2 columns should contain the upper and lower bounds (errors).
TCAPIEXPORT void tc_hist (tc_matrix data, const char *title)
 plot histogram for each column of the given matrix with the given bin size.
TCAPIEXPORT void tc_closePlots ()
 close all plots
TCAPIEXPORT void tc_multiplot (int rows, int cols)
 enable multi-plot, i.e. multiple plots on one screen. specify the number of rows and columns for the layout.
TCAPIEXPORT void tc_holdPlot (int on)
 hold current plot and plot on top of it
TCAPIEXPORT tc_matrix tc_clusterPlots (int clusters)
 perform clustering on plots
TCAPIEXPORT tc_matrix tc_getPlotData (int whichPlot)
 get the data in the plot window
TCAPIEXPORT void tc_gnuplot (const char *)
 plot the specific script using gnuplot
TCAPIEXPORT void tc_savePlot (const char *filename)
 save the current plot as a PDF file
TCAPIEXPORT void tc_setLogScale (int)
 set log scale for current plot; argument: 0=x-axis, 1=y-axis, 2=both

Detailed Description

display graphs, save graphs, get graph values


Function Documentation

TCAPIEXPORT tc_matrix tc_clusterPlots ( int  clusters)

perform clustering on plots

Parameters:
intnumber of clusters (must be > 1)
Returns:
tc_matrix cluster ID corresponding to each plot. Rows will equal number of plots
TCAPIEXPORT void tc_errorBars ( tc_matrix  data,
const char *  title 
)

plot the data in the matrix (with headers) with the given x-axis and title. For each column i, the i+1 and i+2 columns should contain the upper and lower bounds (errors).

Parameters:
tc_matrixdata
stringtitle of plot
TCAPIEXPORT tc_matrix tc_getPlotData ( int  whichPlot)

get the data in the plot window

Parameters:
intindex of the plot (if multiple plots are being displayed)
Returns:
tc_matrix data
TCAPIEXPORT void tc_gnuplot ( const char *  )

plot the specific script using gnuplot

Parameters:
stringgnuplot commands
TCAPIEXPORT void tc_hist ( tc_matrix  data,
const char *  title 
)

plot histogram for each column of the given matrix with the given bin size.

Parameters:
tc_matrixdata
stringtitle of plot
TCAPIEXPORT void tc_holdPlot ( int  on)

hold current plot and plot on top of it

Parameters:
inton(1) or off (0)
TCAPIEXPORT void tc_multiplot ( int  rows,
int  cols 
)

enable multi-plot, i.e. multiple plots on one screen. specify the number of rows and columns for the layout.

Parameters:
intnumber of rows
intnumber of columns
TCAPIEXPORT void tc_plot ( tc_matrix  data,
const char *  title 
)

plot the data in the matrix (with headers) with the given x-axis and title

Parameters:
tc_matrixdata with first column being the x-axis
stringtitle of plot
TCAPIEXPORT void tc_savePlot ( const char *  filename)

save the current plot as a PDF file

Parameters:
stringfilename (PDF suffix)
TCAPIEXPORT void tc_scatterplot ( tc_matrix  data,
const char *  title 
)

plot the data in the matrix (with headers) as a scatter plot

Parameters:
tc_matrixdata with first column as x-axis
stringtitle of plot
TCAPIEXPORT void tc_setLogScale ( int  )

set log scale for current plot; argument: 0=x-axis, 1=y-axis, 2=both

Parameters:
int0=x-axis, 1=y-axis, 2=both
BEGIN_C_DECLS TCAPIEXPORT void tc_surface ( tc_matrix  z,
const char *  title 
)

plot 3D data. Input matrix has x,y on the first two columns and z on the third column

Parameters:
tc_matrixtree column matrix
stringtitle of plot
 All Data Structures