Get help: Forum Bug tracker

ctioga2’s commands

Independently of the way to use ctioga2, though command-line or using command files, one interacts ctioga2 by using commands.

Most commands take compulsory arguments, whose order should be respected, and even more of them accept options, that can be given in any order.

This page describes all the commands known to ctioga2. It is generated automatically from the inline documentation of ctioga2. Arguments to the commands, are links to the corresponding type. So are options.

The Examples are collapsible, just click on them to see the snippets of the corresponding examples, which are links to the full code.

Plots

Plots

Available commands: plot plot-last

Command: plot

Synopsis (file) 

plot dataset /option=...

Synopsis (command-line) 

--plot dataset /option=...

Available options: as bypass-transforms class clipped color color-map contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-number depth error-bar-color error-bar-line-width fill fill-color fill-pattern fill-transparency id ignore-hooks legend line-cap line-style line-width marker marker-angle marker-color marker-color-map marker-fill-color marker-fill-color-map marker-line-color marker-line-color-map marker-line-width marker-min-scale marker-scale name path-style region-side split-on-nan where xaxis yaxis zaxis

Use the current backend to load the given datasets onto the data stack and plot them. It is a combination of the load and the plot-last commands; you might want to see their documentation.

Examples...
plot 'silver.dat'@1:3 /color Black
plot 'silver.dat'@1:3 /color Black
plot 'silver.dat'@'$1:$3+$1/50' /legend=Curve2 /color=Blue
plot "(x>3.5 ? x/3-3 : 1/0)" /fill right
plot 50-x*x /fill=bottom /fill-transparency 0.8 /legend '$50 - x^2$'
plot x*x /color Red
plot cos(x)**2 /fill=bottom /depth=95
plot abs(x) /fill xy=2,5
plot sqrt(10-x)-4.5 /fill -5.5
plot t/3:1.52-(t/3.1415).abs /fill xy=0,1.6 /color Black
plot 'world.dat#1##153' /color DarkGoldenrod /fill close
plot 'a(x, 10,10000).arg*180/PI' /legend='Argument of $A(j \omega)$'
plot cos(atan(x))
plot '-(sin(x) > sin(x+1) ? sin(x) : sin(x+1))'
plot acos(x)
plot 'simple.4-gnuplot.gplt@2' /marker Cross /line-style no /legend=(x**besj0(x))-2.5
plot 'simple.5-gnuplot.gplt' /legend '$\sin(x)^{J_0(x)}$'
plot 1/x
plot 'sin(x*20)*atan(x)' /line-width=0.6
plot 3.dat
plot 'using.dat'@2:4 /legend="Logged in" /line-style no /marker Times
plot 'using.dat'@3:6 /legend "\\%CPU used"
plot '5*sin(x)' /color White /line-width 2
plot 3D-data.dat@1:2:4 /zaxis zvalues /color-map \
plot 3D-data.dat@1:2:4 /zaxis zvalues \
plot 3D-data.dat@1:2:4 /zaxis zvalues \
plot 3D-data.dat@1:2:4 /zaxis zvalues \
plot t:t**2:0.1+sin(t)**2:cos(t) /marker-scale 1.3
plot 3D-data.dat@1:2:5  /zaxis zvalues \
plot sin(12*u*v) /where 'x > 0.3 || y.abs < 0.3'
plot log(x)
plot "(1 + 1e-3 * x**6)**0.5"
plot log(x)
plot log(x)
plot sin(3.141592*x)
plot 0.2*exp(-5e2*x)
plot 'x**2'
  plot 'sin(omega(x) * x)'
  plot 0.1*x**3
plot 'cos(x)'
plot '-sin(x)' /fill-pattern xlines
plot -sin(x) /marker-fill-color=Purple
plot 'sin(x+0##4)'
plot cos(x)**2  /line-style Dashes /legend '$\cos^2x$'
plot 50-x**2 /path-style=impulses /line-width=4 /line-cap=butt
plot exp(-x**2)
plot x**2
plot sin(x**2)
plot data.dat@1:3
plot data.dat@1:3
plot data.dat@1:3
plot 'x**2/2.25'
plot 'cos(x)'
plot '0.2*(1-x)'
plot 'x**3' /legend '$x^3$'
plot 'x**5' /legend '$x^5$'
plot 'x' /legend '$x$' /marker Square
plot 'x**2/4' /marker=Square /id x2
plot "1/($(arg))**0.5 * exp(-x**2/$(arg))"
plot "1/($(arg))**0.5 * exp(-x**2/$(arg))"
plot 'cos(x**3)'
plot x**2
plot(x**2)
plot f(x,x) /color=Purple
plot x**2
plot 'sin(x)'

Command: plot-last

Synopsis (file) 

plot-last /option=...

Synopsis (command-line) 

-p  /option=...
--plot-last  /option=...

Available options: class clipped color color-map contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-number depth error-bar-color error-bar-line-width fill fill-color fill-pattern fill-transparency id legend line-cap line-style line-width marker marker-angle marker-color marker-color-map marker-fill-color marker-fill-color-map marker-line-color marker-line-color-map marker-line-width marker-min-scale marker-scale path-style region-side split-on-nan which xaxis yaxis zaxis

Plots the last dataset pushed onto the data stack (or the one specified with the which option), with the current style. All aspects of the curve style (colors, markers, line styles...) can be overridden through the use of options.

Curves styles

Set stylistic details of curves or other object drawn from data

Available commands: clipped color color-map color-set contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-number depth error-bar-color error-bar-color-set error-bar-line-width error-bar-line-width-set fill fill-color fill-color-set fill-pattern fill-set fill-transparency fill-transparency-set line-cap line-style line-style-set line-width line-width-set marker marker-angle marker-color marker-color-map marker-color-set marker-fill-color marker-fill-color-map marker-fill-color-set marker-line-color marker-line-color-map marker-line-color-set marker-line-width marker-min-scale marker-scale marker-scale-set marker-set path-style path-style-set region-side region-side-set reuse-style skip split-on-nan zaxis

Command: clipped

Synopsis (file) 

clipped boolean-or-auto

Synopsis (command-line) 

--clipped boolean-or-auto

Sets the clipped for subsequent curves, until cancelled with auto as argument.

Command: color

Synopsis (file) 

color color-or-false-or-auto

Synopsis (command-line) 

-c color-or-false-or-auto
--color color-or-false-or-auto

Sets the line color for subsequent curves, until cancelled with auto as argument.

Command: color-map

Synopsis (file) 

color-map colormap-or-auto

Synopsis (command-line) 

--color-map colormap-or-auto

Sets the color map for the subsequent curves, until cancelled by an auto argument.

Color maps are used for 3D plots, ie under the effet of contour, xyz-map and xy-parametric.

Command: color-set

Synopsis (file) 

color-set color-or-false-set

Synopsis (command-line) 

--color-set color-or-false-set

Chooses a set for the line color of subsequent curves. Also sets color to auto, so that the set takes effect immediately

Examples...

Command: contour-conrec

Synopsis (file) 

contour-conrec boolean-or-auto

Synopsis (command-line) 

--contour-conrec boolean-or-auto

If on, the subsequent curves will use the CONREC algorithm for contouring. In the opposite case, the contouring algorithm of Gri is used.

Only useful when contour is in effect.

Command: contour-minor-number

Synopsis (file) 

contour-minor-number integer-or-auto

Synopsis (command-line) 

--contour-minor-number integer-or-auto

Sets the number of minor level lines between major ones (approx) for subsequent curves, until cancelled with auto as argument.

Command: contour-minor-scale

Synopsis (file) 

contour-minor-scale float-or-auto

Synopsis (command-line) 

--contour-minor-scale float-or-auto

Sets the relative scale of minor level lines for subsequent curves, until cancelled with auto as argument.

Command: contour-minor-style

Synopsis (file) 

contour-minor-style line-style-or-auto

Synopsis (command-line) 

--contour-minor-style line-style-or-auto

Sets the minor ticks line style for subsequent curves, until cancelled with auto as argument.

Command: contour-number

Synopsis (file) 

contour-number integer-or-auto

Synopsis (command-line) 

--contour-number integer-or-auto

Sets the overall number of level lines for subsequent curves, until cancelled with auto as argument.

Command: depth

Synopsis (file) 

depth integer-or-auto

Synopsis (command-line) 

--depth integer-or-auto

Sets the depth for subsequent curves, until cancelled with auto as argument.

Command: error-bar-color

Synopsis (file) 

error-bar-color color-or-false-or-auto

Synopsis (command-line) 

--error-bar-color color-or-false-or-auto

Sets the error bar color for subsequent curves, until cancelled with auto as argument.

Command: error-bar-color-set

Synopsis (file) 

error-bar-color-set color-or-false-set

Synopsis (command-line) 

--error-bar-color-set color-or-false-set

Chooses a set for the error bar color of subsequent curves. Also sets error-bar-color to auto, so that the set takes effect immediately

Command: error-bar-line-width

Synopsis (file) 

error-bar-line-width float-or-auto

Synopsis (command-line) 

--error-bar-line-width float-or-auto

Sets the error bar line width for subsequent curves, until cancelled with auto as argument.

Command: error-bar-line-width-set

Synopsis (file) 

error-bar-line-width-set float-set

Synopsis (command-line) 

--error-bar-line-width-set float-set

Chooses a set for the error bar line width of subsequent curves. Also sets error-bar-line-width to auto, so that the set takes effect immediately

Command: fill

Synopsis (file) 

fill fill-until-or-auto

Synopsis (command-line) 

--fill fill-until-or-auto

Sets the Fill until for subsequent curves, until cancelled with auto as argument.

Examples...

Command: fill-color

Synopsis (file) 

fill-color color-or-auto

Synopsis (command-line) 

--fill-color color-or-auto

Sets the fill color for subsequent curves, until cancelled with auto as argument.

Command: fill-color-set

Synopsis (file) 

fill-color-set color-set

Synopsis (command-line) 

--fill-color-set color-set

Chooses a set for the fill color of subsequent curves. Also sets fill-color to auto, so that the set takes effect immediately

