Difference between revisions of "Plotting API"
Jump to navigation
Jump to search
(Added content for the user_functions section.) |
(→Packages: Links to the API documentation.) |
||
| Line 3: | Line 3: | ||
The flow of execution for plotting XY-type data in relax is: | The flow of execution for plotting XY-type data in relax is: | ||
| − | * The user function definition in the user_functions.grace module (in the future the user_functions.plotting module). | + | * The user function definition in the [http://www.nmr-relax.com/api/3.3/user_functions.grace-module.html user_functions.grace module] (in the future the user_functions.plotting module). |
| − | * The pipe_control.plotting.write_xy() function. | + | * The [http://www.nmr-relax.com/api/3.3/pipe_control.plotting-module.html pipe_control.plotting.write_xy() function]. |
| − | * The lib.plotting functions write_xy_header() and write_xy_data(). | + | * The [http://www.nmr-relax.com/api/3.3/lib.plotting-module.html lib.plotting] functions write_xy_header() and write_xy_data(). |
== Package: user_functions == | == Package: user_functions == | ||
Revision as of 16:47, 7 February 2015
Packages
The flow of execution for plotting XY-type data in relax is:
- The user function definition in the user_functions.grace module (in the future the user_functions.plotting module).
- The pipe_control.plotting.write_xy() function.
- The lib.plotting functions write_xy_header() and write_xy_data().
Package: user_functions
The user interface for plotting are generally the user functions. Currently this consists of the grace.write and dx.map user functions. However in the future a software independent interface will be gradually implemented via a new plotting user function class. An idea would be to have one user function per graph type, for example:
- plotting.write_2D
- plotting.write_iso3D
- plotting.write_2D_fitted_curves
Package: pipe_control
To use the backend code, you need to import:
from pipe_control.plotting import write_xy
