Veusz - a scientific plotting package

2.1. Widget
2.2. Settings: properties and formatting
2.3. Text
2.4. Measurements
2.5. Axis numeric scales

1. Standard text import

2. Reading data

1.1. Data types in text import
1.2. Descriptors

2. CSV files

3. HDF5 files

3.1. Error bars
3.2. Slices
3.3. 2D data ranges
3.4. Dates

4. 2D text or CSV format

5. FITS files

6. Reading other data formats

7. Manipulating datasets

7.1. Using dataset plugins
7.2. Using expressions to create new datasets
7.3. Linking datasets to expressions
7.4. Splitting data
7.5. Defining new constants or functions
7.6. Dataset plugins

8. Capturing data

3. Command line interface

2.1. Action
2.2. Add
2.3. AddCustom
2.4. AddImportPath
2.5. CloneWidget
2.6. Close
2.7. CreateHistogram
2.8. DatasetPlugin
2.9. EnableToolbar
2.10. Export
2.11. FilterDatasets
2.12. ForceUpdate
2.13. Get
2.14. GetChildren
2.15. GetClick
2.16. GetData
2.17. GetDataType
2.18. GetDatasets
2.19. GPL
2.20. ImportFile
2.21. ImportFile2D
2.22. ImportFileCSV
2.23. ImportFileHDF5
2.24. ImportFilePlugin
2.25. ImportFITSFile
2.26. ImportString
2.27. ImportString2D
2.28. IsClosed
2.29. List
2.30. Load
2.31. MoveToPage
2.32. ReloadData
2.33. Rename
2.34. Remove
2.35. ResizeWindow
2.36. Save
2.37. Set
2.38. SetAntiAliasing
2.39. SetData
2.40. SetDataExpression
2.41. SetDataRange
2.42. SetData2D
2.43. SetData2DExpression
2.44. SetData2DExpressionXYZ
2.45. SetData2DXYFunc
2.46. SetDataDateTime
2.47. SetDataText
2.48. SetToReference
2.49. SetUpdateInterval
2.50. SetVerbose
2.51. StartSecondView
2.52. TagDatasets
2.53. To
2.54. Quit
2.55. WaitForClose
2.56. Zoom

4. Using Veusz from other programs

1.1. Older path-based interface
1.2. New-style object interface
1.3. Translating old to new style

Chapter 1. Introduction

Table of Contents

2.1. Widget
2.2. Settings: properties and formatting
2.3. Text
2.4. Measurements
2.5. Axis numeric scales

1. Veusz

Veusz is a scientific plotting package. It was designed to + details, or see http://www.gnu.org/licenses/gpl-2.0.html.

Table of Contents

2.1. Widget
2.2. Settings: properties and formatting
2.3. Text
2.4. Measurements
2.5. Axis numeric scales

1. Standard text import

2. Reading data

1.1. Data types in text import
1.2. Descriptors

2. CSV files

3. HDF5 files

3.1. Error bars
3.2. Slices
3.3. 2D data ranges
3.4. Dates

4. 2D text or CSV format

5. FITS files

6. Reading other data formats

7. Manipulating datasets

7.1. Using dataset plugins
7.2. Using expressions to create new datasets
7.3. Linking datasets to expressions
7.4. Splitting data
7.5. Defining new constants or functions
7.6. Dataset plugins

8. Capturing data

3. Command line interface

2.1. Action
2.2. Add
2.3. AddCustom
2.4. AddImportPath
2.5. CloneWidget
2.6. Close
2.7. CreateHistogram
2.8. DatasetPlugin
2.9. EnableToolbar
2.10. Export
2.11. FilterDatasets
2.12. ForceUpdate
2.13. Get
2.14. GetChildren
2.15. GetClick
2.16. GetData
2.17. GetDataType
2.18. GetDatasets
2.19. GPL
2.20. ImportFile
2.21. ImportFile2D
2.22. ImportFileCSV
2.23. ImportFileHDF5
2.24. ImportFilePlugin
2.25. ImportFITSFile
2.26. ImportString
2.27. ImportString2D
2.28. IsClosed
2.29. List
2.30. Load
2.31. MoveToPage
2.32. ReloadData
2.33. Rename
2.34. Remove
2.35. ResizeWindow
2.36. Save
2.37. Set
2.38. SetAntiAliasing
2.39. SetData
2.40. SetDataExpression
2.41. SetDataRange
2.42. SetData2D
2.43. SetData2DExpression
2.44. SetData2DExpressionXYZ
2.45. SetData2DXYFunc
2.46. SetDataDateTime
2.47. SetDataText
2.48. SetToReference
2.49. SetUpdateInterval
2.50. SetVerbose
2.51. StartSecondView
2.52. TagDatasets
2.53. To
2.54. Quit
2.55. WaitForClose
2.56. Zoom

4. Using Veusz from other programs

1.1. Older path-based interface
1.2. New-style object interface
1.3. Translating old to new style

Chapter 1. Introduction

Table of Contents

2.1. Widget
2.2. Settings: properties and formatting
2.3. Text
2.4. Measurements
2.5. Axis numeric scales

1. Veusz