Examples...

Command: fill-pattern

Synopsis (file) 

fill-pattern fill-pattern-or-auto

Synopsis (command-line) 

--fill-pattern fill-pattern-or-auto

Sets the fill pattern for subsequent curves, until cancelled with auto as argument.

Command: fill-set

Synopsis (file) 

fill-set fill-until-set

Synopsis (command-line) 

--fill-set fill-until-set

Chooses a set for the Fill until of subsequent curves. Also sets fill to auto, so that the set takes effect immediately

Command: fill-transparency

Synopsis (file) 

fill-transparency float-or-auto

Synopsis (command-line) 

--fill-transparency float-or-auto

Sets the fill transparency for subsequent curves, until cancelled with auto as argument.

Examples...

Command: fill-transparency-set

Synopsis (file) 

fill-transparency-set float-set

Synopsis (command-line) 

--fill-transparency-set float-set

Chooses a set for the fill transparency of subsequent curves. Also sets fill-transparency to auto, so that the set takes effect immediately

Command: line-cap

Synopsis (file) 

line-cap line-cap-or-auto

Synopsis (command-line) 

--line-cap line-cap-or-auto

Sets the line cap for subsequent curves, until cancelled with auto as argument.

Command: line-style

Synopsis (file) 

line-style line-style-or-auto

Synopsis (command-line) 

--line-style line-style-or-auto

Sets the line style for subsequent curves, until cancelled with auto as argument.

Examples...

Command: line-style-set

Synopsis (file) 

line-style-set line-style-set

Synopsis (command-line) 

--line-style-set line-style-set

Chooses a set for the line style of subsequent curves. Also sets line-style to auto, so that the set takes effect immediately

Examples...

Command: line-width

Synopsis (file) 

line-width float-or-auto

Synopsis (command-line) 

--line-width float-or-auto

Sets the line width for subsequent curves, until cancelled with auto as argument.

Command: line-width-set

Synopsis (file) 

line-width-set float-set

Synopsis (command-line) 

--line-width-set float-set

Chooses a set for the line width of subsequent curves. Also sets line-width to auto, so that the set takes effect immediately

Command: marker

Synopsis (file) 

marker marker-or-auto

Synopsis (command-line) 

-m marker-or-auto
--marker marker-or-auto

Sets the marker for subsequent curves, until cancelled with auto as argument.

Examples...

Command: marker-angle

Synopsis (file) 

marker-angle float-or-auto

Synopsis (command-line) 

--marker-angle float-or-auto

Sets the marker angle for subsequent curves, until cancelled with auto as argument.

Command: marker-color

Synopsis (file) 

marker-color color-or-false-or-auto

Synopsis (command-line) 

--marker-color color-or-false-or-auto

Sets the marker color for subsequent curves, until cancelled with auto as argument.

Command: marker-color-map

Synopsis (file) 

marker-color-map colormap-or-auto

Synopsis (command-line) 

--marker-color-map colormap-or-auto

Sets the color map for markers for subsequent curves, until cancelled with auto as argument.

Command: marker-color-set

Synopsis (file) 

marker-color-set color-or-false-set

Synopsis (command-line) 

--marker-color-set color-or-false-set

Chooses a set for the marker color of subsequent curves. Also sets marker-color to auto, so that the set takes effect immediately

Command: marker-fill-color

Synopsis (file) 

marker-fill-color color-or-false-or-auto

Synopsis (command-line) 

--marker-fill-color color-or-false-or-auto

Sets the marker fill color for subsequent curves, until cancelled with auto as argument.

Command: marker-fill-color-map

Synopsis (file) 

marker-fill-color-map colormap-or-auto

Synopsis (command-line) 

--marker-fill-color-map colormap-or-auto

Sets the color map for the lines of markers for subsequent curves, until cancelled with auto as argument.

Command: marker-fill-color-set

Synopsis (file) 

marker-fill-color-set color-or-false-set

Synopsis (command-line) 

--marker-fill-color-set color-or-false-set

Chooses a set for the marker fill color of subsequent curves. Also sets marker-fill-color to auto, so that the set takes effect immediately

Examples...

Command: marker-line-color

Synopsis (file) 

marker-line-color color-or-false-or-auto

Synopsis (command-line) 

--marker-line-color color-or-false-or-auto

Sets the marker stroke color for subsequent curves, until cancelled with auto as argument.

Examples...

Command: marker-line-color-map

Synopsis (file) 

marker-line-color-map colormap-or-auto

Synopsis (command-line) 

--marker-line-color-map colormap-or-auto

Sets the color map for the lines of markers for subsequent curves, until cancelled with auto as argument.

Command: marker-line-color-set

Synopsis (file) 

marker-line-color-set color-or-false-set

Synopsis (command-line) 

--marker-line-color-set color-or-false-set

Chooses a set for the marker stroke color of subsequent curves. Also sets marker-line-color to auto, so that the set takes effect immediately

Command: marker-line-width

Synopsis (file) 

marker-line-width float-or-auto

Synopsis (command-line) 

--marker-line-width float-or-auto

Sets the marker line width for subsequent curves, until cancelled with auto as argument.

Examples...

Command: marker-min-scale

Synopsis (file) 

marker-min-scale float-or-false-or-auto

Synopsis (command-line) 

--marker-min-scale float-or-false-or-auto

Sets the marker scale for subsequent curves, until cancelled with auto as argument.

Command: marker-scale

Synopsis (file) 

marker-scale float-or-auto

Synopsis (command-line) 

--marker-scale float-or-auto

Sets the marker scale for subsequent curves, until cancelled with auto as argument.

Examples...

Command: marker-scale-set

Synopsis (file) 

marker-scale-set float-set

Synopsis (command-line) 

--marker-scale-set float-set

Chooses a set for the marker scale of subsequent curves. Also sets marker-scale to auto, so that the set takes effect immediately

Command: marker-set

Synopsis (file) 

marker-set marker-set

Synopsis (command-line) 

--marker-set marker-set

Chooses a set for the marker of subsequent curves. Also sets marker to auto, so that the set takes effect immediately

Command: path-style

Synopsis (file) 

path-style text-or-auto

Synopsis (command-line) 

--path-style text-or-auto

Sets the path style for subsequent curves, until cancelled with auto as argument.

Command: path-style-set

Synopsis (file) 

path-style-set text-set

Synopsis (command-line) 

--path-style-set text-set

Chooses a set for the path style of subsequent curves. Also sets path-style to auto, so that the set takes effect immediately

Command: region-side

Synopsis (file) 

region-side region-side-or-auto

Synopsis (command-line) 

--region-side region-side-or-auto

Sets the region side for subsequent curves, until cancelled with auto as argument.

Command: region-side-set

Synopsis (file) 

region-side-set region-side-set

Synopsis (command-line) 

--region-side-set region-side-set

Chooses a set for the region side of subsequent curves. Also sets region-side to auto, so that the set takes effect immediately

Command: reuse-style

Synopsis (file) 

reuse-style object

Synopsis (command-line) 

--reuse-style object

