Up  

Module type Gnuplot_common.T

module type T = sig .. end
type device = Gnuplot_common_.device =
| X (*On screen (X11, AQUA or windows depending on your platform)*)
| Wxt (*Interactive and cross-platform terminal for on-screen rendering based on Cairo.*)
| PS of string (*Postscript*)
| EPS of string (*Encapsulated PostScript*)
| EPSLaTeX of string (*Picture environment including an EPS file.*)
| FIG of string (*Xfig format*)
| PNG of string (*Portable Network Graphics*)
| MP of string (*Metapost*)
| MF of string (*Metafont*)
| SVG of string (*Scalable Vector Graphics*)
The string in the constructors is the name of the filename. EPSLaTeX creates two filenames: the given string is the name of the TeX file (a ".tex" extension will be added if not present); the EPS file name is constructed from it by changing the extension ".tex" to ".eps".
type color = int
Color, compatible with the Graphics module.
type handle = Gnuplot_common_.handle
Gnuplot handle
type style = Gnuplot_common_.style =
| Lines
| Linespoints
| Points
| Dots
| Impulses
Style of plotting lines

Initializing, closing and moving around (sub)pages


val device_of_filename : string -> device
device_of_filename f guesses the device corresponding to the extension of f.
Raises Failure if none is found.
val init : ?offline:string ->
       ?max_inline:int ->
       ?persist:bool ->
       ?color:bool ->
       ?nxsub:int ->
       ?nysub:int ->
       ?xsize:float ->
       ?ysize:float ->
       ?aspect:float -> device -> handle
init ?offline ?max_inline ?persist ?color ?nsubx ?nsuby ?sizex ?sizey ?aspect dev returns a handle to a new gnuplot session with device dev.
Raises Invalid_argument if any of the parameters does not satisfy the above constraints.
offline : name of the script file (typically with extension ".plt"). If this parameter is given, gnuplot will not be called but instead all commands and data will be written to the script file.
max_inline : the data can be communicated to gnuplot through a pipe or a file. The pipe will be used if the number of data lines to send is less or equal to max_inline. For example, if max_inline is set to max_int, all data will be transmitted through the pipe.
persist : says whether the plot window should stay after the handle has been closed (default: true).
color : if true, a color output (as opposed to a monochrome one) will be produced (default = true)
nxsub : number of horizontal subpages (default = 1)
nysub : number of vertical subpages (default = 1)
xsize : the horizontal size of the output; must be > 0 (default = 100. mm or 550. pixels)
ysize : the vertical size of the output; must be > 0 (default = 100. mm or 550. pixels)
aspect : the aspect ratio of the output, i.e. the ratio of the height on the width of the output; must be > 0 (default = 1.)

For Gnuplot.X, Gnuplot.PNG and Gnuplot.SVG devices, the size is expressed in pixels, for the other drivers, it is expressed in milimeters. One has to specify both sizex and sizey, in which case aspect is ignored, or one of them and aspect. On Win32, Gnuplot.X may ignore the sizes (depending on your privileges).

val close : handle -> unit
close g closes the gnuplot session g.
Raises Failure if the gnupot process does exit properly.
val adv : ?sub:int -> handle -> unit
adv g advances to the next subpage or, if necessary, opens a new page. adv ~sub:i g goes to the subpage i or, if i is too big or i <= 0, it starts a new page. Subpages are counted row by row, the top left one being numbered 1. Beware that some output devices (e.g., PNG) do not support multipage output.
val clear : handle -> unit
clear g clears the current subpage.

Pens and colors


val pen : handle -> int -> unit
Deprecated.use color instead.
pen g i selects the ith pen type for the handle g -- i can at least take the values from 0 to 6 but some devices may allow a bigger range.
val color : handle -> color -> unit
color g c use the RGB color c active for the subsequent drawings on the handle g.
val pen_width : handle -> float -> unit
pen_width g w sets the pen thickness to w (in multiples of the default pen size) for the handle g. Note that some devices (e.g. PNG) do not obey such command -- this is a gnuplot limitation.
val point : handle -> int -> unit
point g i selects the ith point type for the handle g.
val point_width : handle -> float -> unit
point_width g w sets the point thickness to w (in multiples of the default point size) for the handle g.
val font : handle -> string -> unit
font g s sets the current font for the handle g as s where s is device and system dependent.
val font_size : handle -> int -> unit
font_size g sz sets the current font size for the handle g to sz. Negative or null values select the default size. Note that the default font on some devices is not scalable -- thus the font size may seem to have no effect.

Text


val title : handle -> string -> unit
title g t sets the title for the current subpage of the gnuplot session g to t.
val xlabel : handle -> string -> unit
xlabel g t sets the label for x axis of the current subpage of the gnuplot session g to t.
val ylabel : handle -> string -> unit
ylabel g t sets the label for y axis of the current subpage of the gnuplot session g to t.
type coord =
| Graph (*The coordinates of the last labelled axis*)
| Viewport (*The area delimited by the borders, (0,0) being the bottom left corner and (1,1) the top right corner.*)
| Subpage (*Subpage coordinates with (0,0) being the bottom left corner and (1,1) the top right corner.*)
| World (*The entire graph with (0,0) being the bottom left corner and (1,1) the top right corner.*) 
val text : handle ->
       ?tag:int ->
       ?frame:float ->
       ?rotate:float ->
       ?coord:coord -> float -> float -> string -> unit
text g x y text write the string text at position (x,y) in grah coordinates on the gnuplot session g. Graph coordinates mean that (x, y) are (0., 0.) at the bottom left of the surrounding box and (1., 1.) at the top right.
rotate : in degrees

