The cl-grace Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-grace Reference Manual

This is the cl-grace Reference Manual, version 0.14.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:09:36 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CL-GRACE
========
An interface between Common Lisp and the Grace 2D plotting program.

REQUIREMENTS
============
Currently only tested with SBCL and Clozure CL.

Requires Grace to be installed on your system. The Grace homepage is at
  http://plasma-gate.weizmann.ac.il/Grace/

INSTALLATION
============
The CL-GRACE system is ASDF installable. It has one dependency: CL-FAD,
for the WITH-OUTPUT-TO-TEMPORARY-FILE function.

USAGE
=====
CL-GRACE works by launching the xmgrace executable as a separate process from
within your lisp session, then sending it commands on the process's standard
input stream.

If the xmgrace executable is not in your path, or otherwise not in the search
path used by your lisp when it starts a process, then set the special variable
  grace:*grace-program*
to the full path of the xmgrace file.

The following is a quick-start guide to the low-level functional API.
To create a new plot (start an xmgrace session) do something like
  (setf p (grace:new-plot))
or to open a previously saved plot (a Grace .agr project file) do
  (setf p (grace:open-plot ))
then to send commands do
  (grace:send-command p )
to save the plot do
  (grace:save-plot p )
and to close the plot (quit the xmgrace session) do
  (grace:close-plot p)

For a description of commands that Grace understands see the Grace User's Guide.
For some examples of CL-GRACE usage see the examples.lisp file.

The high-level functional API is work-in-progress. It will be documented when
stable.

LICENCE
=======
An MIT-style licence, which essentially means you can use the code in any way
you like as long as you retain the copyright notices. 

KNOWN BUGS
==========
Support for lisps other than SBCL and CCL is missing, patches welcome ...

--
PDO
7 April 2015


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-grace

Author

Paul Onions

License

MIT

Description

CL-GRACE: an interface to the Grace 2D plotting program.

Version

0.14.0

Dependency

cl-fad

Source

cl-grace.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-grace.asd

Location

cl-grace.asd

Systems