After using this command, the next curve will have the same style as the curve whose name was given as the first argument (it is the name given to the `/id=` option to plot.

Examples...

Command: skip

Synopsis (file) 

skip /option=...

Synopsis (command-line) 

--skip  /option=...

Available options: number

This command acts as if one (or number) dataset had been drawn with respect to the style of the next dataset to be drawn.

Examples...

Command: split-on-nan

Synopsis (file) 

split-on-nan boolean-or-auto

Synopsis (command-line) 

--split-on-nan boolean-or-auto

In general, the NaN (not a number, ie invalid data points in the dataset) in a dataset are silently ignored. When this option is on, the lines of xy-plot-style plots are split upon encountering a NaN.

Command: zaxis

Synopsis (file) 

zaxis text-or-auto

Synopsis (command-line) 

--zaxis text-or-auto

Sets the name of the zaxis for the subsequent curves. This must be an axis that has been previously created using new-zaxis.

This axis will be used to display the colormaps of the following curve.

Legends

Commands to specify legends and tweak their look.

Available commands: auto-legend legend legend-inside legend-line legend-multicol legend-multicol-end legend-style

Command: auto-legend

Synopsis (file) 

auto-legend boolean

Synopsis (command-line) 

--auto-legend boolean

When this option is in effect (off by default), all datasets get a legend, their 'dataset name', unless another legend is manually specified.

Examples...

Command: legend

Synopsis (file) 

legend text

Synopsis (command-line) 

-l text
--legend text

Sets the legend for the next dataset. Overridden by the legend option to the plot command.

Examples...

Command: legend-inside

Synopsis (file) 

legend-inside aligned-point /option=...

Synopsis (command-line) 

--legend-inside aligned-point /option=...

Available options: class dy frame-cap frame-color frame-fill-color frame-fill-pattern frame-fill-transparency frame-padding frame-radius frame-shape frame-style frame-width id picto-height picto-to-text picto-width scale symbol-scale text-scale vpadding

Using this command sets the position of the legends for the current (sub)plot inside it, at the precise location given.

As a shortcut, legend-inside also takes all the options that legend-style takes, with the same effect.

Examples...

Command: legend-line

Synopsis (file) 

legend-line text /option=...

Synopsis (command-line) 

--legend-line text /option=...

Available options: align alignment angle color halign justification position scale shift text-align text-width valign

Adds a line of text unrelated to any curve to the legend.

The options controlling the aspect of the legend are documented in the define-text-style command.

Examples...

Command: legend-multicol

Synopsis (file) 

legend-multicol /option=...

Synopsis (command-line) 

--legend-multicol  /option=...

Available options: columns dx

Following legends will be layed out in multiple columns, until a call to legend-multicol-end.

Examples...

Command: legend-multicol-end

Synopsis (file) 

legend-multicol-end

Synopsis (command-line) 

--legend-multicol-end

Stop layout out legends in several columns

Examples...

Command: legend-style

Synopsis (file) 

legend-style /option=...

Synopsis (command-line) 

--legend-style  /option=...

Available options: class dy frame-cap frame-color frame-fill-color frame-fill-pattern frame-fill-transparency frame-padding frame-radius frame-shape frame-style frame-width id picto-height picto-to-text picto-width scale symbol-scale text-scale vpadding

Sets the various aspects of the style of the legends throught its options:

  • dy: the spacing between the baseline of consecutive lines; it is deprecated now in favor of vpadding;
  • vpadding: the space left between the bottom of a line and the top of the next one;
  • scale: the overall scale of the legends
  • text-scale: the scale of the text (and the markers) inside the legends

The frame- options control the drawing of a frame around the legend; they have the same meaning as corresponding ones of define-box-style with the frame- bit dropped.

Switch between different kinds of plots

How to switch between different kinds of plot types

Available commands: contour histogram xy-parametric xy-plot xyz-map

Command: contour

Synopsis (file) 

contour

Synopsis (command-line) 

--contour

Switch to contour plots for later curves. Contour plots need three columns (X,Y,Z). They have major and minor lines.

Examples...

Command: histogram

Synopsis (file) 

histogram /option=...

Synopsis (command-line) 

--histogram  /option=...

Available options: compute-dx cumulative gap intra-sep

Switch to drawing histograms.

Examples...

Command: xy-parametric

Synopsis (file) 

xy-parametric /option=...

Synopsis (command-line) 

--xy-parametric  /option=...

Available options: z1 z2 z3 z4

Switch to XY parametric plots, that is standard XY plots whose appearance (such as color, marker color, and, potentially, marker kinds and more) are governed by one (or more ?) Z values.

Examples...

Command: xy-plot

Synopsis (file) 

xy-plot

Synopsis (command-line) 

--xy-plot

Switch (back) to standard XY plots (ctioga's default)

Examples...

Command: xyz-map

Synopsis (file) 

xyz-map

Synopsis (command-line) 

--xyz-map

Switch to XYZ maps, ie plots where the color at a XY location is given by its Z value.

Examples...

Plot coordinates

Plot coordinates

Available commands: margin xfact xlog xoffset xrange xscale yfact ylog yoffset yrange yscale

Command: margin

Synopsis (file) 

margin float

Synopsis (command-line) 

--margin float

Leaves a margin around the data points. Expressed in relative size of the whole plot.

Examples...

Command: xfact

Synopsis (file) 

xfact float

Synopsis (command-line) 

--xfact float

Alias for xscale.

Command: xlog

Synopsis (file) 

xlog boolean

Synopsis (command-line) 

--xlog boolean

Uses a logarithmic scale for the X axis.

Examples...

Command: xoffset

Synopsis (file) 

xoffset float

Synopsis (command-line) 

--xoffset float

Adds the given offset to all X coordinates.

Command: xrange

Synopsis (file) 

xrange partial-float-range

Synopsis (command-line) 

--xrange partial-float-range

Sets the range of the X coordinates.

*Important note:* when the axis is in log range (using xlog), the numbers you give are not the or ylog values, but their log10, so that to display X values from 1e-2 to 1e3, use: 

xyrange -2:3
Examples...

Command: xscale

Synopsis (file) 

xscale float

Synopsis (command-line) 

--xscale float

Multiplies the X coordinates by this factor.

Command: yfact

Synopsis (file) 

yfact float

Synopsis (command-line) 

--yfact float

Alias for yscale.

Command: ylog

Synopsis (file) 

ylog boolean

Synopsis (command-line) 

--ylog boolean

Uses a logarithmic scale for the Y axis.

Examples...

Command: yoffset

Synopsis (file) 

yoffset float

Synopsis (command-line) 

--yoffset float

Adds the given offset to all Y coordinates.

Examples...

Command: yrange

Synopsis (file) 

yrange partial-float-range

Synopsis (command-line) 

--yrange partial-float-range

Sets the range of the Y coordinates.

*Important note:* when the axis is in log range (using ylog), the numbers you give are not the or ylog values, but their log10, so that to display Y values from 1e-2 to 1e3, use: 

yyrange -2:3
Examples...

Command: yscale

Synopsis (file) 

yscale float

Synopsis (command-line) 

--yscale float

Multiplies the Y coordinates by this factor.

Graphics primitives

Tioga graphics primitives

Available commands: draw draw-arrow draw-box draw-color-list draw-color-set-list draw-contour draw-image draw-legend-pictogram draw-line draw-line-style-list draw-marker draw-marker-list draw-marker-set-list draw-oriented-line draw-string-marker draw-tangent draw-text

Command: draw

Synopsis (file) 

draw drawing-spec

Synopsis (command-line) 

--draw drawing-spec

Tries to emulate the old --draw behavior of ctioga. Don't use it for new things.

Command: draw-arrow

Synopsis (file) 

draw-arrow point point /option=...

Synopsis (command-line) 

--draw-arrow point point /option=...

Available options: cap class clipped color depth head-angle head-color head-marker head-scale id line-style line-width style tail-angle tail-color tail-marker tail-scale width

Draws arrow on the current plot, using the given style. For more information on the available options, see the define-arrow-style command.

Examples...

Command: draw-box

Synopsis (file) 

draw-box point point /option=...

Synopsis (command-line) 

--draw-box point point /option=...

Available options: cap class clipped color depth fill-color fill-transparency fill-color fill-pattern fill-transparency id radius shape style width

Draws box on the current plot, using the given style. For more information on the available options, see the define-box-style command.

Command: draw-color-list

Synopsis (file) 

draw-color-list point dimension /option=...

Synopsis (command-line) 

--draw-color-list point dimension /option=...

Available options: class clipped columns depth id padding scale

Directly draws the list of all named colors on the current plot

Command: draw-color-set-list

Synopsis (file) 

draw-color-set-list point dimension /option=...

Synopsis (command-line) 

--draw-color-set-list point dimension /option=...

Available options: class clipped depth exclude id include scale

Directly draws the list of all color sets on the current plot

Command: draw-contour

Synopsis (file) 

draw-contour level /option=...

Synopsis (command-line) 

--draw-contour level /option=...

Available options: class clipped closed color depth id style width

Directly draws contour on the current plot

Examples...

Command: draw-image

Synopsis (file) 

draw-image file top-left bottom-right /option=...

Synopsis (command-line) 

--draw-image file top-left bottom-right /option=...

Available options: aspect-ratio auto-rotate class clipped depth id transparency

Draws image on the current plot, using the given style. For more information on the available options, see the define-image-style command.

Examples...

Command: draw-legend-pictogram

Synopsis (file) 

draw-legend-pictogram point object /option=...

Synopsis (command-line) 

--draw-legend-pictogram point object /option=...

Available options: class clipped depth id width

Draws the legend pictogram for the given curve

Examples...

Command: draw-line

Synopsis (file) 

draw-line point point /option=...

Synopsis (command-line) 

--draw-line point point /option=...

Available options: cap class clipped color depth head-angle head-color head-marker head-scale id line-style line-width style tail-angle tail-color tail-marker tail-scale width

Draws line on the current plot, using the given style. For more information on the available options, see the define-line-style command.

Examples...

Command: draw-line-style-list

Synopsis (file) 

draw-line-style-list point dimension /option=...

Synopsis (command-line) 

--draw-line-style-list point dimension /option=...

Available options: class clipped columns depth id padding scale

Directly draws the list of all named line styles on the current plot

Command: draw-marker

Synopsis (file) 

draw-marker point marker /option=...

Synopsis (command-line) 

--draw-marker point marker /option=...

Available options: alignment angle class clipped color depth fill-color horizontal-scale id justification scale stroke-color stroke-width vertical-scale

Draws marker on the current plot, using the given style. For more information on the available options, see the define-marker-style command.

Command: draw-marker-list

Synopsis (file) 

draw-marker-list point dimension /option=...

Synopsis (command-line) 

--draw-marker-list point dimension /option=...

Available options: class clipped columns depth id padding scale

Directly draws the list of all named markers on the current plot

Command: draw-marker-set-list

Synopsis (file) 

draw-marker-set-list point dimension /option=...

Synopsis (command-line) 

--draw-marker-set-list point dimension /option=...

Available options: class clipped depth exclude id include scale

Directly draws the list of all marker sets on the current plot

Command: draw-oriented-line

Synopsis (file) 

draw-oriented-line point dimension /option=...

Synopsis (command-line) 

--draw-oriented-line point dimension /option=...

Available options: angle cap class clipped color depth head-angle head-color head-marker head-scale id origin style tail-angle tail-color tail-marker tail-scale width

Draws oriented-line on the current plot, using the given style. For more information on the available options, see the define-oriented-line-style command.

Command: draw-string-marker

Synopsis (file) 

draw-string-marker point text /option=...

Synopsis (command-line) 

--draw-string-marker point text /option=...

Available options: alignment angle class clipped color depth fill-color font horizontal-scale id justification scale stroke-color stroke-width vertical-scale

Draws marker on the current plot, using the given style. For more information on the available options, see the define-marker-style command.

Command: draw-tangent

Synopsis (file) 

draw-tangent data-point /option=...

Synopsis (command-line) 

--draw-tangent data-point /option=...

Available options: cap class clipped color depth head-angle head-color head-marker head-scale id line-style line-width nbavg style tail-angle tail-color tail-marker tail-scale width xextent xfrom xto yextent yfrom yto

Draws tangent on the current plot, using the given style. For more information on the available options, see the define-arrow-style command.

Examples...

Command: draw-text

Synopsis (file) 

draw-text point text /option=...

Synopsis (command-line) 

--draw-text point text /option=...

Available options: alignment angle class clipped color depth font halign id justification position scale shift text-align text-width valign

Draws text on the current plot, using the given style. For more information on the available options, see the define-text-style command.

Examples...
draw-text 0.02,-0.6 "ctioga2" 
draw-text 5,25 "(Weekend)" 
draw-text 0,0.3 'Half height width: $w = \sqrt{\ln 2}$' /text-width=3cm 
draw-text -4.5,0.8 '$t = '$(time)'$' /justification=left

The 'direct' backend: Direct format

The commands in this group drive the behaviour of the direct backend; see its documentation for more information

Available commands: direct

Command: direct

Synopsis (file) 

direct

Synopsis (command-line) 

--direct

Selects the 'direct' backend

The 'gnuplot' backend: Gnuplot files

The commands in this group drive the behaviour of the gnuplot backend; see its documentation for more information

Available commands: gnuplot gnuplot-range gnuplot-samples gnuplot-vars

Command: gnuplot

Synopsis (file) 

gnuplot /option=...

Synopsis (command-line) 

--gnuplot  /option=...

Available options: range samples vars

Selects the 'gnuplot' backend

Examples...

Command: gnuplot-range

Synopsis (file) 

gnuplot-range range

Synopsis (command-line) 

--gnuplot-range range

The plotting X range, such as 0:2

Command: gnuplot-samples

Synopsis (file) 

gnuplot-samples samples

Synopsis (command-line) 

--gnuplot-samples samples

The number of samples

Command: gnuplot-vars

Synopsis (file) 

gnuplot-vars vars

Synopsis (command-line) 

--gnuplot-vars vars

A colon-separated override of local variables, such as a=1;b=3;c=5

The 'math' backend: Mathematical functions

The commands in this group drive the behaviour of the math backend; see its documentation for more information

Available commands: math math-log math-samples math-trange math-xrange

Command: math

Synopsis (file) 

math /option=...

Synopsis (command-line) 

--math  /option=...

Available options: log samples trange xrange

Selects the 'math' backend

Examples...
math /xrange=-10:10
math 
math 
math
math
math /xrange=0:10
math /trange=-3.141592:3.141592
math /xrange 1.1:9e4 /log=true
math /samples 50 /xrange -10:10
math /samples 100 /xrange -1.57079:3.141593
math /xrange -3:5 /samples 200
math /xrange -15.7075:15.7075
math /samples=800 /xrange=-30:20
math /xrange -15:15
math /trange 0:20 /samples=50
ctioga2 -X --math 'sin(x)' 'cos(x)' -y '$y$ values' \
ctioga2 -X --math 'sin(x)' 'cos(x)' \
ctioga2 -X --math --margin 0.03 \
ctioga2 -X --math --ylog --margin 0.03 \
ctioga2 -X --math 'sin(x)' 'cos(x)' \
math /xrange 1e3:7e5
math 
math /xrange 1e3:7e5
math /xrange 1e3:7e5
math /xrange -2:2
math /xrange 3e-2:5e-2
ctioga2 -X --math 'sin(x)' --page-size '7cmx12cm'
ctioga2 -X --math 'x**2' --inset 'tl:0.2,0.8:0.4,0.3' \
ctioga2 -X --math --setup-grid 2x2 /top 5mm \
ctioga2 -X --math --setup-grid 2x2 /top 5mm \
math

math 
math 
ctioga2 -X --math --region /color Blue /transparency 0.7 \
ctioga2 -X --math --region /color Blue /transparency 0.7 \
ctioga2 -X --math 'sin(x)' 'sin(x+1)' 'sin(x+2)' 'sin(x+3)' \
ctioga2 -X --math --line-style auto 'sin(x)' 'sin(x+1)' --line-style Solid \
ctioga2 -X --math /samples 31 --marker auto 'sin(x)' \
ctioga2 -X --math /samples 31 --marker auto 'sin(x)' \
ctioga2 -X --math --fill axis 'sin(x)' /fill-color '#fcc'
ctioga2 -X --math --fill axis --fill-transparency 0.6 \
math 
math 
ctioga2 -X --math --gradient Red Blue \
ctioga2 -X --math  --color-set 'Red|Blue|Green' \
math /samples=51
math /samples=51
math
math /samples=11
ctioga2 -X --math /xrange -1:1 /samples 101 'x**2' 'x' 
ctioga2 -X --math /xrange -1:1 /samples 31 --marker auto \
ctioga2 -X --math /trange -3.1415:3.1415 /samples 101 'sin(t):cos(t)' \
math /xrange=-3:3
math /xrange=-3:3
math /xrange=-3:3
math /samples=15 /xrange=-1.5:1.5
math /samples=15 /xrange=-1.5:1.5
math /samples=15 /xrange=-1:1
ctioga2 -X --math --legend '$\sin x$' 'sin(x)' \
ctioga2 -X --math --legend-line 'Trigonometric' /color Blue \
	-X --math --legend-line 'Trigonometric' /color Blue \
ctioga2 -X --math \
ctioga2 -X --math \
math
math /xrange=-1:1
math /samples=20
math
math /xrange -5:5
math /xrange -5:5
ctioga2 -X --math /xrange -3:3 'sin(3.1415*x)' \
ctioga2 -X --math /xrange -3:3 'sin(3.1415*x)' \
ctioga2 -X --math /xrange -3:3 'sin(3.1415*x)' \
ctioga2 -X --math --setup-grid 2x2 /top 5mm \
math
ctioga2 --math --color-set 'Blue|Green|Pink|Orange' \
math /xrange = -1:1
math(/xrange=-1:1)
math /samples=1000

math 
ctioga2 --title 'A nice title, for sure' --math 'sin(x)' \
math

Command: math-log

Synopsis (file) 

math-log log

Synopsis (command-line) 

--math-log log

Space samples logarithmically

Command: math-samples

Synopsis (file) 

math-samples samples

Synopsis (command-line) 

--math-samples samples

The number of points

Examples...

Command: math-trange

Synopsis (file) 

math-trange trange

Synopsis (command-line) 

--math-trange trange

T range (a:b) (parametric plot)

Command: math-xrange

Synopsis (file) 

math-xrange xrange

Synopsis (command-line) 

--math-xrange xrange

X range (a:b)

The 'smath' backend: Mathematical functions (multi-D)

The commands in this group drive the behaviour of the smath backend; see its documentation for more information

Available commands: smath smath-samples smath-urange smath-usamples smath-vrange smath-vsamples

Command: smath

Synopsis (file) 

smath /option=...

Synopsis (command-line) 

--smath  /option=...

Available options: samples urange usamples vrange vsamples

Selects the 'smath' backend

Examples...

Command: smath-samples

Synopsis (file) 

smath-samples samples

Synopsis (command-line) 

--smath-samples samples

Number of samples (default, overriden by variable-specific specs)

Command: smath-urange

Synopsis (file) 

smath-urange urange

Synopsis (command-line) 

--smath-urange urange

U range (a:b)

Command: smath-usamples

Synopsis (file) 

smath-usamples usamples

Synopsis (command-line) 

--smath-usamples usamples

Number of U samples

Command: smath-vrange

Synopsis (file) 

smath-vrange vrange

Synopsis (command-line) 

--smath-vrange vrange

V range (a:b)

Command: smath-vsamples

Synopsis (file) 

smath-vsamples vsamples

Synopsis (command-line) 

--smath-vsamples vsamples

Number of V samples

The 'text' backend: Text format

The commands in this group drive the behaviour of the text backend; see its documentation for more information

Available commands: csv text text-col text-header-line text-parameters text-separator text-skip text-split

Command: csv

Synopsis (file) 

csv

Synopsis (command-line) 

--csv

Now parse the following data files as CSV. Equivalent to 

text /separator=/[,;]/

Command: text

Synopsis (file) 

text /option=...

Synopsis (command-line) 

--text  /option=...

Available options: col header-line parameters separator skip split

Selects the 'text' backend

Examples...
text /split=true

Command: text-col

Synopsis (file) 

text-col col

Synopsis (command-line) 

--text-col col

Which columns to use when the @1:2 syntax is not used

Command: text-header-line

Synopsis (file) 

text-header-line header-line

Synopsis (command-line) 

--text-header-line header-line

Regular expression indicating the header line (containing column names) (default /^##/

Command: text-parameters

Synopsis (file) 

text-parameters parameters

Synopsis (command-line) 

--text-parameters parameters

Regular expression for extracting parameters from a file. Defaults to nil (ie nothing)

Command: text-separator

Synopsis (file) 

text-separator separator

Synopsis (command-line) 

--text-separator separator

The columns separator. Defaults to / +/

Examples...
ctioga2 -X --text-separator , data.csv @1:3

Command: text-skip

Synopsis (file) 

text-skip skip

Synopsis (command-line) 

--text-skip skip

Number of lines to be skipped at the beginning of the file

Command: text-split

Synopsis (file) 

text-split split

Synopsis (command-line) 

--text-split split

If true, splits files into subsets on blank/non number lines

LaTeX

Commands providing control over the LaTeX output (preamble, packages...)

Available commands: preamble set-global-font use utf8

Command: preamble

Synopsis (file) 

preamble text

Synopsis (command-line) 

--preamble text

Adds the given string to the LaTeX preamble of the output.

Command: set-global-font

Synopsis (file) 

set-global-font /option=...

Synopsis (command-line) 

--set-global-font  /option=...

Available options: size

Set global font. Sets the size of everything, including that of text that has already been used.

Command: use

Synopsis (file) 

use text /option=...

Synopsis (command-line) 

--use text /option=...

Available options: arguments

Adds a command to include the LaTeX package into the preamble. The arguments, if given, are given within [square backets].

Command: utf8

Synopsis (file) 

utf8

Synopsis (command-line) 

--utf8

Makes ctioga2 use UTF-8 for all text. It is exactly equivalent to the command preamble with the argument: 

\usepackage[utf8]{inputenc}\usepackage[T1]{fontenc}

Subplots and assimilated

Subplots and assimilated

Available commands: end frame-margins gradient hide inset next-inset padding plot-scale region reopen root-plot setup-grid text-adjust-mode

Command: end

Synopsis (file) 

end

Synopsis (command-line) 

--end

Leaves the current subobject.

Examples...

Command: frame-margins

Synopsis (file) 

frame-margins frame-margins /option=...

Synopsis (command-line) 

--frame-margins frame-margins /option=...

Available options: bottom left right top

Sets the margins for the current plot. Margins are the same things as the position (such as specified for and inset). Using this within an inset or more complex plots might produce unexpected results. The main use of this function is to control the padding around simple plots.

The options override the contents of the margin, which makes it easy to set all the dimensions to a given value and just override the ones you need to: 

frame-margins 2mm /left=1cm

This sets all the margins around the side to 2mm excepted the left one, which means in particular the bottom axis tick labels will be cut.

Command: gradient

Synopsis (file) 

gradient color color /option=...

Synopsis (command-line) 

--gradient color color /option=...

Available options: class id

All the curves between this command and the corresponding end will have their color set to a weighted average of the colors given as argument. This gives a neat gradient effect.

Examples...

Command: hide

Synopsis (file) 

hide objects /option=...

Synopsis (command-line) 

--hide objects /option=...

Available options: show

Hides all the named objects in the list. Useful for creating animations.

Command: inset

Synopsis (file) 

inset box /option=...

Synopsis (command-line) 

--inset box /option=...

Available options: class id

Starts a new inset within the given box.

If no graph has been started yet, it just creates a new graph using the given box. In short, it does what it seems it should.

Examples...

Command: next-inset

Synopsis (file) 

next-inset box /option=...

Synopsis (command-line) 

--next-inset box /option=...

Available options: class id

Has the same effet as end followed by inset.

Particularly useful for chaining subgraphs. In that case, you might be interested in the grid box specification and setup-grid.

Examples...

Command: padding

Synopsis (file) 

padding dimension

Synopsis (command-line) 

--padding dimension

When the frame-margins is set to automatic, ctioga2 leaves that much space around the plot on the sides where there are no labels.

Command: plot-scale

Synopsis (file) 

plot-scale float /option=...

Synopsis (command-line) 

--plot-scale float /option=...

Available options: what

Applies a scaling factor to the whole current subplot. Depending on the 'what' option (default text), the scale applies to:

  • text ('text' or 'both')
  • marker size ('text' or 'both')
  • line widths ('lines' or 'both') Scaling also applies to all elements of the plot that were added before the call to plot-scale.

Command: region

Synopsis (file) 

region /option=...

Synopsis (command-line) 

--region  /option=...

Available options: class color id pattern reversed-color reversed-pattern reversed-transparency transparency

The curves up to the corresponding end will be considered for delimiting a colored region between them. The actual position of the curves with respect to the region can be fine-tuned using the region-side command (or the corresponding option to plot).

Examples...

Command: reopen

Synopsis (file) 

reopen object

Synopsis (command-line) 

--reopen object

Reopens a previously finished container, such as a subplot, a region or a gradient. Provide the unique name you gave as the /id= option to the first command

Command: root-plot

Synopsis (file) 

root-plot /option=...

Synopsis (command-line) 

--root-plot  /option=...

Available options: class id

Begins the root plot. This command is only necessary if you want to give styling information to the root plot.

Command: setup-grid

Synopsis (file) 

setup-grid text /option=...

Synopsis (command-line) 

--setup-grid text /option=...

Available options: bottom dx dy left right top

Sets up a grid of the given layout (such as 2x1). After this command, arguments such as grid:0,1 can be used as the box argument of inset and next-inset commands.

Alternatively, the layout can be specified as 1,2,1x1,4, in which case there are three columns and two rows; the second column is 2 times larger than the other ones, while the second row is four times larger than the first.

Examples...

Command: text-adjust-mode

Synopsis (file) 

text-adjust-mode text-adjust-mode

Synopsis (command-line) 

--text-adjust-mode text-adjust-mode

When this is on (the default), ctioga2 tries to be smart about the size of the text bits around the plot. However, this can be bothersome at times, so you can disable that with this command.

Axes and labels

Axes and labels

Available commands: axis-style background-grid background-lines bottom clear-axes drawing-frame label-style left new-zaxis no-title no-xlabel no-ylabel right ticks title top x2 xaxis xlabel y2 yaxis ylabel

Command: axis-style

Synopsis (file) 

axis-style axis /option=...

Synopsis (command-line) 

--axis-style axis /option=...

Available options: also-axes axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width decoration line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

This command can be used to set various aspects of the style of the given axis, through its various options, which are documented in more details in the define-axis-style command -- excepted for the ticks bit which are documented in the ticks command.

If the option also-axes is specified, the style is also applied to the comma-separated list of axes it contains.

Examples...

Command: background-grid

Synopsis (file) 

background-grid color-or-false /option=...

Synopsis (command-line) 

--background-grid color-or-false /option=...

Available options: cap style width

Shortcut to set the color for the left and bottom axes

Command: background-lines

Synopsis (file) 

background-lines axis color-or-false /option=...

Synopsis (command-line) 

--background-lines axis color-or-false /option=...

Available options: cap style width

Sets the color of the background lines for the given axis.

Examples...

Command: bottom

Synopsis (file) 

bottom axis-decoration /option=...

Synopsis (command-line) 

--bottom axis-decoration /option=...

Available options: axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

Sets the type of the bottom axis.

The options have the same meaning as for define-axis-style, see that command for more information.

Examples...

Command: clear-axes

Synopsis (file) 

clear-axes

Synopsis (command-line) 

--clear-axes

Removes all the axes and their associated labels

Examples...

Command: drawing-frame

Synopsis (file) 

drawing-frame /option=...

Synopsis (command-line) 

--drawing-frame  /option=...

Available options: units

Setup a drawing frame, ie a frame in which the top-left point is at 0,0, with X and Y values positive over the whole frame, and counted in centimeters (or with the unit given using the /units option, ie /units=mm expressed in millimeters or /units=12pt expressed in multiple of 12 TeX points).

Command: label-style

Synopsis (file) 

label-style label /option=...

Synopsis (command-line) 

--label-style label /option=...

Available options: align alignment angle color halign justification loc position scale shift text text-align text-width valign

Sets the style of the given label (see the type label for more information). See define-text-style for detailed information about the meaning of the options.

The option text permits to also set the text of the label (does not work for ticks).

For tick labels, setting the color option also sets the color for the lines of the corresponding axis. If you don't want that, you can override the color using the stroke-color option of axis-style. This will only work with Tioga version 1.11 or greater.

Examples...

Command: left

Synopsis (file) 

left axis-decoration /option=...

Synopsis (command-line) 

--left axis-decoration /option=...

Available options: axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

Sets the type of the left axis.

The options have the same meaning as for define-axis-style, see that command for more information.

Command: new-zaxis

Synopsis (file) 

new-zaxis text /option=...

Synopsis (command-line) 

--new-zaxis text /option=...

Available options: axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width bar-shift bar-size bounds class decoration id line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset padding stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

Creates a named Z axis that can display information from Z color maps

Examples...

Command: no-title

Synopsis (file) 

no-title

Synopsis (command-line) 

--no-title

Removes the title of the current plot.

Command: no-xlabel

Synopsis (file) 

no-xlabel

Synopsis (command-line) 

--no-xlabel

Removes the X label for the current plot.

Examples...

Command: no-ylabel

Synopsis (file) 

no-ylabel

Synopsis (command-line) 

--no-ylabel

Removes the Y label for the current plot.

Examples...

Command: right

Synopsis (file) 

right axis-decoration /option=...

Synopsis (command-line) 

--right axis-decoration /option=...

Available options: axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

Sets the type of the right axis.

The options have the same meaning as for define-axis-style, see that command for more information.

Examples...

Command: ticks

Synopsis (file) 

ticks axis /option=...

Synopsis (command-line) 

--ticks axis /option=...

Available options: format format-last labels major major-delta major-number major-sep minor minor-delta minor-number minor-sep-min

This command can be used to control the location of major and minor ticks and the text of their labels for the given axis. Options available:

  • format the format of the tick labels, using a sprintf-like syntax (see below)
  • format-last the format of the last of the tick labels (useful to include an overall "power-of-ten" factor
  • major a space or comma-separated list of the positions of the major (labeled) ticks
  • minor same for the minor ticks
  • label a comma-separated list of the tick labels (must be the same number of elements as that of the major list). If you must include a comma inside, then use || as a separator.

Format is a normal sprintf format, with the following additional special codes:

  • %p the "common power of 10": if you divide the tick values by 10 to the power %p, the smallest absolute value will be between 1 and 10 (excluding 0 of course)
  • %b... is the tick value divided by this common power of 10. You *must* follow this spec by a usual sprintf format: %b.3g would get you a number with 3 significant digits
Examples...

Command: title

Synopsis (file) 

title text /option=...

Synopsis (command-line) 

-t text /option=...
--title text /option=...

Available options: align alignment angle color halign justification loc position scale shift text-align text-width valign

Sets the title of the current plot.

Examples...

Command: top

Synopsis (file) 

top axis-decoration /option=...

Synopsis (command-line) 

--top axis-decoration /option=...

Available options: axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

Sets the type of the top axis.

The options have the same meaning as for define-axis-style, see that command for more information.

Examples...

Command: x2

Synopsis (file) 

x2

Synopsis (command-line) 

--x2

Switches to using the top axis for X axis for the subsequent curves, and turns on full decoration for the right axis. Shortcut for: 

xaxis top
axis-style top /decoration=full

Command: xaxis

Synopsis (file) 

xaxis axis

Synopsis (command-line) 

--xaxis axis

Sets the default axis for the X axis for all subsequent commands take rely on default axes (such as plot, xrange, yrange...).

Command: xlabel

Synopsis (file) 

xlabel text /option=...

Synopsis (command-line) 

-x text /option=...
--xlabel text /option=...

Available options: align alignment angle color halign justification loc position scale shift text-align text-width valign

Sets the X label of the current plot.

Examples...

Command: y2

Synopsis (file) 

y2

Synopsis (command-line) 

--y2

Switches to using the right axis for Y axis for the subsequent curves, and turns on full decoration for the right axis. Shortcut for: 

yaxis right
axis-style right /decoration=full
Examples...

Command: yaxis

Synopsis (file) 

yaxis axis

Synopsis (command-line) 

--yaxis axis

Sets the default axis for the Y axis for all subsequent commands take rely on default axes (such as plot, xrange, yrange...).

Command: ylabel

Synopsis (file) 

ylabel text /option=...

Synopsis (command-line) 

-y text /option=...
--ylabel text /option=...

Available options: align alignment angle color halign justification loc position scale shift text-align text-width valign

Sets the Y label of the current plot.

Examples...

Background

Commands dealing with the aspect of the background of a plot (excluding background lines, which are linked to axes).

Available commands: background watermark

Command: background

Synopsis (file) 

background color-or-false

Synopsis (command-line) 

--background color-or-false

Sets the background color for the current (and subsequent?) plot.

Examples...

Command: watermark

Synopsis (file) 

watermark text /option=...

Synopsis (command-line) 

--watermark text /option=...

Available options: alignment angle color fill-color font horizontal-scale justification scale stroke-color stroke-width vertical-scale

Sets a watermark for the background of the current plot.

Default styles

Commands for defining default styles.

All commands take the selector of the style to be defined. It is a CSS-like selector, relying on #id and .class, and using #parentality. Therefore, defining a style for .insets #stuff will define it for an object named stuff, but only if it is contained within another one that has a .insets class.

ctioga2 does not support changing a style after its use. It may affect only the following objects or all the ones that were created from the beginning, depending on the context. For safety, only define style before issueing any graphics command.

Available commands: define-arrow-style define-axis-style define-background-style define-box-style define-curve-style define-image-style define-legend-style define-line-style define-marker-style define-oriented-line-style define-style define-text-style define-title-style load-style

Command: define-arrow-style

Synopsis (file) 

define-arrow-style text /option=...

Synopsis (command-line) 

--define-arrow-style text /option=...

Available options: cap color head-angle head-color head-marker head-scale style tail-angle tail-color tail-marker tail-scale width

Sets the default style for arrows. All arrow styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the draw-arrow command.

Meaning of the style parameters:

  • color, style and width: same as in define-line-style
  • head-marker, tail-marker: a marker to be used for the head or for the tail
  • head-scale, tail-scale: scale of the head or tail markers
  • head-angle, tail-angle: rotate the head or the tail by that many degrees
  • head-color, tail-color: the color of the head or tail
Examples...

Command: define-axis-style

Synopsis (file) 

define-axis-style text /option=...

Synopsis (command-line) 

--define-axis-style text /option=...

Available options: axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-lines-cap background-lines-color background-lines-style background-lines-width decoration line-width location log major-tick-length major-tick-width minor-tick-length minor-tick-width offset stroke-color tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform

Sets the style for a whole axis. All axis styles descend from the base style. Horizontal and vertical axis styles descend from the x and y styles, and plot sides are styled with the left, right, top and bottom styles.

Axis styles have lots of parameters:

  • axis-label- and tick-label- parameters are title style parameters whose meaning is given in define-title-style, that affect ticks and axis labels
  • decoration: a axis-decoration that specify which ticks and tick labels to draw
  • background-lines- parameters define the style of background lines, as in define-line-style
Examples...

Command: define-background-style

Synopsis (file) 

define-background-style text /option=...

Synopsis (command-line) 

--define-background-style text /option=...

Available options: background-color watermark watermark-alignment watermark-angle watermark-color watermark-fill-color watermark-font watermark-horizontal-scale watermark-justification watermark-scale watermark-stroke-color watermark-stroke-width watermark-vertical-scale

Sets the style for plot background. All background styles descend from the base style. In addition, the background of a plot is change by the style name background.

Meaning of the style parameters:

  • watermark: the text of the watermark
  • all watermark_ styles have the same meaning as in define-text-style, as the watermark is a string marker
  • background_color: the color of the background
Examples...

Command: define-box-style

Synopsis (file) 

define-box-style text /option=...

Synopsis (command-line) 

--define-box-style text /option=...

Available options: cap color fill-color fill-pattern fill-transparency radius shape style width

Sets the default style for boxes. All box styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the draw-box command.

Meaning of the style parameters:

  • color, style and width: same as in define-line-style
  • fill-color: fill color for the box
  • fill-transparency: the transparency for the fill, from 0 to 1

Command: define-curve-style

Synopsis (file) 

define-curve-style text /option=...

Synopsis (command-line) 

--define-curve-style text /option=...

Available options: clipped color color-map contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-minor-width contour-number contour-use-naturals depth error-bar-color error-bar-line-cap error-bar-line-color error-bar-line-style error-bar-line-width fill fill-close-type fill-color fill-pattern fill-transparency legend line-cap line-color line-style line-width location-xaxis location-yaxis marker marker-angle marker-color marker-color-map marker-fill-color marker-fill-color-map marker-line-color marker-line-color-map marker-line-width marker-marker marker-min-scale marker-scale path-style region-position split-on-nan zaxis

Sets the default style for the named plot background.

Command: define-image-style

Synopsis (file) 

define-image-style text /option=...

Synopsis (command-line) 

--define-image-style text /option=...

Available options: aspect-ratio auto-rotate transparency

Sets the default style for the named image.

Command: define-legend-style

Synopsis (file) 

define-legend-style text /option=...

Synopsis (command-line) 

--define-legend-style text /option=...

Available options: dy frame-cap frame-color frame-fill-color frame-fill-pattern frame-fill-transparency frame-padding frame-radius frame-shape frame-style frame-width picto-height picto-to-text picto-width scale symbol-scale text-scale vpadding

Sets the style for legends.

Command: define-line-style

Synopsis (file) 

define-line-style text /option=...

Synopsis (command-line) 

--define-line-style text /option=...

Available options: cap color style width

Sets the default style for lines. All line styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the draw-line command.

Meaning of the style parameters:

  • color: the color of the line, see color
  • style: the line style, see line-style
  • width: the line width (in points) 
--define-line-style * /color=Pink

makes all lines pink (unless overriden by the /color option to draw-line), while 

--define-line-style .pink /color=Pink

only affect those to which the /class=pink style option was given.

Command: define-marker-style

Synopsis (file) 

define-marker-style text /option=...

Synopsis (command-line) 

--define-marker-style text /option=...

Available options: alignment angle color fill-color font horizontal-scale justification scale stroke-color stroke-width vertical-scale

Sets the style for marker and marker strings. All marker and marker string styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the draw-marker or draw-string-marker commands.

Meaning of the style parameters:

  • alignment, justification, angle, color and scale: as in define-text-style
  • fill-color and stroke_color: markers are both stroked and filled, you can control all colors in one go using color or specifying each with fill-color and stroke_color
  • font: is a PDF font number (from 1 to 14), only used for marker strings
  • horizontal-scale, vertical-scale: scales the marker only horizontally or vertically

Command: define-oriented-line-style

Synopsis (file) 

define-oriented-line-style text /option=...

Synopsis (command-line) 

--define-oriented-line-style text /option=...

Available options: angle cap color head-angle head-color head-marker head-scale origin style tail-angle tail-color tail-marker tail-scale width

Sets the default style for the named oriented lines.

Command: define-style

Synopsis (file) 

define-style text /option=...

Synopsis (command-line) 

--define-style text /option=...

Available options: alignment angle aspect-ratio auto-rotate axis-label-alignment axis-label-angle axis-label-color axis-label-halign axis-label-justification axis-label-loc axis-label-position axis-label-scale axis-label-shift axis-label-text axis-label-text-align axis-label-text-width axis-label-valign background-color background-lines-cap background-lines-color background-lines-style background-lines-width cap clipped color color-map contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-minor-width contour-number contour-use-naturals decoration depth dy error-bar-color error-bar-line-cap error-bar-line-color error-bar-line-style error-bar-line-width fill fill-close-type fill-color fill-pattern fill-transparency font frame-cap frame-color frame-fill-color frame-fill-pattern frame-fill-transparency frame-padding frame-radius frame-shape frame-style frame-width halign head-angle head-color head-marker head-scale horizontal-scale justification legend line-cap line-color line-style line-width loc location location-xaxis location-yaxis log major-tick-length major-tick-width marker marker-angle marker-color marker-color-map marker-fill-color marker-fill-color-map marker-line-color marker-line-color-map marker-line-width marker-marker marker-min-scale marker-scale minor-tick-length minor-tick-width offset origin path-style picto-height picto-to-text picto-width position radius region-position scale shape shift split-on-nan stroke-color stroke-width style symbol-scale tail-angle tail-color tail-marker tail-scale text text-align text-scale text-width tick-label-alignment tick-label-angle tick-label-color tick-label-halign tick-label-justification tick-label-position tick-label-scale tick-label-shift tick-label-text-align tick-label-text-width tick-label-valign ticks-format ticks-format-last ticks-labels ticks-major ticks-major-delta ticks-major-number ticks-major-sep ticks-minor ticks-minor-delta ticks-minor-number ticks-minor-sep-min ticks-side transform transparency valign vertical-scale vpadding watermark watermark-alignment watermark-angle watermark-color watermark-fill-color watermark-font watermark-horizontal-scale watermark-justification watermark-scale watermark-stroke-color watermark-stroke-width watermark-vertical-scale width zaxis

...

Command: define-text-style

Synopsis (file) 

define-text-style text /option=...

Synopsis (command-line) 

--define-text-style text /option=...

Available options: alignment angle color halign justification position scale shift text-align text-width valign

Sets the default style for texts. All text styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the draw-text command.

Meaning of the style parameters:

  • alignment: vertical alignment
  • justification: horizontal alignment
  • angle: angle in degrees to the horizontal (or default orientation in some cases)
  • color: text color
  • scale: text scale

Command: define-title-style

Synopsis (file) 

define-title-style text /option=...

Synopsis (command-line) 

--define-title-style text /option=...

Available options: alignment angle color halign justification loc position scale shift text text-align text-width valign

Sets the style for title. All title styles descend from the base style. In addition, the title of a plot is addressed by the style name title.

Meaning of the style parameters:

  • alignment, justification, angle, color and scale: as in define-text-style
  • text: sets the title text
  • loc: the side on which to display the title, a location
  • shift: the distance away from the plot in text size units (maybe a dimension should be better later)
  • position: shift from the center (parallel to the plot side)

Command: load-style

Synopsis (file) 

load-style file

Synopsis (command-line) 

--load-style file

...

Examples...

Output setup

Commands in this group deal with various aspects of the production of output files:

  • output file location
  • post-processing (including automatic display)
  • cleanup...

Available commands: clean cleanup-pdf dependencies eps mark name open output-and-reset output-directory output-now page-size png resolution svg viewer xpdf

Command: clean

Synopsis (file) 

clean boolean

Synopsis (command-line) 

--clean boolean

When this is on (the default), ctioga2 automatically cleans up intermediate files produced by Tioga. When LaTeX fails, it can be useful to have a closer look at them, so disable it to be able to look into them.

Command: cleanup-pdf

Synopsis (file) 

cleanup-pdf boolean

Synopsis (command-line) 

--cleanup-pdf boolean

If this is on, then ctioga2 uses ghostscript to cleanup the PDF file produced. It is on by default is ctioga2 is able to find the gs executable.

Command: dependencies

Synopsis (file) 

dependencies file

Synopsis (command-line) 

--dependencies file

Saves the dependencies as a Makefike into the given file name.

Command: eps

Synopsis (file) 

eps boolean

Synopsis (command-line) 

--eps boolean

When this feature is on, all produced PDF files are converted to EPS using the pdftops program (from the xpdf tools suite).

Command: mark

Synopsis (file) 

mark boolean

Synopsis (command-line) 

--mark boolean

When this feature is on (which is the default, as it comes in very useful), the 'title' field of the PDF informations is set to the command-line that resulted in the PDF file. Disable it if you don't want any information to leak.

Please note that this will not log the values of the CTIOGA2_PRE and CTIOGA2_POST variables, so you might still get a different output if you make heavy use of those.

Command: name

Synopsis (file) 

name figure name

Synopsis (command-line) 

-n figure name
--name figure name

Sets the name of the figure, which is also the base name for the output file. This has nothing to do with the title of the plot, which can be set using the command title.

If the name contains a %, it is interpreted by ctioga2 as a printf-like format. It will attempt to find the first file that does not exist, feeding it with increasing numbers.

The default value is now Plot-%03d, which means you'll get increasing numbers automatically.

Command: open

Synopsis (file) 

open

Synopsis (command-line) 

--open

Uses open (available on MacOS) to view the PDF files produced by ctioga2.

Command: output-and-reset

Synopsis (file) 

output-and-reset

Synopsis (command-line) 

--output-and-reset

Writes the current figure and starts a fresh one. All non-graphical information are kept (curves loaded, figure names, preamble, and so on).

Command: output-directory

Synopsis (file) 

output-directory text

Synopsis (command-line) 

-O text
--output-directory text

Sets the directory to which files will be plot. It defaults to the current directory.

Command: output-now

Synopsis (file) 

output-now figure name

Synopsis (command-line) 

-o figure name
--output figure name

Writes a figure with the given name (see name) and keeps the current state. This can be used to create an animation.

Command: page-size

Synopsis (file) 

page-size text /option=...

Synopsis (command-line) 

-r text /option=...
--page-size text /option=...

Available options: count-legend

Sets the size of the output PDF file, in real units. Takes arguments in the form of 12cm x 3in (spaces can be omitted).

Examples...
ctioga2 -X --math 'sin(x)' --page-size '7cmx12cm'
ctioga2 -r 9cmx7cm /count-legend=true \

Command: png

Synopsis (file) 

png resolution /option=...

Synopsis (command-line) 

--png resolution /option=...

Available options: oversampling pdftoppm scale

Turns all produced PDF files into PNG images of the given resolution using convert. This also has for effect to set the page-size to the resolution divided by the 'scale' option in Postscript points. By default, 2 pixels are rendered for 1 final to produce a nicely antialiased image. Use the 'oversampling' option to change that, in case the output looks too pixelized. This option only affects conversion time.

Command: resolution

Synopsis (file) 

resolution float

Synopsis (command-line) 

--resolution float

By default, ctioga2 has a resolution of 1/100th of a postscript point. This is clearly enough for most tasks, but you can increase it should you need, or decrease it to generate possibly a little more jaggy but less large PDF files.

The number given is the number of output points per postscript point.

Better change that at the beginning of the plot.

Command: svg

Synopsis (file) 

svg boolean

Synopsis (command-line) 

--svg boolean

When this feature is on, all produced PDF files are converted to SVG using the neat pdf2svg program.

Command: viewer

Synopsis (file) 

viewer text

Synopsis (command-line) 

--viewer text

Sets the command for viewing the PDF file after ctioga2 has been run.

Command: xpdf

Synopsis (file) 

xpdf

Synopsis (command-line) 

-X 
--xpdf

Uses xpdf to view the PDF files produced by ctioga2.

If xpdf is not found, then it tries to guess which viewers are available:

  • on windows, it uses the system file associations to open the PDF file
  • on mac, it uses the open command
  • on linux, it tries, mime-open, and if that is missing, falls back to commonly available PDF viewers.
Examples...
ctioga2 -X --xyz-map 3D-data.dat@1:2:4
ctioga2 -X --xyz-map --margin 0.03 \
ctioga2 -X --xyz-map --margin 0.03 \
ctioga2 -X --xyz-map --margin 0.03 \
ctioga2 -X --xyz-map --margin 0.03 \
ctioga2 -X --xy-parametric --margin 0.03 \
ctioga2 -X --math 'sin(x)' 'cos(x)' -y '$y$ values' \
ctioga2 -X --math 'sin(x)' 'cos(x)' \
ctioga2 -X --math --margin 0.03 \
ctioga2 -X --math --ylog --margin 0.03 \
ctioga2 -X --math 'sin(x)' 'cos(x)' \
ctioga2 -X --math 'sin(x)' --page-size '7cmx12cm'
ctioga2 -X --math 'x**2' --inset 'tl:0.2,0.8:0.4,0.3' \
ctioga2 -X --math --setup-grid 2x2 /top 5mm \
ctioga2 -X --math --setup-grid 2x2 /top 5mm \
ctioga2 -X --math --region /color Blue /transparency 0.7 \
ctioga2 -X --math --region /color Blue /transparency 0.7 \
ctioga2 -X --math 'sin(x)' 'sin(x+1)' 'sin(x+2)' 'sin(x+3)' \
ctioga2 -X --math --line-style auto 'sin(x)' 'sin(x+1)' --line-style Solid \
ctioga2 -X --math /samples 31 --marker auto 'sin(x)' \
ctioga2 -X --math /samples 31 --marker auto 'sin(x)' \
ctioga2 -X --yrange -1.1:1.1 data.dat@'$1:$2:yerr=$2*0.2'
ctioga2 -X --yrange -1.1:1.1 --line-style no \
ctioga2 -X --math --fill axis 'sin(x)' /fill-color '#fcc'
ctioga2 -X --math --fill axis --fill-transparency 0.6 \
ctioga2 -X --math --gradient Red Blue \
ctioga2 -X --math  --color-set 'Red|Blue|Green' \
ctioga2 -X --math /xrange -1:1 /samples 101 'x**2' 'x' 
ctioga2 -X --math /xrange -1:1 /samples 31 --marker auto \
ctioga2 -X --math /trange -3.1415:3.1415 /samples 101 'sin(t):cos(t)' \
ctioga2 -X --text-separator , data.csv @1:3
ctioga2 -X data.dat@'$1**2:$3*$2**3'
ctioga2 -X data.dat@1:2 @'$1:$2+1' /where 'x > -1'
ctioga2 -X --marker auto --line-style no \
ctioga2 -X --gnuplot gnuplot.gnu gnuplot.gnu@2 \
ctioga2 -X --smath /samples=100 --xyz-map \
ctioga2 -X data.dat data.dat@1:3 
ctioga2 -X data.dat data.dat@1:3 --title 'A nice title'
ctioga2 -X data.dat data.dat@1:3 \
xpdf
xpdf
xpdf
ctioga2 -X --math --legend '$\sin x$' 'sin(x)' \
ctioga2 -X --math --legend-line 'Trigonometric' /color Blue \
	-X --math --legend-line 'Trigonometric' /color Blue \
ctioga2 -X --math \
ctioga2 -X --math \
ctioga2 -X --math /xrange -3:3 'sin(3.1415*x)' \
ctioga2 -X --math /xrange -3:3 'sin(3.1415*x)' \
ctioga2 -X --math /xrange -3:3 'sin(3.1415*x)' \
ctioga2 -X --math --setup-grid 2x2 /top 5mm \

Data stack manipulation

Commands for manipulation of the data stack

Available commands: append apply-formula bin compute-contour dataset-hook dataset-hook-add dataset-hook-clear drop join-datasets load make-contour merge-datasets print-dataset show-stack xy-reglin

Command: append

Synopsis (file) 

append dataset /option=...

Synopsis (command-line) 

--append dataset /option=...

Available options: as ignore-hooks where

Use the current backend to load the given dataset(s) and append to the last dataset on the stack (without creating a new dataset). Roughly the equivalent of first running load and then join-datasets.

Command: apply-formula

Synopsis (file) 

apply-formula text /option=...

Synopsis (command-line) 

--apply-formula text /option=...

Available options: name which

Applies a formula to the last dataset (or the named one)

Command: bin

Synopsis (file) 

bin /option=...

Synopsis (command-line) 

--bin  /option=...

Available options: column delta max min name normalize number which

This command bins the contents of the Y column of the last dataset on the stack, and pushes the results as a new dataset.

Examples...

Command: compute-contour

Synopsis (file) 

compute-contour float /option=...

Synopsis (command-line) 

--compute-contour float /option=...

Available options: which

Computes the contour at the given level for the given dataset (or the last on the stack if none is specified) and pushes it onto the data stack.

You can further manipulate it as usual.

Command: dataset-hook

Synopsis (file) 

dataset-hook commands

Synopsis (command-line) 

--dataset-hook commands

The dataset hook is a series of commands such as those in the command files that are run every time after a dataset is added onto the data stack. Its main use is to provide automatic filtering of data, but any arbitrary command can be used, so enjoy !

Command: dataset-hook-add

Synopsis (file) 

dataset-hook-add commands

Synopsis (command-line) 

--dataset-hook-add commands

Adds the given commands to the dataset hook. See dataset-hook for more information about the dataset hook.

Command: dataset-hook-clear

Synopsis (file) 

dataset-hook-clear

Synopsis (command-line) 

--dataset-hook-clear

Clears the dataset hook. See dataset-hook for more information.

Command: drop

Synopsis (file) 

drop stored-dataset

Synopsis (command-line) 

--drop stored-dataset

Removes the given dataset from the stack.

Can become useful when dealing with large datasets, some of which are only used as intermediates for apply-formula or compute-contour, for instance.

Command: join-datasets

Synopsis (file) 

join-datasets /option=...

Synopsis (command-line) 

-j  /option=...
--join-datasets  /option=...

Available options: name number which

Pops the last two (or number, if it is specified) datasets from the stack, concatenates them (older last) and push them back onto the stack. The name option can be used to give a name to the new dataset.

Command: load

Synopsis (file) 

load dataset /option=...

Synopsis (command-line) 

-L dataset /option=...
--load dataset /option=...

Available options: as ignore-hooks name where

Use the current backend to load the given dataset(s) onto the data stack.

If the name option is given, the last dataset loaded this way (if dataset expansion occurs) gets named, or, if it contains a %d (or similar construct), each dataset gets named with %d replace with the number of the dataset within the expansion (starting at 0). This name can be used to further use the dataset without remembering its number. See the type stored-dataset for more information.

Examples...

Command: make-contour

Synopsis (file) 

make-contour float /option=...

Synopsis (command-line) 

--make-contour float /option=...

Available options: as ignore-hooks name where which

Command: merge-datasets

Synopsis (file) 

merge-datasets /option=...

Synopsis (command-line) 

--merge-datasets  /option=...

Available options: columns number precision which

This commands merges data with matching X values from a dataset (by default the one before the last) into the last one. Data points that have no corresponding X value in the current dataset are simply ignored. If the columns option is provided, the numbered columns are use instead of the X columns (X is 1). More than one column can be provided this way, in which case *all* values must match.

This can be used to build 3D datasets for xyz-map or xy-parametric.

Command: print-dataset

Synopsis (file) 

print-dataset /option=...

Synopsis (command-line) 

-P  /option=...
--print-dataset  /option=...

Available options: save which

Prints to standard output data contained in the last dataset pushed onto the stack, or the given stored dataset if the which option is given.

Command: show-stack

Synopsis (file) 

show-stack

Synopsis (command-line) 

--show-stack

Displays the current contents of the dataset stack.

Mostly used for debugging when operations like merge-datasets or join-datasets don't work as expected.

Command: xy-reglin

Synopsis (file) 

xy-reglin /option=...

Synopsis (command-line) 

--xy-reglin  /option=...

Available options: linear which

...

This command will get documented some day.

Introspection

Commands displaying information about the internals of ctioga2, such as known types/commands/backends...

Available commands: edit-command edit-group edit-type list-commands list-groups list-styles list-types version-raw

Command: edit-command

Synopsis (file) 

edit-command text /option=...

Synopsis (command-line) 

--edit-command text /option=...

Available options: doc

Edit the given command in an editor. It will only work from the top directory of a ctioga2 source tree.

Command: edit-group

Synopsis (file) 

edit-group text

Synopsis (command-line) 

--edit-group text

Edit the given group in an editor. It will only work from the top directory of a ctioga2 source tree.

Command: edit-type

Synopsis (file) 

edit-type text

Synopsis (command-line) 

--edit-type text

Edit the given type in an editor. It will only work from the top directory of a ctioga2 source tree.

Command: list-commands

Synopsis (file) 

list-commands /option=...

Synopsis (command-line) 

--list-commands  /option=...

Available options: format raw

List all commands known to ctioga2

Command: list-groups

Synopsis (file) 

list-groups /option=...

Synopsis (command-line) 

--list-groups  /option=...

Available options: raw

List all command groups known to ctioga2

Command: list-styles

Synopsis (file) 

list-styles /option=...

Synopsis (command-line) 

--list-styles  /option=...

Available options: raw

Lists all available color sets, marker sets and the like.

Command: list-types

Synopsis (file) 

list-types /option=...

Synopsis (command-line) 

--list-types  /option=...

Available options: raw

List all types known to ctioga2

Command: version-raw

Synopsis (file) 

version-raw

Synopsis (command-line) 

--version-raw

Prints the raw version number, without any other decoration and newline.

Filters

The commands in this group act upon the last dataset pushed unto the data stack: they can be viewed as filters.

Available commands: avg-dup avg-dup-last cherry-pick cherry-pick-last smooth smooth-last sort sort-last trim trim-last

Command: avg-dup

Synopsis (file) 

avg-dup

Synopsis (command-line) 

--avg-dup

Install the avg-dup-last command as a dataset hook (see dataset-hook): all datasets acquired after this is on will be averaged if they have identical successive values of X.

Command: avg-dup-last

Synopsis (file) 

avg-dup-last /option=...

Synopsis (command-line) 

--avg-dup-last  /option=...

Available options: mode

Averages successive points with identical X values. This algorithm is naive with respect to the min/max values and averages them just as well, whereas one might expect something more clever.

To average over all X values when they are not successive in the dataset, you should use sort-last first.

Command: cherry-pick

Synopsis (file) 

cherry-pick text

Synopsis (command-line) 

--cherry-pick text

Install the cherry-pick-last command as a dataset hook (see dataset-hook): all points for which the formula returns false for subsequent datasets will be removed.

Command: cherry-pick-last

Synopsis (file) 

cherry-pick-last text

Synopsis (command-line) 

--cherry-pick-last text

Removes the data from the last dataset in the data stack for which the formula returns false.

See also the cherry-pick command to apply the selection to all datasets.

You might find it much easier to use the /where option of the plot or load commands.

Command: smooth

Synopsis (file) 

smooth integer

Synopsis (command-line) 

--smooth integer

Install the smooth-last command as a dataset hook (see dataset-hook): from now on, the datasets are all smoothed

Command: smooth-last

Synopsis (file) 

smooth-last integer

Synopsis (command-line) 

--smooth-last integer

Smooth the data using a simple (naive even) gaussian filter. Good for producing 'lines to guide the eye'

Command: sort

Synopsis (file) 

sort

Synopsis (command-line) 

--sort

Install the sort-last command as a dataset hook (see dataset-hook): all subsequent datasets will be sorted according to their X values.

Command: sort-last

Synopsis (file) 

sort-last

Synopsis (command-line) 

--sort-last

Sorts the last dataset pushed unto the stack according to X values. Can be used as a filter.

This command sorts in-place.

See also sort.

Command: trim

Synopsis (file) 

trim integer

Synopsis (command-line) 

--trim integer

Install the trim-last command as a dataset hook (see dataset-hook): all subsequent datasets will be trimmed to keep only every n point.

Command: trim-last

Synopsis (file) 

trim-last integer

Synopsis (command-line) 

--trim-last integer

Only keeps one every ? data point on the last dataset pushed unto the data stack. Useful when data have too many points to avoid creating heavy PDF files that take ages to display with no additional benefits.

This operation is very crude and does not average data.

See also trim.

General commands

General scope commands

Available commands: command-line-help debug echo eval help-on include pause print-instructions ruby-run set verbose version

Command: command-line-help

Synopsis (file) 

command-line-help /option=...

Synopsis (command-line) 

-h  /option=...
--help  /option=...

Available options: pager

Prints helps about short and long options available when run from the command-line.

Command: debug

Synopsis (file) 

debug

Synopsis (command-line) 

--debug

With this on, ctioga2 writes a whole lot of debugging information. You probably will not need that unless you intend to file a bug report or to tackle a problem yourself.

Be warned that it *will* slow down very significantly the processing of ctioga2 (up to hundreds of times slower), especially if you are not redirecting the output to a file.

Command: echo

Synopsis (file) 

echo

Synopsis (command-line) 

--echo

Writes the whole command-line used to standard error, quoted in such a way that it should be usable directly for copy/paste.

Command: eval

Synopsis (file) 

eval commands

Synopsis (command-line) 

-e commands
--eval commands

Runs the given strings as commands, as if given from a command file.

Command: help-on

Synopsis (file) 

help-on text

Synopsis (command-line) 

--help-on text

Prints help about the given command

Command: include

Synopsis (file) 

include file /option=...

Synopsis (command-line) 

-f file /option=...
--file file /option=...

Available options: log

Reads the file and runs commands found in them, using the ctioga language. 

ctioga2 -f my_file.ct2

If the /log is on, then all messages are written to a -log.txt file instead of to the terminal.

Examples...

Command: pause

Synopsis (file) 

pause boolean

Synopsis (command-line) 

--pause boolean

When this is on, the program will ask for confirmation before finishing, when errors or warnings have been shown. This is especially useful on windows or other environments where the terminal shuts down as soon as ctioga2 has finished.

Command: print-instructions

Synopsis (file) 

print-instructions

Synopsis (command-line) 

--print-instructions

Writes the list of all the instructions run so far.

This is not very helpful for now, possibly.

Command: ruby-run

Synopsis (file) 

ruby-run file

Synopsis (command-line) 

--ruby-run file

Reads the file and runs the Ruby code found inside, a bit like Ruby would do with the require command, excepted that ctioga2 does not follow Ruby's file searching rules: you have to specify the full path.

Command: set

Synopsis (file) 

set text text

Synopsis (command-line) 

--set text text

Sets the value of the variable (first argument) to the given second argument. No parsing is done.

Command: verbose

Synopsis (file) 

verbose

Synopsis (command-line) 

-v 
--verbose

With this on, ctioga2 outputs quite a fair amount of informative messages.

Command: version

Synopsis (file) 

version

Synopsis (command-line) 

-V 
--version

Prints the version of ctioga in use

Generated for ctioga2 version: 0.14.1