Tags


val show : ?immediately:bool -> ?tag:int -> handle -> unit
tag_show ?immediately ?tag g shows the plots handled by that tag.
Raises Invalid_argument if t is the system tag 0.
immediately : (Default: true).
val hide : ?immediately:bool -> ?tag:int -> handle -> unit
val auto : tag:int -> handle -> unit
val free : tag:int -> handle -> unit

2D world coordinates, axes,...


val win : handle -> float -> float -> float -> float -> unit
win g xmin xmax ymin ymax sets the x and y ranges for the current subpage of the handle g.
type axis_opt 
type border_loc = int list
List of numbers among 1, 2, 3 and 4 corresponding to border locations. In 2D, 1 denotes the left or bottom axis and 2 the right or top axis.
val axis : ?which:border_loc -> unit -> axis_opt
axis ?which () sets the zero axis.
which : is a list of the border numbers.
val border : ?which:border_loc -> unit -> axis_opt
border ?which () set borders to the graph.
which : is a list of the border numbers.
val tics : ?which:border_loc ->
       ?outward:bool ->
       ?grid:bool ->
       ?minor:int ->
       ?minor_grid:bool ->
       ?log:bool -> ?step:float -> unit -> axis_opt
tics ?which ?outward ?minor ?grid ?log ?step ()
which : a list of the border numbers.
outward : whether the tics point outside the border (default: false). Beware this is a global setting for gnuplot, so all the tics will be affected.
grid : whether to draw a grid at each major tic (default: false).
minor : set the number of sub-intervals (not the number of minor tics) between two major tics (default: 1 which means no minor tics).
minor_grid : whether to draw a grid at each minor tic (default: false).
log : whether to enable log scaling.
step : step between two consecutive tics.
val labels : ?which:border_loc ->
       ?prec:int -> ?rotate:bool -> unit -> axis_opt
labels ?which ?prec ?rotate () set the numeric labels accroding to the following parameters:
which : a list of the border numbers;
prec : precision of the numeric labels;
rotate : rotate the labels of 90 degrees w.r.t. their usual position.
val box : ?x:axis_opt list ->
       ?y:axis_opt list -> handle -> unit
val env : handle ->
       ?xaxis:bool ->
       ?xgrid:bool ->
       ?xlog:bool ->
       float ->
       float -> ?yaxis:bool -> ?ygrid:bool -> ?ylog:bool -> float -> float -> unit
env g ?xaxis ?xgrid ?xlog xmin xmax ?yaxis ?ygrid ?ylog ymin ymax is a convenience function to set the x and y ranges as well as some common parameters (using win and box separately is more powerful).
xaxis : displays the x axis (default: false)
xgrid : displays a grid at each x tic (default: false)
xlog : select a logarithmic scaling for the x axis (default: false)
yaxis : displays the y axis (default: false)
ygrid : displays a grid at each y tic (default: false)
ylog : select a logarithmic scaling for the y axis (default: false)

2D Plots 


val fx : handle ->
       ?tag:int ->
       ?style:style ->
       ?label:string -> ?nsamples:int -> (float -> float) -> float -> float -> unit
fx g ?style ?label ?nsamples f a b draws the graph of f over the interval going from a to b (inclusive).
style : style of the graph (default: Lines)
label : label for this graph (default: none)
nsamples : number of points at which f is evaluated (default: 100)
val xy_param : handle ->
       ?tag:int ->
       ?style:style ->
       ?label:string ->
       ?nsamples:int -> (float -> float * float) -> float -> float -> unit
xy_param g ?tag ?style ?label ?nsamples f a b draws the image of the function f (i.e., the cuve parametrized by f) over the interval going from a to b (inclusive).
style : style of the graph (default: Lines)
label : label for this graph (default: none)
nsamples : number of points at which f is evaluated (default: 100)
val xy_file : handle ->
       ?tag:int -> ?style:style -> ?label:string -> string -> unit

3D world coordinates, axes,...


val box3 : ?x:axis_opt list ->
       ?y:axis_opt list ->
       ?z:axis_opt list -> handle -> unit
val env3 : handle ->
       ?xaxis:bool ->
       ?xgrid:bool ->
       ?xlog:bool ->
       float ->
       float ->
       ?yaxis:bool ->
       ?ygrid:bool ->
       ?ylog:bool ->
       float ->
       float -> ?zaxis:bool -> ?zgrid:bool -> ?zlog:bool -> float -> float -> unit
env g ?xgrid ?xlog xmin xmax ?ygrid ?ylog ymin ymax sets x and y ranges.

3D Plots


val fxy : handle ->
       ?tag:int ->
       ?style:style ->
       ?label:string ->
       ?xnsamples:int ->
       ?ynsamples:int ->
       (float -> float -> float) -> float -> float -> float -> float -> unit
fxy g ?style ?label ?hidden ?xnsamples ?ynsamples f xmin xmax ymin ymax
val fxy_param : handle ->
       ?tag:int ->
       ?style:style ->
       ?label:string ->
       ?xnsamples:int ->
       ?ynsamples:int ->
       (float -> float -> float * float * float) ->
       float -> float -> float -> float -> unit
fxy_param g ?style ?label ?hidden ?xnsamples ?ynsamples f xmin xmax ymin ymax
val xyz_ft : handle ->
       ?tag:int ->
       ?style:style ->
       ?label:string ->
       ?tnsamples:int -> (float -> float * float * float) -> float -> float -> unit