cl-grace (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-grace/packages.lisp

Parent

cl-grace (system)

Location

packages.lisp

Packages

cl-grace


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-grace/utils.lisp

Dependency

packages.lisp (file)

Parent

cl-grace (system)

Location

utils.lisp

Exported Definitions

hsv->rgb (function)

Internal Definitions

remove-kw-args (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-grace/grace-interface.lisp

Dependencies
Parent

cl-grace (system)

Location

grace-interface.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-grace/grace-plot.lisp

Dependencies
Parent

cl-grace (system)

Location

grace-plot.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-grace

Source

packages.lisp (file)

Nickname

grace

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *autoscale-graph*

Automatically scale graph after PLOT operations.

Package

cl-grace

Source

grace-plot.lisp (file)

Special Variable: *autotick-graph*

Automatically tick graph after PLOT operations.

Package

cl-grace

Source

grace-plot.lisp (file)

Special Variable: *dataset*

The default dataset number if not specified with :DATASET argument.

Package

cl-grace

Source

grace-plot.lisp (file)

Special Variable: *grace-args*

List of strings to be supplied to the Grace executable as arguments.

Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *grace-program*

Name of Grace executable to launch.

Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *graph*

The default graph number if not specified with :GRAPH argument.

Package

cl-grace

Source

grace-plot.lisp (file)

Special Variable: *plot*

The currently active plot object.

Package

cl-grace

Source

grace-plot.lisp (file)

Special Variable: *refresh-plot*

Default value for :REFRESH keyword arguments.

Package

cl-grace

Source

grace-interface.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: without-refresh &body BODY
Package

cl-grace

Source

grace-interface.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: connect-plot PIPE-NAME &rest ARGS

Connect to a Grace plot via a named pipe.

Package

cl-grace

Source

grace-interface.lisp (file)

Function: ensure-active-plot &rest ARGS &key NEW &allow-other-keys

Ensure *PLOT* contains an active plot.

Package

cl-grace

Source

grace-plot.lisp (file)

Function: ensure-clear-graph &key PLOT GRAPH
Package

cl-grace

Source

grace-plot.lisp (file)

Function: hsv->rgb HSV

Convert an HSV triple to an RGB triple.
Where HSV should be a 3-element list of reals in range [0,1]. Returns a 3-element list of RGB values in range [0,1].

Package

cl-grace

Source

utils.lisp (file)

Function: new-plot &rest ARGS &key CLASS &allow-other-keys

Create a new grace plot.
Return a plot object, of class CLASS, to which commands can be sent. Any arguments in ARGS are given to INITIALIZE-INSTANCE.

Package

cl-grace

Source

grace-interface.lisp (file)

Function: open-plot FILENAME &rest ARGS

Open an existing grace project file.
Supply ARGS to the NEW-PLOT function. Return a PLOT object to which commands can be sent.

Package

cl-grace

Source

grace-interface.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: active-plot-p PLOT &key &allow-other-keys

Test if connection to Grace is still active.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: active-plot-p (PLOT plot) &key
Method: active-plot-p (PLOT grace-plot) &key
Generic Function: arrange-graphs PLOT NROWS NCOLS &key OFFSET HGAP VGAP HVINV HINV VINV SNAKE REFRESH REDRAW UPDATE-GUI &allow-other-keys

Arrange graphs on a plot page.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: arrange-graphs (PLOT plot) (NROWS integer) (NCOLS integer) &key OFFSET HGAP VGAP HVINV HINV VINV SNAKE REFRESH REDRAW UPDATE-GUI

Arrange graphs on a plot page.
NROWS : non-negative integer
NCOLS : non-negative integer
OFFSET : real
HGAP : real
VGAP : real
HVINV : boolean or string-designator ("on", "off") HINV : boolean or string-designator ("on", "off") VINV : boolean or string-designator ("on", "off") SNAKE : boolean or string-designator ("on", "off") REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: autoscale-graph PLOT GRAPH &key WRT REFRESH REDRAW UPDATE-GUI &allow-other-keys

Autoscale the given graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: autoscale-graph (PLOT plot) (GRAPH integer) &key WRT REFRESH REDRAW UPDATE-GUI

Autoscale a graph with respect to a given dataset, or restricted to one axis. WRT : non-negative integer or string designator ("xaxis", "yaxis") REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: autotick-graph PLOT GRAPH &key REFRESH REDRAW UPDATE-GUI &allow-other-keys

Autotick the given graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: autotick-graph (PLOT plot) (GRAPH integer) &key REFRESH REDRAW UPDATE-GUI

Automatically setup axis ticks for a graph. REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: close-plot PLOT &key &allow-other-keys

Close a Grace plot.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: close-plot (PLOT plot) &key
Method: close-plot (PLOT grace-plot) &key
Generic Function: cmd OBJ &key PLOT &allow-other-keys

Extensible function to send commands to Grace.

Package

cl-grace

Source

grace-plot.lisp (file)

Methods
Method: cmd (OBJ string) &key PLOT
Generic Function: create-dataset PLOT GRAPH DATASET &key TYPE REFRESH REDRAW UPDATE-GUI &allow-other-keys

Create a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: create-dataset (PLOT plot) (GRAPH integer) (DATASET integer) &key TYPE REFRESH REDRAW UPDATE-GUI
Generic Function: create-graph PLOT GRAPH &key REFRESH REDRAW UPDATE-GUI &allow-other-keys

Create a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: create-graph (PLOT plot) (GRAPH integer) &key REFRESH REDRAW UPDATE-GUI
Generic Function: delete-dataset PLOT GRAPH DATASET &key REFRESH REDRAW UPDATE-GUI &allow-other-keys

Delete a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: delete-dataset (PLOT plot) (GRAPH integer) (DATASET integer) &key REFRESH REDRAW UPDATE-GUI
Generic Function: delete-graph PLOT GRAPH &key REFRESH REDRAW UPDATE-GUI &allow-other-keys

Delete a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: delete-graph (PLOT plot) (GRAPH integer) &key REFRESH REDRAW UPDATE-GUI
Generic Function: disconnect-plot PLOT &key &allow-other-keys

Disconnect from a Grace plot.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: disconnect-plot (PLOT grace-plot) &key
Generic Function: encode-datum DATUM &key &allow-other-keys

Encode the given datum to a string representation.
Any structure in the datum is flattened, returning a string of comma and space separated floating point values.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: encode-datum (DATUM real) &key
Method: encode-datum (DATUM sequence) &key
Generic Function: flatten-datum DATUM &key &allow-other-keys

Flatten the given datum into a list of numbers.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: flatten-datum (DATUM number) &key
Method: flatten-datum (DATUM sequence) &key
Generic Function: grace-args OBJECT
Generic Function: (setf grace-args) NEW-VALUE OBJECT
Package

cl-grace

Methods
Method: grace-args (GRACE-PLOT grace-plot)

automatically generated reader method

Source

grace-interface.lisp (file)

Method: (setf grace-args) NEW-VALUE (GRACE-PLOT grace-plot)

automatically generated writer method

Source

grace-interface.lisp (file)

Generic Function: grace-process OBJECT
Generic Function: (setf grace-process) NEW-VALUE OBJECT
Package

cl-grace

Methods
Method: grace-process (GRACE-PLOT grace-plot)

automatically generated reader method

Source

grace-interface.lisp (file)

Method: (setf grace-process) NEW-VALUE (GRACE-PLOT grace-plot)

automatically generated writer method

Source

grace-interface.lisp (file)

Generic Function: grace-program OBJECT
Generic Function: (setf grace-program) NEW-VALUE OBJECT
Package

cl-grace

Methods
Method: grace-program (GRACE-PLOT grace-plot)

automatically generated reader method

Source

grace-interface.lisp (file)

Method: (setf grace-program) NEW-VALUE (GRACE-PLOT grace-plot)

automatically generated writer method

Source

grace-interface.lisp (file)

Generic Function: graph OBJ &key PLOT REFRESH TITLE SUBTITLE LEGEND-LOCATION XLABEL XSCALE XMIN XMAX XTICK-FORMAT XTICK-PRECISION XTICK-MAJOR XTICK-MINOR YLABEL YSCALE YMIN YMAX YTICK-FORMAT YTICK-PRECISION YTICK-MAJOR YTICK-MINOR &allow-other-keys

Graph parameterization function.

Package

cl-grace

Source

grace-plot.lisp (file)

Methods
Method: graph OBJ &key PLOT REFRESH after
Method: graph (OBJ integer) &key PLOT TITLE SUBTITLE LEGEND-LOCATION XLABEL XSCALE XMIN XMAX XTICK-FORMAT XTICK-PRECISION XTICK-MAJOR XTICK-MINOR YLABEL YSCALE YMIN YMAX YTICK-FORMAT YTICK-PRECISION YTICK-MAJOR YTICK-MINOR
Generic Function: layout OBJ &key PLOT HGAP VGAP OFFSET &allow-other-keys

Graph layout function.

Package

cl-grace

Source

grace-plot.lisp (file)

Methods
Method: layout (OBJ integer) &key PLOT HGAP VGAP OFFSET
Method: layout (OBJ sequence) &key PLOT HGAP VGAP OFFSET
Generic Function: plot OBJ &rest ARGS &key PLOT GRAPH AUTOSCALE AUTOTICK REFRESH &allow-other-keys

Extensible function to plot objects in Grace.

Package

cl-grace

Source

grace-plot.lisp (file)

Methods
Method: plot OBJ &rest ARGS &key PLOT GRAPH &allow-other-keys

Plot an object in Grace.
Create a Grace ‘XY’ graph and plot the given object in it using the appropriate ‘REPLOT’ method, with auto-scaling and auto-ticking.

Method: plot OBJ &key PLOT GRAPH AUTOSCALE AUTOTICK REFRESH after
Generic Function: refresh-plot PLOT &key UPDATE-GUI REDRAW &allow-other-keys

Refresh the given plot.
Update the GUI and redraw the given plot. Override these individual behaviours with UPDATE-GUI and REDRAW when supplied.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: refresh-plot (PLOT plot) &key UPDATE-GUI REDRAW
Generic Function: replot OBJ &rest ARGS &key REAL IMAG XY X Y PLOT GRAPH DATASET LINE-TYPE LINE-STYLE LINE-WIDTH LINE-COLOR LINE-PATTERN SYMBOL-TYPE SYMBOL-STYLE SYMBOL-WIDTH SYMBOL-SIZE SYMBOL-COLOR SYMBOL-PATTERN SYMBOL-FILL-COLOR SYMBOL-FILL-PATTERN LEGEND REFRESH &allow-other-keys

Extensible function to update a plot with new data/options.

Package

cl-grace

Source

grace-plot.lisp (file)

Methods
Method: replot (SEQ sequence) &key REAL IMAG XY X Y PLOT GRAPH DATASET LINE-TYPE LINE-STYLE LINE-WIDTH LINE-COLOR LINE-PATTERN SYMBOL-TYPE SYMBOL-STYLE SYMBOL-WIDTH SYMBOL-SIZE SYMBOL-COLOR SYMBOL-PATTERN SYMBOL-FILL-COLOR SYMBOL-FILL-PATTERN LEGEND

Update a sequence plot with new data and/or options.
The actual data to be plotted is constructed using the function ‘FLATTEN-PLOT-SEQUENCE’ on the SEQ, REAL, IMAG, XY, X & Y arguments.

Method: replot OBJ &key PLOT REFRESH after
Generic Function: save-plot PLOT FILENAME &key &allow-other-keys

Save PLOT to FILENAME.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: save-plot (PLOT plot) FILENAME &key

Save PLOT to FILENAME as a Grace project file.

Generic Function: send-command PLOT COMMAND &key FLUSH &allow-other-keys

Send command to the given plot.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: send-command (PLOT plot) (COMMAND string) &key FLUSH
Generic Function: send-data PLOT GRAPH DATASET DATA &key TYPE APPEND REFRESH UPDATE-GUI REDRAW &allow-other-keys

Send data to a particular PLOT/GRAPH/SET.
Replace the set’s data with that given, unless APPEND is non-null in which case append to it. The data is assumed to be a sequence of dataset datum points, where each point resolves to a sequence of real numbers (via FLATTEN-DATUM and REALPART) representing X,Y,... values. The length of each point sequence should be consistent with TYPE, if supplied, which is a string-designator specifying the type of the dataset (e.g. "XYZ").
If REFRESH is non-nil then update the GUI and redraw the plot, or override these individual behaviours with UPDATE-GUI and REDRAW.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: send-data (PLOT plot) (GRAPH integer) (DATASET integer) (DATA sequence) &key TYPE APPEND REFRESH REDRAW UPDATE-GUI
Generic Function: send-dataset PLOT GRAPH DATASET DATA &key TYPE REFRESH UPDATE-GUI REDRAW &allow-other-keys

Send a complete dataset to Grace.
Instruct Grace to read in a whole dataset from a file, writing the data out to a temporary file first if necessary. The data is assumed to be a sequence of dataset datum points, where each point resolves to a sequence of floating point numbers (via ENCODE-DATUM) representing X,Y,... values, as appropriate to TYPE (if supplied, a string designator for the Grace set type, e.g. "XYDXDY"). If REFRESH is non-nil then update the GUI and redraw the plot. Alternatively, override these individual behaviours with UPDATE-GUI and REDRAW.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: send-dataset (PLOT plot) (GRAPH integer) (DATASET integer) (DATA sequence) &key TYPE REFRESH REDRAW UPDATE-GUI
Generic Function: set-dataset-annotation PLOT GRAPH DATASET &key ENABLE TYPE FONT SIZE COLOR ROTATION FORMAT PRECISION PREPEND APPEND OFFSET REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the annotation properties of a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-dataset-annotation (PLOT plot) (GRAPH integer) (DATASET integer) &key ENABLE TYPE FONT SIZE COLOR ROTATION FORMAT PRECISION PREPEND APPEND OFFSET REFRESH REDRAW UPDATE-GUI

Set the symbol parameters of a dataset.
ENABLE : boolean or string-designator ("on", "off")
TYPE : non-negative integer or string-designator
FONT : non-negative integer or string-designator
SIZE : non-negative integer
COLOR : non-negative integer, string-designator or RGB triple sequence ROTATION : non-negative integer
FORMAT : string-designator
PRECISION : non-negative integer
PREPEND : string
APPEND : string
OFFSET : complex number
REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-dataset-fill PLOT GRAPH DATASET &key TYPE RULE PATTERN COLOR BASELINE BASELINE-TYPE REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the fill parameters of a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-dataset-fill (PLOT plot) (GRAPH integer) (DATASET integer) &key TYPE RULE PATTERN COLOR BASELINE BASELINE-TYPE REFRESH REDRAW UPDATE-GUI

Set the fill parameters of a dataset.
TYPE : non-negative integer or string-designator
RULE : non-negative integer or string-designator
PATTERN : non-negative integer
COLOR : non-negative integer, string-designator or RGB triple sequence BASELINE : boolean or string-designator ("on", "off")
BASELINE-TYPE : non-negative integer or string-designator
REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-dataset-legend PLOT GRAPH DATASET &key TEXT REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the legend properties of a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-dataset-legend (PLOT plot) (GRAPH integer) (DATASET integer) &key TEXT REFRESH REDRAW UPDATE-GUI

Set the symbol parameters of a dataset. TEXT : string
REFRESH : boolean UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-dataset-line PLOT GRAPH DATASET &key TYPE STYLE WIDTH COLOR PATTERN DROPLINE REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the line parameters of a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-dataset-line (PLOT plot) (GRAPH integer) (DATASET integer) &key TYPE STYLE WIDTH COLOR PATTERN DROPLINE REFRESH REDRAW UPDATE-GUI

Set the line parameters of a dataset.
TYPE : non-negative integer or string-designator
STYLE : non-negative integer or string-designator
WIDTH : real
COLOR : non-negative integer, string-designator or RGB triple sequence PATTERN : non-negative integer
DROPLINE : boolean or string-designator ("on", "off")
REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-dataset-symbol PLOT GRAPH DATASET &key TYPE STYLE WIDTH SIZE COLOR PATTERN FILL-COLOR FILL-PATTERN CHAR CHAR-FONT SKIP REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the symbol parameters of a dataset.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-dataset-symbol (PLOT plot) (GRAPH integer) (DATASET integer) &key TYPE STYLE WIDTH SIZE COLOR PATTERN FILL-COLOR FILL-PATTERN CHAR CHAR-FONT SKIP REFRESH REDRAW UPDATE-GUI

Set the symbol parameters of a dataset.
TYPE : non-negative integer or string-designator
STYLE : non-negative integer
WIDTH : real
SIZE : real
COLOR : non-negative integer, string-designator or RGB triple sequence PATTERN : non-negative integer
FILL-COLOR : non-negative integer, string-designator or RGB triple sequence FILL-PATTERN : non-negative integer
CHAR : non-negative integer
CHAR-FONT : non-negative integer or string-designator
SKIP : non-negative integer
REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-graph-axes PLOT GRAPH &key XLABEL YLABEL XMIN XMAX YMIN YMAX XSCALE YSCALE XTICK XTICK-LABEL YTICK YTICK-LABEL XTICK-FORMAT XTICK-PRECISION YTICK-FORMAT YTICK-PRECISION XTICK-MAJOR XTICK-MINOR YTICK-MAJOR YTICK-MINOR XINV YINV REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the axes properties of a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-graph-axes (PLOT plot) (GRAPH integer) &key XLABEL YLABEL XMIN XMAX YMIN YMAX XSCALE YSCALE XTICK XTICK-LABEL YTICK YTICK-LABEL XTICK-FORMAT XTICK-PRECISION YTICK-FORMAT YTICK-PRECISION XTICK-MAJOR XTICK-MINOR YTICK-MAJOR YTICK-MINOR XINV YINV REFRESH REDRAW UPDATE-GUI

Set the axes properties of a graph.
XLABEL : string
YLABEL : string
XMIN : real
XMAX : real
YMIN : real
YMAX : real
XSCALE : string-designator ("normal", "log", "recip") YSCALE : string-designator ("normal", "log", "recip") XTICK : boolean or string-designator ("on", "off") XTICK-LABEL : boolean or string-designator ("on", "off") YTICK : boolean or string-designator ("on", "off") YTICK-LABEL : boolean or string-designator ("on", "off") XTICK-FORMAT : string-designator
XTICK-PRECISION : real
YTICK-FORMAT : string-designator
YTICK-PRECISION : real
XTICK-MAJOR : real
XTICK-MINOR : real
YTICK-MAJOR : real
YTICK-MINOR : real
XINV : boolean or string-designator ("on", "off") YINV : boolean or string-designator ("on", "off") REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-graph-legend PLOT GRAPH &key ONOFF LOCATION LOCTYPE FONT CHAR-SIZE COLOR VGAP HGAP LENGTH INVERT BOX BOX-COLOR BOX-PATTERN BOX-LINESTYLE BOX-LINEWIDTH BOX-FILL BOX-FILL-COLOR BOX-FILL-PATTERN REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the legend properties of a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-graph-legend (PLOT plot) (GRAPH integer) &key ONOFF LOCATION LOCTYPE FONT CHAR-SIZE COLOR VGAP HGAP LENGTH INVERT BOX BOX-COLOR BOX-PATTERN BOX-LINESTYLE BOX-LINEWIDTH BOX-FILL BOX-FILL-COLOR BOX-FILL-PATTERN REFRESH REDRAW UPDATE-GUI

Set the legend properties of a graph.
ONOFF : boolean or string-designator ("on", "off")
LOCATION : sequence of two reals
LOCTYPE : string-designator ("world", "view")
FONT : non-negative integer
CHAR-SIZE : non-negative integer
COLOR : non-negative integer, string-designator or RGB triple sequence VGAP : non-negative integer
LENGTH : non-negative integer
INVERT : boolean or string-designator ("on", "off")
BOX : boolean or string-designator ("on", "off")
BOX-COLOR : non-negative integer, string-designator or RGB triple sequence BOX-PATTERN : non-negative integer
BOX-LINESTYLE : non-negative integer
BOX-LINEWIDTH : non-negative integer
BOX-FILL : boolean or string-designator ("on", "off")
BOX-FILL-COLOR : non-negative integer, string-designator or RGB triple sequence BOX-FILL-PATTERN : non-negative integer
REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-graph-subtitle PLOT GRAPH &key SUBTITLE FONT SIZE COLOR REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the subtitle of a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-graph-subtitle (PLOT plot) (GRAPH integer) &key SUBTITLE FONT SIZE COLOR REFRESH REDRAW UPDATE-GUI

Set the subtitle properties of a graph.
SUBTITLE : string
FONT : non-negative integer
SIZE : non-negative integer
COLOR : non-negative integer, string-designator or RGB triple sequence REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-graph-title PLOT GRAPH &key TITLE FONT SIZE COLOR REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the title of a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-graph-title (PLOT plot) (GRAPH integer) &key TITLE FONT SIZE COLOR REFRESH REDRAW UPDATE-GUI

Set the title properties of a graph.
TITLE : string
FONT : non-negative integer
SIZE : non-negative integer
COLOR : non-negative integer, string-designator or RGB triple sequence REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean

Generic Function: set-graph-type PLOT GRAPH TYPE &key REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the type of a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-graph-type (PLOT plot) (GRAPH integer) TYPE &key REFRESH REDRAW UPDATE-GUI

Set the type of a graph.
TYPE : string-designator REFRESH : boolean UPDATE-GUI : boolean REDRAW : boolean

Generic Function: set-graph-view PLOT GRAPH &key XMIN XMAX YMIN YMAX REFRESH REDRAW UPDATE-GUI &allow-other-keys

Set the view location of a graph.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: set-graph-view (PLOT plot) (GRAPH integer) &key XMIN XMAX YMIN YMAX REFRESH REDRAW UPDATE-GUI

Set the viewport properties of a graph. XMIN : real
XMAX : real
YMIN : real
YMAX : real
REFRESH : boolean
UPDATE-GUI : boolean
REDRAW : boolean


Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: grace-plot ()

Encapsulate a grace process object.

Package

cl-grace

Source

grace-interface.lisp (file)

Direct superclasses

plot (class)

Direct methods
Direct slots
Slot: grace-program
Initargs

:grace-program

Readers

grace-program (generic function)

Writers

(setf grace-program) (generic function)

Slot: grace-args
Initargs

:grace-args

Readers

grace-args (generic function)

Writers

(setf grace-args) (generic function)

Slot: grace-process
Readers

grace-process (generic function)

Writers

(setf grace-process) (generic function)

Slot: grace-stream
Readers

grace-stream (generic function)

Writers

(setf grace-stream) (generic function)

Class: plot ()

A base class for plots.

Package

cl-grace

Source

grace-interface.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

grace-plot (class)

Direct methods

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *annotation-types*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *baseline-types*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *color-names*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *fill-rules*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *fill-types*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *format-names*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *line-styles*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *line-types*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *shape-names*
Package

cl-grace

Source

grace-interface.lisp (file)

Special Variable: *xytype-names*
Package

cl-grace

Source

grace-interface.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: annotation-type VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: baseline-type VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: char-integer VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: color-string VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: ensure-xy-vector VEC

Ensure VEC contains both x points and y points (at least).

Package

cl-grace

Source

grace-plot.lisp (file)

Function: fill-rule VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: fill-type VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: flatten-plot-sequence SEQ &key REAL IMAG XY X Y

Flatten a sequence of data points ready for plotting, return a vector. Each datapoint of SEQ should be a real or complex number, or an object which can be flattened to a list of such with a call to the generic function ‘FLATTEN-DATUM’. After flattening, the real and/or imaginary parts of each number are extracted according to the REAL and IMAG boolean arguments. When REAL and IMAG are both non-NIL then each number will expand to a pair of reals (real part followed by imaginary part). Optionally, XY, X and/or Y can also be given, which are assumed to be sequences of the same length as SEQ. When given, each datapoint of SEQ will be prefixed by the corresponding datapoint of XY, X, and/or Y, in that order.

Package

cl-grace

Source

grace-plot.lisp (file)

Function: font-string VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: format-name VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: line-style VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: line-type VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: on-or-off VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: remove-kw-args KWS ARGLIST

Remove keywords and their values from ARGLIST.

Package

cl-grace

Source

utils.lisp (file)

Function: shape-type VAL
Package

cl-grace

Source

grace-interface.lisp (file)

Function: xytype-name VAL
Package

cl-grace

Source

grace-interface.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Generic functions

Generic Function: grace-error-text CONDITION
Package

cl-grace

Methods
Method: grace-error-text (CONDITION grace-error)
Source

grace-interface.lisp (file)

Generic Function: grace-stream OBJECT
Generic Function: (setf grace-stream) NEW-VALUE OBJECT
Package

cl-grace

Methods
Method: grace-stream (GRACE-PLOT grace-plot)

automatically generated reader method

Source

grace-interface.lisp (file)

Method: (setf grace-stream) NEW-VALUE (GRACE-PLOT grace-plot)

automatically generated writer method

Source

grace-interface.lisp (file)

Generic Function: plot-command-stream PLOT

Return the output stream to use for sending commands to the given plot.

Package

cl-grace

Source

grace-interface.lisp (file)

Methods
Method: plot-command-stream (PLOT plot)
Method: plot-command-stream (PLOT grace-plot)

Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Conditions

Condition: grace-error ()
Package

cl-grace

Source

grace-interface.lisp (file)

Direct superclasses

error (condition)

Direct methods

grace-error-text (method)

Direct slots
Slot: text
Initargs

:text

Readers

grace-error-text (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-grace.asd: The cl-grace<dot>asd file
cl-grace/grace-interface.lisp: The cl-grace/grace-interface<dot>lisp file
cl-grace/grace-plot.lisp: The cl-grace/grace-plot<dot>lisp file
cl-grace/packages.lisp: The cl-grace/packages<dot>lisp file
cl-grace/utils.lisp: The cl-grace/utils<dot>lisp file

F
File, Lisp, cl-grace.asd: The cl-grace<dot>asd file
File, Lisp, cl-grace/grace-interface.lisp: The cl-grace/grace-interface<dot>lisp file
File, Lisp, cl-grace/grace-plot.lisp: The cl-grace/grace-plot<dot>lisp file
File, Lisp, cl-grace/packages.lisp: The cl-grace/packages<dot>lisp file
File, Lisp, cl-grace/utils.lisp: The cl-grace/utils<dot>lisp file

L
Lisp File, cl-grace.asd: The cl-grace<dot>asd file
Lisp File, cl-grace/grace-interface.lisp: The cl-grace/grace-interface<dot>lisp file
Lisp File, cl-grace/grace-plot.lisp: The cl-grace/grace-plot<dot>lisp file
Lisp File, cl-grace/packages.lisp: The cl-grace/packages<dot>lisp file
Lisp File, cl-grace/utils.lisp: The cl-grace/utils<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   L   M   N   O   P   R   S   W   X  
Index Entry  Section

(
(setf grace-args): Exported generic functions
(setf grace-args): Exported generic functions
(setf grace-process): Exported generic functions
(setf grace-process): Exported generic functions
(setf grace-program): Exported generic functions
(setf grace-program): Exported generic functions
(setf grace-stream): Internal generic functions
(setf grace-stream): Internal generic functions

A
active-plot-p: Exported generic functions
active-plot-p: Exported generic functions
active-plot-p: Exported generic functions
annotation-type: Internal functions
arrange-graphs: Exported generic functions
arrange-graphs: Exported generic functions
autoscale-graph: Exported generic functions
autoscale-graph: Exported generic functions
autotick-graph: Exported generic functions
autotick-graph: Exported generic functions

B
baseline-type: Internal functions

C
char-integer: Internal functions
close-plot: Exported generic functions
close-plot: Exported generic functions
close-plot: Exported generic functions
cmd: Exported generic functions
cmd: Exported generic functions
color-string: Internal functions
connect-plot: Exported functions
create-dataset: Exported generic functions
create-dataset: Exported generic functions
create-graph: Exported generic functions
create-graph: Exported generic functions

D
delete-dataset: Exported generic functions
delete-dataset: Exported generic functions
delete-graph: Exported generic functions
delete-graph: Exported generic functions
disconnect-plot: Exported generic functions
disconnect-plot: Exported generic functions

E
encode-datum: Exported generic functions
encode-datum: Exported generic functions
encode-datum: Exported generic functions
ensure-active-plot: Exported functions
ensure-clear-graph: Exported functions
ensure-xy-vector: Internal functions

F
fill-rule: Internal functions
fill-type: Internal functions
flatten-datum: Exported generic functions
flatten-datum: Exported generic functions
flatten-datum: Exported generic functions
flatten-plot-sequence: Internal functions
font-string: Internal functions
format-name: Internal functions
Function, annotation-type: Internal functions
Function, baseline-type: Internal functions
Function, char-integer: Internal functions
Function, color-string: Internal functions
Function, connect-plot: Exported functions
Function, ensure-active-plot: Exported functions
Function, ensure-clear-graph: Exported functions
Function, ensure-xy-vector: Internal functions
Function, fill-rule: Internal functions
Function, fill-type: Internal functions
Function, flatten-plot-sequence: Internal functions
Function, font-string: Internal functions
Function, format-name: Internal functions
Function, hsv->rgb: Exported functions
Function, line-style: Internal functions
Function, line-type: Internal functions
Function, new-plot: Exported functions
Function, on-or-off: Internal functions
Function, open-plot: Exported functions
Function, remove-kw-args: Internal functions
Function, shape-type: Internal functions
Function, xytype-name: Internal functions

G
Generic Function, (setf grace-args): Exported generic functions
Generic Function, (setf grace-process): Exported generic functions
Generic Function, (setf grace-program): Exported generic functions
Generic Function, (setf grace-stream): Internal generic functions
Generic Function, active-plot-p: Exported generic functions
Generic Function, arrange-graphs: Exported generic functions
Generic Function, autoscale-graph: Exported generic functions
Generic Function, autotick-graph: Exported generic functions
Generic Function, close-plot: Exported generic functions
Generic Function, cmd: Exported generic functions
Generic Function, create-dataset: Exported generic functions
Generic Function, create-graph: Exported generic functions
Generic Function, delete-dataset: Exported generic functions
Generic Function, delete-graph: Exported generic functions
Generic Function, disconnect-plot: Exported generic functions
Generic Function, encode-datum: Exported generic functions
Generic Function, flatten-datum: Exported generic functions
Generic Function, grace-args: Exported generic functions
Generic Function, grace-error-text: Internal generic functions
Generic Function, grace-process: Exported generic functions
Generic Function, grace-program: Exported generic functions
Generic Function, grace-stream: Internal generic functions
Generic Function, graph: Exported generic functions
Generic Function, layout: Exported generic functions
Generic Function, plot: Exported generic functions
Generic Function, plot-command-stream: Internal generic functions
Generic Function, refresh-plot: Exported generic functions
Generic Function, replot: Exported generic functions
Generic Function, save-plot: Exported generic functions
Generic Function, send-command: Exported generic functions
Generic Function, send-data: Exported generic functions
Generic Function, send-dataset: Exported generic functions
Generic Function, set-dataset-annotation: Exported generic functions
Generic Function, set-dataset-fill: Exported generic functions
Generic Function, set-dataset-legend: Exported generic functions
Generic Function, set-dataset-line: Exported generic functions
Generic Function, set-dataset-symbol: Exported generic functions
Generic Function, set-graph-axes: Exported generic functions
Generic Function, set-graph-legend: Exported generic functions
Generic Function, set-graph-subtitle: Exported generic functions
Generic Function, set-graph-title: Exported generic functions
Generic Function, set-graph-type: Exported generic functions
Generic Function, set-graph-view: Exported generic functions
grace-args: Exported generic functions
grace-args: Exported generic functions
grace-error-text: Internal generic functions
grace-error-text: Internal generic functions
grace-process: Exported generic functions
grace-process: Exported generic functions
grace-program: Exported generic functions
grace-program: Exported generic functions
grace-stream: Internal generic functions
grace-stream: Internal generic functions
graph: Exported generic functions
graph: Exported generic functions
graph: Exported generic functions

H
hsv->rgb: Exported functions

L
layout: Exported generic functions
layout: Exported generic functions
layout: Exported generic functions
line-style: Internal functions
line-type: Internal functions

M
Macro, without-refresh: Exported macros
Method, (setf grace-args): Exported generic functions
Method, (setf grace-process): Exported generic functions
Method, (setf grace-program): Exported generic functions
Method, (setf grace-stream): Internal generic functions
Method, active-plot-p: Exported generic functions
Method, active-plot-p: Exported generic functions
Method, arrange-graphs: Exported generic functions
Method, autoscale-graph: Exported generic functions
Method, autotick-graph: Exported generic functions
Method, close-plot: Exported generic functions
Method, close-plot: Exported generic functions
Method, cmd: Exported generic functions
Method, create-dataset: Exported generic functions
Method, create-graph: Exported generic functions
Method, delete-dataset: Exported generic functions
Method, delete-graph: Exported generic functions
Method, disconnect-plot: Exported generic functions
Method, encode-datum: Exported generic functions
Method, encode-datum: Exported generic functions
Method, flatten-datum: Exported generic functions
Method, flatten-datum: Exported generic functions
Method, grace-args: Exported generic functions
Method, grace-error-text: Internal generic functions
Method, grace-process: Exported generic functions
Method, grace-program: Exported generic functions
Method, grace-stream: Internal generic functions
Method, graph: Exported generic functions
Method, graph: Exported generic functions
Method, layout: Exported generic functions
Method, layout: Exported generic functions
Method, plot: Exported generic functions
Method, plot: Exported generic functions
Method, plot-command-stream: Internal generic functions
Method, plot-command-stream: Internal generic functions
Method, refresh-plot: Exported generic functions
Method, replot: Exported generic functions
Method, replot: Exported generic functions
Method, save-plot: Exported generic functions
Method, send-command: Exported generic functions
Method, send-data: Exported generic functions
Method, send-dataset: Exported generic functions
Method, set-dataset-annotation: Exported generic functions
Method, set-dataset-fill: Exported generic functions
Method, set-dataset-legend: Exported generic functions
Method, set-dataset-line: Exported generic functions
Method, set-dataset-symbol: Exported generic functions
Method, set-graph-axes: Exported generic functions
Method, set-graph-legend: Exported generic functions
Method, set-graph-subtitle: Exported generic functions
Method, set-graph-title: Exported generic functions
Method, set-graph-type: Exported generic functions
Method, set-graph-view: Exported generic functions

N
new-plot: Exported functions

O
on-or-off: Internal functions
open-plot: Exported functions

P
plot: Exported generic functions
plot: Exported generic functions
plot: Exported generic functions
plot-command-stream: Internal generic functions
plot-command-stream: Internal generic functions
plot-command-stream: Internal generic functions

R
refresh-plot: Exported generic functions
refresh-plot: Exported generic functions
remove-kw-args: Internal functions
replot: Exported generic functions
replot: Exported generic functions
replot: Exported generic functions

S
save-plot: Exported generic functions
save-plot: Exported generic functions
send-command: Exported generic functions
send-command: Exported generic functions
send-data: Exported generic functions
send-data: Exported generic functions
send-dataset: Exported generic functions
send-dataset: Exported generic functions
set-dataset-annotation: Exported generic functions
set-dataset-annotation: Exported generic functions
set-dataset-fill: Exported generic functions
set-dataset-fill: Exported generic functions
set-dataset-legend: Exported generic functions
set-dataset-legend: Exported generic functions
set-dataset-line: Exported generic functions
set-dataset-line: Exported generic functions
set-dataset-symbol: Exported generic functions
set-dataset-symbol: Exported generic functions
set-graph-axes: Exported generic functions
set-graph-axes: Exported generic functions
set-graph-legend: Exported generic functions
set-graph-legend: Exported generic functions
set-graph-subtitle: Exported generic functions
set-graph-subtitle: Exported generic functions
set-graph-title: Exported generic functions
set-graph-title: Exported generic functions
set-graph-type: Exported generic functions
set-graph-type: Exported generic functions
set-graph-view: Exported generic functions
set-graph-view: Exported generic functions
shape-type: Internal functions

W
without-refresh: Exported macros

X
xytype-name: Internal functions

Jump to:   (  
A   B   C   D   E   F   G   H   L   M   N   O   P   R   S   W   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
G   S   T  
Index Entry  Section

*
*annotation-types*: Internal special variables
*autoscale-graph*: Exported special variables
*autotick-graph*: Exported special variables
*baseline-types*: Internal special variables
*color-names*: Internal special variables
*dataset*: Exported special variables
*fill-rules*: Internal special variables
*fill-types*: Internal special variables
*format-names*: Internal special variables
*grace-args*: Exported special variables
*grace-program*: Exported special variables
*graph*: Exported special variables
*line-styles*: Internal special variables
*line-types*: Internal special variables
*plot*: Exported special variables
*refresh-plot*: Exported special variables
*shape-names*: Internal special variables
*xytype-names*: Internal special variables

G
grace-args: Exported classes
grace-process: Exported classes
grace-program: Exported classes
grace-stream: Exported classes

S
Slot, grace-args: Exported classes
Slot, grace-process: Exported classes
Slot, grace-program: Exported classes
Slot, grace-stream: Exported classes
Slot, text: Internal conditions
Special Variable, *annotation-types*: Internal special variables
Special Variable, *autoscale-graph*: Exported special variables
Special Variable, *autotick-graph*: Exported special variables
Special Variable, *baseline-types*: Internal special variables
Special Variable, *color-names*: Internal special variables
Special Variable, *dataset*: Exported special variables
Special Variable, *fill-rules*: Internal special variables
Special Variable, *fill-types*: Internal special variables
Special Variable, *format-names*: Internal special variables
Special Variable, *grace-args*: Exported special variables
Special Variable, *grace-program*: Exported special variables
Special Variable, *graph*: Exported special variables
Special Variable, *line-styles*: Internal special variables
Special Variable, *line-types*: Internal special variables
Special Variable, *plot*: Exported special variables
Special Variable, *refresh-plot*: Exported special variables
Special Variable, *shape-names*: Internal special variables
Special Variable, *xytype-names*: Internal special variables

T
text: Internal conditions

Jump to:   *  
G   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   G   P   S  
Index Entry  Section

C
cl-grace: The cl-grace system
cl-grace: The cl-grace package
Class, grace-plot: Exported classes
Class, plot: Exported classes
Condition, grace-error: Internal conditions

G
grace-error: Internal conditions
grace-plot: Exported classes

P
Package, cl-grace: The cl-grace package
plot: Exported classes

S
System, cl-grace: The cl-grace system

Jump to:   C   G   P   S