Veusz is a scientific plotting package. It was designed to be easy to use, easily extensible, but powerful. The program features a graphical user interface, which works under Unix/Linux, Windows or Mac OS X. It can also be easily scripted @@ -20,7 +20,7 @@ different data file types can be added with import plugins. Dataset plugins automate the manipulation of datasets. Tools plugins automate the manipulation of the - document.

2. Terminology

Here we define some terminology for future use.

2.1. Widget

A document and its graphs are built up from widgets. + document.

2. Terminology

Here we define some terminology for future use.

2.1. Widget

A document and its graphs are built up from widgets. These widgets can often by placed within each other, depending on the type of the widget. A widget has children (those widgets placed within it) and its parent. The widgets have a @@ -185,7 +185,7 @@ directly on the page rather than in a graph.

ternary - plot data of three variables which add up to 100 per cent.This is a non-orthogonal plot and is placed directly on the page - rather than in a graph.

2.2. Settings: properties and formatting

The various settings of the widgets come in a number of + rather than in a graph.

2.2. Settings: properties and formatting

The various settings of the widgets come in a number of types, including integers (e.g. 10), floats (e.g. 3.14), dataset names ("mydata"), expressions ("x+y"), text ("hi there!"), distances (see above), options ("horizontal" or @@ -202,7 +202,7 @@ menu. Default settings are set on a per-document basis, but can be saved into a separate file and loaded. A default default settings file can be given to use for new documents - (set in the preferences dialog).

2.3. Text

Veusz understands a limited set of LaTeX-like formatting + (set in the preferences dialog).

2.3. Text

Veusz understands a limited set of LaTeX-like formatting for text. There are some differences (for example, "10^23" puts the 2 and 3 into superscript), but it is fairly similar. You should also leave out the dollar signs. Veusz @@ -240,12 +240,12 @@ can also include special characters directly, by copying and pasting from a character map application. If your current font does not contain these symbols then you may get a box - character.

2.4. Measurements

Distances, widths and lengths in Veusz can be specified + character.

2.4. Measurements

Distances, widths and lengths in Veusz can be specified in a number of different ways. These include absolute distances specified in physical units, e.g. 1cm, 0.05m, 10mm, 5in and 10pt, and relative units, which are relative to the largest dimension of the page, including 5%, 1/20, - 0.05.

2.5. Axis numeric scales

The way in which numbers are formatted in axis scales is + 0.05.

2.5. Axis numeric scales

The way in which numbers are formatted in axis scales is chosen automatically. For standard numerical axes, values are shown with the "%Vg" formatting (see below). For date axes, an appropriate date formatting is used so that the interval shown @@ -277,8 +277,8 @@ (Monday as first day of week), "x" date representation, "X" time representation, "y" year without century 00..99 and "Y" year. "%VDVS" is a special Veusz addon format which shows - seconds and fractions of seconds (e.g. 12.2).

3. Installation

Please look at the Installation notes (INSTALL) for - details on installing Veusz.

4. The main window

You should see the main window when you run Veusz (you can + seconds and fractions of seconds (e.g. 12.2).

3. Installation

Please look at the Installation notes (INSTALL) for + details on installing Veusz.

4. The main window

You should see the main window when you run Veusz (you can just type the veusz command in Unix).

The Veusz window is split into several sections. At the top is the menu bar and tool bar. These work in the usual way to other applications. Sometimes options are disabled (greyed out) @@ -318,7 +318,7 @@ the right of the screen. This window allows you to view the datasets currently loaded, their dimensions and type. Hovering a mouse over the size of the dataset will give you a preview of - the data.

5. My first plot

After opening Veusz, on the left of the main window, you + the data.

5. My first plot

After opening Veusz, on the left of the main window, you will see a Document, containing a Page, which contains a Graph with its axes. The Graph is selected in the selection window. The toolbar above adds a new widget to the selected @@ -372,7 +372,7 @@ subsetting, and clicking on the "hide" option. You can change the colour of the marker by going to the "Marker Fill" subsetting, and entering a new colour (e.g. red), into the - colour property.

Chapter 2. Reading data

Currently Veusz supports reading data from files with text, CSV, HDF5, FITS, 2D text or CSV, QDP, binary and NPY/NPZ formats. Use the @@ -397,7 +397,7 @@ suffix can be given when importing. These are added to the front or back of each dataset name imported. They are convenient for grouping data together. -

We list the various types of import below.

1. Standard text import

We list the various types of import below.

1. Standard text import

The default text import operates on simple text files. The data are assumed to be in columns separated by whitespace. Each column corresponds to dataset (or its error @@ -426,7 +426,7 @@ datasets are created for each block, using a numeric suffix giving the block number, e.g. _1, _2. -

1.1. Data types in text import

Veusz supports reading in several types of data. The type of data can be added in round brackets after the name in the descriptor. Veusz will try to guess the type of data based @@ -461,7 +461,7 @@ supports dates and times in the local format, though take note that the same file and data may not work on a system in a different location. -

1.2. Descriptors

A list of datasets, or a "Descriptor", is given in the Import dialog to describe how the data are formatted in the import file. The descriptor at its simplest is a space or @@ -507,7 +507,7 @@ 7 8 9 # etc... -

1.2.1. Descriptor examples

x y two columns are present in the file, they will be read in as datasets "x" and "y".
@@ -541,7 +541,7 @@ foo,,+- read the first column as the foo dataset, skip a column, and read the third column as its symmetric error. -

2. CSV files

CVS (comma separated variable) files are often written from other programs, such as spreadsheets, including Excel and Gnumeric. Veusz supports reading from these files. @@ -569,7 +569,7 @@ import dialog box - see the examples given. In addition CSV files support numbers in European format (e.g. 2,34 rather than 2.34), depending on the setting in the dialog box. -

3. HDF5 files

HDF5 is a flexible data format. Datasets and tables can be stored in a hierarchical arrangements of groups within a file. Veusz supports reading 1D numeric, text, date-time or 2D @@ -590,7 +590,7 @@ vsz_ attributes for columns are given by appending the suffix _columnname to the attribute. -

3.1. Error bars

Error bars are supported in two ways. The first way is to combine 1D datasets. For the datasets which are error bars, use a name which is the same as the main dataset but with @@ -602,7 +602,7 @@ dataset. This second method can also be enabled by adding an HDF5 attribute vsz_twod_as_oned set to a non-zero value for the dataset. -

3.2. Slices

As Veusz only supports 1D and 2D datasets, you may wish to reduce the dimensions of a dataset before importing by slicing. You can also give a slice to import a subset of a @@ -617,7 +617,7 @@ stopping index and optionally c is the step size. A slice can also be specified by providing an HDF5 attribute vsz_slice for the dataset. -

3.3. 2D data ranges

2D data have an associated X and Y range. By default the number of pixels of the image are used to give this range. A range can be specified by clicking on the dataset and @@ -626,7 +626,7 @@ the dataset vsz_range, which should be set to an array of four values (minimum x, minimum y, maximum x, maximum y). -

3.4. Dates

Date/time datasets can be made from a 1D numeric dataset or from a text dataset. For the 1D dataset, use the number of seconds relative to the start of the year 2009 (this is @@ -648,7 +648,7 @@ this, set the attribute vsz_convert_datetime to the format expression or iso to specify ISO format. -

4. 2D text or CSV format

Veusz can import 2D data from standard text or CSV files. In this case the data should consist of a matrix of data values, with the columns separated by one or more spaces or tabs and @@ -698,7 +698,7 @@ after importing data.

gridatedge - the first row and leftmost column give the positions of the centres of the pixels. This is also an option in the import dialog. The - values should be increasing or decreasing.

5. FITS files

+ values should be increasing or decreasing.

5. FITS files

1D or 2D data can be read from FITS files. 1D data, with optional errors bars, can be read from table extensions, and 2D data from image or primary extensions. Note that pyfits or @@ -721,7 +721,7 @@ coordinates are multiplied by the respective CDELT1/2 values and added to the CRVAL1/2 values. -

6. Reading other data formats

As mentioned above, a user may write some Python code to +

6. Reading other data formats

As mentioned above, a user may write some Python code to read a data file or set of data files. To write a plugin which is incorportated into Veusz, see http://barmag.net/veusz-wiki/ImportPlugins

You can also include Python code in an input file to read @@ -745,19 +745,19 @@ SetData('x', x, symerr=0.1) SetData('y', y) -

7. Manipulating datasets

Imported datasets can easily be modified in the Data +

7. Manipulating datasets

Imported datasets can easily be modified in the Data Editor dialog box. This dialog box can also be used to create new datasets from scratch by typing them in. The Data Create dialog box is used to new datasets as a numerical sequence, parametrically or based on other datasets given expressions. If you want to plot a function of a dataset, you often do not have to create a new dataset. Veusz allows to enter expressions - directly in many places.

7.1. Using dataset plugins

Dataset plugins can be used to perform arbitrary + directly in many places.

7.1. Using dataset plugins

Dataset plugins can be used to perform arbitrary manipulation of datasets. Veusz includes several plugins for mathematical operation of data and other dataset manipulations, such as concatenation or splitting. If you wish to write your own plugins look at - http://barmag.net/veusz-wiki/DatasetPlugins.

7.2. Using expressions to create new datasets

For instance, if the user has already imported dataset d, + http://barmag.net/veusz-wiki/DatasetPlugins.

7.2. Using expressions to create new datasets

For instance, if the user has already imported dataset d, then they can create d2 which consists of d**2. Expressions are in Python numpy syntax and can include the usual mathematical functions.

Expressions for error bars can also be given. By appending @@ -781,27 +781,27 @@ surrounding them by brackets. For example (a,0.1) plots dataset a as the data, with symmetric errors bars of 0.1. Asymmetric bars are given as - (a,a*0.1,-a*0.1).

7.3. Linking datasets to expressions

A particularly useful feature is to be able to link a + (a,a*0.1,-a*0.1).

7.3. Linking datasets to expressions

A particularly useful feature is to be able to link a dataset to an expression, so if the expression changes the - dataset changes with it, like in a spreadsheet.

7.4. Splitting data

Data can also be chopped in this method, for example + dataset changes with it, like in a spreadsheet.

7.4. Splitting data

Data can also be chopped in this method, for example using the expression x[10:20], which makes a dataset based on the 11th to 20th item in the x dataset (the ranges are Python syntax, and are zero-based). Negative indices count backwards from the end of the dataset. Data can be skipped using expressions such as - data[::2], which skips every other element

7.5. Defining new constants or functions

User defined constants or functions can be defined in + data[::2], which skips every other element

7.5. Defining new constants or functions

User defined constants or functions can be defined in the "Custom definitions" dialog box under the edit menu. Functions can also be imported from external python modules.

Custom definitions are defined on a per-document basis, but can be saved or loaded into a file. A default custom definitions file can be set in the preferences dialog - box.

7.6. Dataset plugins

In addition to creating datasets based on expressions, a + box.

7.6. Dataset plugins

In addition to creating datasets based on expressions, a variety of dataset plugins exist, which make certain operations on datasets much more convenient. See the Data, Operations menu for a list of the default plugins. The user can easily create new plugins. See http://barmag.net/veusz-wiki/DatasetPlugins for details. -

8. Capturing data

In addition to the standard data import, data can be captured as it is created from an external program, a network socket or a file or named pipe. When capturing from a file, the @@ -829,7 +829,7 @@ capture. Click Finish or Cancel to stop. Cancelling destroys captured data. -

Chapter 3. Command line interface

Table of Contents

2.1. Action
2.2. Add
2.3. AddCustom
2.4. AddImportPath
2.5. CloneWidget
2.6. Close
2.7. CreateHistogram
2.8. DatasetPlugin
2.9. EnableToolbar
2.10. Export
2.11. FilterDatasets
2.12. ForceUpdate
2.13. Get
2.14. GetChildren
2.15. GetClick
2.16. GetData
2.17. GetDataType
2.18. GetDatasets
2.19. GPL
2.20. ImportFile
2.21. ImportFile2D
2.22. ImportFileCSV
2.23. ImportFileHDF5
2.24. ImportFilePlugin
2.25. ImportFITSFile
2.26. ImportString
2.27. ImportString2D
2.28. IsClosed
2.29. List
2.30. Load
2.31. MoveToPage
2.32. ReloadData
2.33. Rename
2.34. Remove
2.35. ResizeWindow
2.36. Save
2.37. Set
2.38. SetAntiAliasing
2.39. SetData
2.40. SetDataExpression
2.41. SetDataRange
2.42. SetData2D
2.43. SetData2DExpression
2.44. SetData2DExpressionXYZ
2.45. SetData2DXYFunc
2.46. SetDataDateTime
2.47. SetDataText
2.48. SetToReference
2.49. SetUpdateInterval
2.50. SetVerbose
2.51. StartSecondView
2.52. TagDatasets
2.53. To
2.54. Quit
2.55. WaitForClose
2.56. Zoom

1. Introduction

An alternative way to control Veusz is via its command +

Chapter 3. Command line interface

Table of Contents

2.1. Action
2.2. Add
2.3. AddCustom
2.4. AddImportPath
2.5. CloneWidget
2.6. Close
2.7. CreateHistogram
2.8. DatasetPlugin
2.9. EnableToolbar
2.10. Export
2.11. FilterDatasets
2.12. ForceUpdate
2.13. Get
2.14. GetChildren
2.15. GetClick
2.16. GetData
2.17. GetDataType
2.18. GetDatasets
2.19. GPL
2.20. ImportFile
2.21. ImportFile2D
2.22. ImportFileCSV
2.23. ImportFileHDF5
2.24. ImportFilePlugin
2.25. ImportFITSFile
2.26. ImportString
2.27. ImportString2D
2.28. IsClosed
2.29. List
2.30. Load
2.31. MoveToPage
2.32. ReloadData
2.33. Rename
2.34. Remove
2.35. ResizeWindow
2.36. Save
2.37. Set
2.38. SetAntiAliasing
2.39. SetData
2.40. SetDataExpression
2.41. SetDataRange
2.42. SetData2D
2.43. SetData2DExpression
2.44. SetData2DExpressionXYZ
2.45. SetData2DXYFunc
2.46. SetDataDateTime
2.47. SetDataText
2.48. SetToReference
2.49. SetUpdateInterval
2.50. SetVerbose
2.51. StartSecondView
2.52. TagDatasets
2.53. To
2.54. Quit
2.55. WaitForClose
2.56. Zoom

1. Introduction

An alternative way to control Veusz is via its command line interface. As Veusz is a a Python application it uses Python as its scripting language. Therefore you can freely mix Veusz and Python commands on the command line. Veusz can also @@ -846,11 +846,11 @@ or using veusz_listen. Commands specific to particular modes are documented as such.

Veusz also includes a new object-oriented version of the interface, which is documented at - http://barmag.net/veusz-wiki/EmbeddingPython.

2. Commands

We list the allowed set of commands below

2.1. Action

Action('actionname', + http://barmag.net/veusz-wiki/EmbeddingPython.

2. Commands

We list the allowed set of commands below

2.1. Action

Action('actionname', componentpath='.')
Initiates the specified action on the widget (component) given the action name. Actions perform certain automated routines. These include "fit" on a fit widget, and - "zeroMargins" on grids.

2.2. Add

Add('widgettype', name='nameforwidget', + "zeroMargins" on grids.

2.2. Add

Add('widgettype', name='nameforwidget', autoadd=True, optionalargs)
The Add command adds a graph into the current widget (See the To command to change the current position).
The first argument is the type of widget to add. These @@ -863,7 +863,7 @@ given, for example Add('axis', name='y', direction='vertical').
Subsettings may be set by using double underscores, for example Add('xy', - MarkerFill__color='red', ErrorBarLine__hide=True).
Returns: Name of widget added.

2.3. AddCustom

AddCustom(type, name, value)
Add a custom definition for evaluation of + MarkerFill__color='red', ErrorBarLine__hide=True).
Returns: Name of widget added.

2.3. AddCustom

AddCustom(type, name, value)
Add a custom definition for evaluation of expressions. This can define a constant (can be in terms of other constants), a function of 1 or more variables, or a function imported from an external python module.
ctype is "constant", "function" or "import".
name is name of constant, or "function(x, y, ...)" or @@ -874,12 +874,12 @@ name. If mode is 'replace', it replaces any existing definition in the same place in the list or is appended otherwise. If mode is 'append', then an existing definition is - deleted, and the new one appended to the end.

2.4. AddImportPath

AddImportPath(directory)
Add a directory to the list of directories to try to - import data from.

2.5. CloneWidget

CloneWidget(widget, newparent, + deleted, and the new one appended to the end.

2.4. AddImportPath

AddImportPath(directory)
Add a directory to the list of directories to try to + import data from.

2.5. CloneWidget

CloneWidget(widget, newparent, newname=None)
Clone the widget given, placing the copy in newparent and the name given. newname is an optional new name to give - it Returns new widget path.

2.6. Close

Close()
Closes the plotwindow. This is only supported in - embedded mode.

2.7. CreateHistogram

CreateHistogram(inexpr, outbinsds, + it Returns new widget path.

2.6. Close

Close()
Closes the plotwindow. This is only supported in + embedded mode.

2.7. CreateHistogram

CreateHistogram(inexpr, outbinsds, outvalsds, binparams=None, binmanual=None, method='counts', cumulative = 'none', errors=False)
@@ -892,15 +892,15 @@ calculate cumulative distributions which is 'none', 'smalltolarge' or 'largetosmall'. errors is to calculate Poisson error bars. -

2.8. DatasetPlugin

DatasetPlugin(pluginname, fields, +

2.8. DatasetPlugin

DatasetPlugin(pluginname, fields, datasetnames={})>
Use a dataset plugin. pluginname: name of plugin to use fields: dict of input values to plugin datasetnames: dict mapping old names to new names of datasets if they are renamed. The new name None means dataset is deleted -

2.9. EnableToolbar

EnableToolbar(enable=True)
Enable/disable the zooming toolbar in the +

2.9. EnableToolbar

EnableToolbar(enable=True)
Enable/disable the zooming toolbar in the plotwindow. This command is only supported in embedded mode or - from veusz_listen.

2.10. Export

Export(filename, color=True, + from veusz_listen.

2.10. Export

Export(filename, color=True, page=0 dpi=100, antialias=True, quality=85, backcolor='#ffffff00', pdfdpi=150, svgtextastext=False)
Export the page given to the filename given. The @@ -922,25 +922,25 @@ dpi to use when exporting EPS or PDF files. svgtextastext says whether to export SVG text as text, rather than curves. -

2.11. FilterDatasets

FilterDatasets(filterexpr, datasets, prefix="", +

2.11. FilterDatasets

FilterDatasets(filterexpr, datasets, prefix="", suffix="", invert=False, replaceblanks=False)
Filter a list of datasets given. Creates new datasets for each with prefix and suffix added to input dataset names. filterexpr is an input numpy eexpression for filtering the datasets. If invert is set, the filter condition is inverted. If replaceblanks is set, filtered values are not removed, but replaced with a blank or NaN value. This command - only works on 1D numeric, date or text datasets.

2.12. ForceUpdate

ForceUpdate()
Force the window to be updated to reflect the current + only works on 1D numeric, date or text datasets.

2.12. ForceUpdate

ForceUpdate()
Force the window to be updated to reflect the current state of the document. Often used when periodic updates have been disabled (see SetUpdateInterval). This command is only - supported in embedded mode or from veusz_listen.

2.13. Get

Get('settingpath')
Returns: The value of the setting given by the path.
+ supported in embedded mode or from veusz_listen.
2.13. Get
Get('settingpath')
Returns: The value of the setting given by the path.
>>> Get('/page1/graph1/x/min') 'Auto' -
2.14. GetChildren
GetChildren(where='.')
Returns: The names of the widgets which are children of - the path given
2.15. GetClick
GetClick()
Waits for the user to click on a graph and returns the +

2.14. GetChildren

GetChildren(where='.')
Returns: The names of the widgets which are children of + the path given

2.15. GetClick

GetClick()
Waits for the user to click on a graph and returns the position of the click on appropriate axes. Command only works in embedded mode.
Returns: A list containing tuples of the form (axispath, val) for each axis for which the click was in range. The value - is the value on the axis for the click.

2.16. GetData

GetData(name)
Returns: For a 1D dataset, a tuple containing the + is the value on the axis for the click.

2.16. GetData

GetData(name)
Returns: For a 1D dataset, a tuple containing the dataset with the name given. The value is (data, symerr, negerr, poserr), with each a numpy array of the same size or None. data are the values of the dataset, symerr are the @@ -954,11 +954,11 @@ data.
data = GetData('x') SetData('x', data[0]*0.1, *data[1:]) -

2.17. GetDataType

GetDataType(name)
Get type of dataset with name given. Returns '1d' for a +

2.17. GetDataType

GetDataType(name)
Get type of dataset with name given. Returns '1d' for a 1d dataset, '2d' for a 2d dataset, 'text' for a text dataset - and 'datetime' for a datetime dataset.

2.18. GetDatasets

GetDatasets()
Returns: The names of the datasets in the current - document.

2.19. GPL

GPL()
Print out the GNU Public Licence, which Veusz is licenced - under.

2.20. ImportFile

ImportFile('filename', 'descriptor', + and 'datetime' for a datetime dataset.

2.18. GetDatasets

GetDatasets()
Returns: The names of the datasets in the current + document.

2.19. GPL

GPL()
Print out the GNU Public Licence, which Veusz is licenced + under.

2.20. ImportFile

ImportFile('filename', 'descriptor', linked=False, prefix='', suffix='', encoding='utf_8', renames={})
Imports data from a file. The arguments are the filename @@ -974,7 +974,7 @@ import.
Returns: A tuple containing a list of the imported datasets and the number of conversions which failed for a dataset.
Changed in version 0.5: A tuple is returned rather than - just the number of imported variables.

2.21. ImportFile2D

ImportFile2D('filename', datasets, + just the number of imported variables.

2.21. ImportFile2D

ImportFile2D('filename', datasets, xrange=(a,b), yrange=(c,d), invertrows=True/False, invertcols=True/False, transpose=True/False, prefix='', suffix='', linked=False, @@ -1002,7 +1002,7 @@ deliminated by using blank lines.
In addition to the matrix of numbers, the various optional parameters this command takes can also be specified in the data file. These commands should be given on separate - lines before the matrix of numbers. They are:
xrange A B
yrange C D
invertrows
invertcols
transpose

2.22. ImportFileCSV

ImportFileCSV('filename', readrows=False, + lines before the matrix of numbers. They are:
xrange A B
yrange C D
invertrows
invertcols
transpose

2.22. ImportFileCSV

ImportFileCSV('filename', readrows=False, dsprefix='', dssuffix='', linked=False, encoding='utf_8', renames={})
This command imports data from a CSV format file. Data @@ -1014,7 +1014,7 @@ the dataset name). linked specifies whether the data will be linked to the file. renames, if set, provides new names for datasets after import. -

2.23. ImportFileHDF5

ImportFileHDF5(filename, items, namemap={}, slices={}, twodranges={}, twod_as_oned=set([]), convert_datetime={}, prefix='', suffix='', renames={}, @@ -1067,7 +1067,7 @@ vsz_attributename_columnname.
Returns: list of imported datasets -

2.24. ImportFilePlugin

ImportFilePlugin('pluginname', 'filename', +

2.24. ImportFilePlugin

ImportFilePlugin('pluginname', 'filename', **pluginargs, linked=False, encoding='utf_8', prefix='', suffix='', renames={})
Import data from file using import plugin 'pluginname'. The @@ -1075,7 +1075,7 @@ encoding, and prefix and suffix to prepend or append to dataset names. renames, if set, provides new names for datasets after import. -

2.25. ImportFITSFile

ImportFITSFile(datasetname, filename, hdu, +

2.25. ImportFITSFile

ImportFITSFile(datasetname, filename, hdu, datacol='A', symerrcol='B', poserrcol='C', negerrcol='D', linked=True/False, renames={})
This command does a simple import from a FITS file. The FITS format is used within the astronomical community to transport @@ -1094,7 +1094,7 @@ columns.
If linked is True, then the dataset is not saved with a saved document, but is reread from the data file each time the document is loaded. renames, if set, provides new names for - datasets after import.

2.26. ImportString

ImportString('descriptor', + datasets after import.

2.26. ImportString

ImportString('descriptor', 'data')
Like, ImportFile, but loads the data from the specfied string rather than a file. This allows data to be easily embedded within a document. The data string is @@ -1107,58 +1107,58 @@ 2 5 3 10 ''') -

2.27. ImportString2D

ImportString2D(datasets, string)
Imports a two-dimensional dataset from the string +

2.27. ImportString2D

ImportString2D(datasets, string)
Imports a two-dimensional dataset from the string given. This is similar to the ImportFile2D command, with the same dataset format within the string. This command, however, does not currently take any optional parameters. The various controlling parameters can be set within the string. See the ImportFile2D section for - details.

2.28. IsClosed

IsClosed()
Returns a boolean value telling the caller whether the + details.

2.28. IsClosed

IsClosed()
Returns a boolean value telling the caller whether the plotting window has been closed.
Note: this command is only supported in the embedding - interface.

2.29. List

List(where='.')
List the widgets which are contained within the widget + interface.

2.29. List

List(where='.')
List the widgets which are contained within the widget with the path given, the type of widgets, and a brief - description.

2.30. Load

Load('filename.vsz')
Loads the veusz script file given. The script file can + description.

2.30. Load

Load('filename.vsz')
Loads the veusz script file given. The script file can be any Python code. The code is executed using the Veusz interpreter.
Note: this command is only supported at the command line and not in a script. Scripts may use the python - execfile function instead.

2.31. MoveToPage

MoveToPage(pagenum)
Updates window to show the page number given of the + execfile function instead.

2.31. MoveToPage

MoveToPage(pagenum)
Updates window to show the page number given of the document.
Note: this command is only supported in the embedding - interface or veusz_listen.

2.32. ReloadData

ReloadData()
Reload any datasets which have been linked to + interface or veusz_listen.

2.32. ReloadData

ReloadData()
Reload any datasets which have been linked to files.
Returns: A tuple containing a list of the imported datasets and the number of conversions which failed for a - dataset.

2.33. Rename

Remove('widgetpath', 'newname')
Rename the widget at the path given to a new name. This + dataset.

2.33. Rename

Remove('widgetpath', 'newname')
Rename the widget at the path given to a new name. This command does not move widgets. See To for a description of the path - syntax. '.' can be used to select the current widget.

2.34. Remove

Remove('widgetpath')
Remove the widget selected using the path. See To for a description of the path - syntax.

2.35. ResizeWindow

ResizeWindow(width, height)
Resizes window to be width by height pixels.
Note: this command is only supported in the embedding - interface or veusz_listen.

2.36. Save

Save('filename.vsz')
Save the current document under the filename - given.

2.37. Set

Set('settingpath', val)
Set the setting given by the path to the value given. If + syntax. '.' can be used to select the current widget.

2.34. Remove

Remove('widgetpath')
Remove the widget selected using the path. See To for a description of the path + syntax.

2.35. ResizeWindow

ResizeWindow(width, height)
Resizes window to be width by height pixels.
Note: this command is only supported in the embedding + interface or veusz_listen.

2.36. Save

Save('filename.vsz')
Save the current document under the filename + given.

2.37. Set

Set('settingpath', val)
Set the setting given by the path to the value given. If the type of val is incorrect, an InvalidType exception is thrown. The path to the setting is the optional path to the widget the setting is contained within, an optional subsetting specifier, and the setting itself.
Set('page1/graph1/x/min', -10.) -

2.38. SetAntiAliasing

SetAntiAliasing(on)
Enable or disable anti aliasing in the plot - window, replotting the image.

2.39. SetData

SetData(name, val, symerr=None, negerr=None, +

2.38. SetAntiAliasing

SetAntiAliasing(on)
Enable or disable anti aliasing in the plot + window, replotting the image.

2.39. SetData

SetData(name, val, symerr=None, negerr=None, poserr=None)
Set the dataset name with the values given. If None is given for an item, it will be left blank. val is the actual data, symerr are the symmetric errors, negerr and poserr and the getative and positive asymmetric errors. The data can be given - as lists or numpys.

2.40. SetDataExpression

SetDataExpression(name, val, symerr=None, negerr=None, + as lists or numpys.

2.40. SetDataExpression

SetDataExpression(name, val, symerr=None, negerr=None, poserr=None, linked=False, parametric=None)
Create a new dataset based on the expressions given. The expressions are Python syntax expressions based on existing datasets.
If linked is True, the dataset will change as the datasets in the expressions change.
Parametric can be set to a tuple of (minval, maxval, numitems). t in the expression will iterate - from minval to maxval in numitems values.

2.41. SetDataRange

SetDataRange(name, numsteps, val, symerr=None, + from minval to maxval in numitems values.

2.41. SetDataRange

SetDataRange(name, numsteps, val, symerr=None, negerr=None, poserr=None, linked=False)
Set dataset to be a range of values with numsteps steps. val is tuple made up of (minimum value, maximum value). symerr, negerr and poserr are optional tuples for the error bars.
If linked is True, the dataset can be saved in a document as a SetDataRange, otherwise it is expanded to the - values which would make it up.

2.42. SetData2D

SetData2D('name', val, xrange=(A,B), + values which would make it up.

2.42. SetData2D

SetData2D('name', val, xrange=(A,B), yrange=(C,D), xgrid=[1,2,3...], ygrid=[4,5,6...])
Creates a two-dimensional dataset with the name given. val is either a two-dimensional numpy array, or is a @@ -1168,54 +1168,54 @@ inclusive range of the X and Y coordinates of the data. xgrid and ygrid are optional lists, tuples or arrays which give the coordinates of the edges of the pixels. There should be one - more item in each array than pixels.

2.43. SetData2DExpression

SetData2DExpression('name', expr, linked=False)
Create a 2D dataset based on expressions. name is the + more item in each array than pixels.

2.43. SetData2DExpression

SetData2DExpression('name', expr, linked=False)
Create a 2D dataset based on expressions. name is the new dataset name expr is an expression which should return a 2D array linked specifies whether to permanently link the - dataset to the expressions.

2.44. SetData2DExpressionXYZ

SetData2DExpressionXYZ('name', 'xexpr', + dataset to the expressions.

2.44. SetData2DExpressionXYZ

SetData2DExpressionXYZ('name', 'xexpr', 'yexpr', 'zexpr', linked=False)
Create a 2D dataset based on three 1D expressions. The x, y expressions need to evaluate to a grid of x, y points, with the z expression as the 2D value at that point. Currently only linear fixed grids are supported. This function is intended to convert calculations or measurements at fixed points into a 2D dataset easily. Missing values are filled - with NaN.

2.45. SetData2DXYFunc

SetData2DXYFunc('name', xstep, ystep, 'expr', + with NaN.

2.45. SetData2DXYFunc

SetData2DXYFunc('name', xstep, ystep, 'expr', linked=False)
Construct a 2D dataset using a mathematical expression of "x" and "y". The x values are specified as (min, max, step) in xstep as a tuple, the y values similarly. If linked remains as False, then a real 2D dataset is created, where values can - be modified and the data are stored in the saved file.

2.46. SetDataDateTime

SetDataDateTime('name', vals)
Creates a datetime dataset of name given. vals is a list - of Python datetime objects.

2.47. SetDataText

SetDataText(name, val)
Set the text dataset name with the values given. + be modified and the data are stored in the saved file.

2.46. SetDataDateTime

SetDataDateTime('name', vals)
Creates a datetime dataset of name given. vals is a list + of Python datetime objects.

2.47. SetDataText

SetDataText(name, val)
Set the text dataset name with the values given. val must be a type that can be converted into a Python list.
SetDataText('mylabel', ['oranges', 'apples', 'pears', 'spam']) -

2.48. SetToReference

SetToReference(setting, refval)
Set setting to match other setting refval - always..

2.49. SetUpdateInterval

SetUpdateInterval(interval)
Tells window to update every interval milliseconds at +

2.48. SetToReference

SetToReference(setting, refval)
Set setting to match other setting refval + always..

2.49. SetUpdateInterval

SetUpdateInterval(interval)
Tells window to update every interval milliseconds at most. The value 0 disables updates until this function is called with a non-zero. The value -1 tells Veusz to update the window every time the document has changed. This will make things slow if repeated changes are made to the document. Disabling updates and using the ForceUpdate command will allow the user to control updates directly.
Note: this command is only supported in the embedding - interface or veusz_listen.

2.50. SetVerbose

SetVerbose(v=True)
If v is True, then extra - information is printed out by commands.

2.51. StartSecondView

StartSecondView(name = 'window + interface or veusz_listen.

2.50. SetVerbose

SetVerbose(v=True)
If v is True, then extra + information is printed out by commands.

2.51. StartSecondView

StartSecondView(name = 'window title')
In the embedding interface, this method will open a new Embedding interface onto the same document, returning the object. This new window provides a second view onto the document. It can, for instance, show a different page to the primary view. name is a window title for the new window.
Note: this command is only supported in the embedding - interface.

2.52. TagDatasets

TagDatasets('tag', ['ds1', 'ds2'...])
Adds the tag to the list of datasets given..

2.53. To

To('widgetpath')
The To command takes a path to a widget and moves to + interface.

2.52. TagDatasets

TagDatasets('tag', ['ds1', 'ds2'...])
Adds the tag to the list of datasets given..

2.53. To

To('widgetpath')
The To command takes a path to a widget and moves to that widget. For example, this may be "/", the root widget, "graph1", "/page1/graph1/x", "../x". The syntax is designed to mimic Unix paths for files. "/" represents the base widget (where the pages reside), and ".." represents the widget next - up the tree.

2.54. Quit

Quit()
Quits Veusz. This is only supported in - veusz_listen.

2.55. WaitForClose

WaitForClose()
Wait until the plotting window has been closed. + up the tree.

2.54. Quit

Quit()
Quits Veusz. This is only supported in + veusz_listen.

2.55. WaitForClose

WaitForClose()
Wait until the plotting window has been closed.
Note: this command is only supported in the embedding - interface.

2.56. Zoom

Zoom(factor)
Sets the plot zoom factor, relative to a 1:1 + interface.

2.56. Zoom

Zoom(factor)
Sets the plot zoom factor, relative to a 1:1 scaling. factor can also be "width", "height" or "page", to zoom to the page width, height or page, respectively.
This is only supported in embedded mode or - veusz_listen.

3. Security

With the 1.0 release of Veusz, input scripts and + veusz_listen.

3. Security

With the 1.0 release of Veusz, input scripts and expressions are checked for possible security risks. Only a limited subset of Python functionality is allowed, or a dialog box is opened allowing the user to cancel the @@ -1227,7 +1227,7 @@ a system are also warned against, specifically Print(), Save() and Export().

If you are running your own scripts and do not want to be bothered by these dialogs, you can run veusz with the - --unsafe-mode option.

Chapter 4. Using Veusz from other programs

Table of Contents

1.1. Older path-based interface
1.2. New-style object interface
1.3. Translating old to new style

1. Non-Qt Python programs

+ --unsafe-mode option.

Chapter 4. Using Veusz from other programs

Table of Contents

1.1. Older path-based interface
1.2. New-style object interface
1.3. Translating old to new style