org-plot.el 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  1. ;;; org-plot.el --- Support for plotting from Org-mode
  2. ;; Copyright (C) 2008-2015 Free Software Foundation, Inc.
  3. ;;
  4. ;; Author: Eric Schulte <schulte dot eric at gmail dot com>
  5. ;; Keywords: tables, plotting
  6. ;; Homepage: http://orgmode.org
  7. ;;
  8. ;; This file is part of GNU Emacs.
  9. ;;
  10. ;; GNU Emacs is free software: you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation, either version 3 of the License, or
  13. ;; (at your option) any later version.
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. ;; GNU General Public License for more details.
  18. ;; You should have received a copy of the GNU General Public License
  19. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  20. ;;; Commentary:
  21. ;; Borrows ideas and a couple of lines of code from org-exp.el.
  22. ;; Thanks to the org-mode mailing list for testing and implementation
  23. ;; and feature suggestions
  24. ;;; Code:
  25. (require 'org)
  26. (require 'org-table)
  27. (eval-when-compile
  28. (require 'cl))
  29. (declare-function gnuplot-delchar-or-maybe-eof "ext:gnuplot" (arg))
  30. (declare-function gnuplot-mode "ext:gnuplot" ())
  31. (declare-function gnuplot-send-buffer-to-gnuplot "ext:gnuplot" ())
  32. (defvar org-plot/gnuplot-default-options
  33. '((:plot-type . 2d)
  34. (:with . lines)
  35. (:ind . 0))
  36. "Default options to gnuplot used by `org-plot/gnuplot'.")
  37. (defvar org-plot-timestamp-fmt nil)
  38. (defun org-plot/add-options-to-plist (p options)
  39. "Parse an OPTIONS line and set values in the property list P.
  40. Returns the resulting property list."
  41. (let (o)
  42. (when options
  43. (let ((op '(("type" . :plot-type)
  44. ("script" . :script)
  45. ("line" . :line)
  46. ("set" . :set)
  47. ("title" . :title)
  48. ("ind" . :ind)
  49. ("deps" . :deps)
  50. ("with" . :with)
  51. ("file" . :file)
  52. ("labels" . :labels)
  53. ("map" . :map)
  54. ("timeind" . :timeind)
  55. ("timefmt" . :timefmt)))
  56. (multiples '("set" "line"))
  57. (regexp ":\\([\"][^\"]+?[\"]\\|[(][^)]+?[)]\\|[^ \t\n\r;,.]*\\)")
  58. (start 0)
  59. o)
  60. (while (setq o (pop op))
  61. (if (member (car o) multiples) ;; keys with multiple values
  62. (while (string-match
  63. (concat (regexp-quote (car o)) regexp)
  64. options start)
  65. (setq start (match-end 0))
  66. (setq p (plist-put p (cdr o)
  67. (cons (car (read-from-string
  68. (match-string 1 options)))
  69. (plist-get p (cdr o)))))
  70. p)
  71. (if (string-match (concat (regexp-quote (car o)) regexp)
  72. options)
  73. (setq p (plist-put p (cdr o)
  74. (car (read-from-string
  75. (match-string 1 options)))))))))))
  76. p)
  77. (defun org-plot/goto-nearest-table ()
  78. "Move the point forward to the beginning of nearest table.
  79. Return value is the point at the beginning of the table."
  80. (interactive) (move-beginning-of-line 1)
  81. (while (not (or (org-at-table-p) (< 0 (forward-line 1)))))
  82. (goto-char (org-table-begin)))
  83. (defun org-plot/collect-options (&optional params)
  84. "Collect options from an org-plot '#+Plot:' line.
  85. Accepts an optional property list PARAMS, to which the options
  86. will be added. Returns the resulting property list."
  87. (interactive)
  88. (let ((line (thing-at-point 'line)))
  89. (if (string-match "#\\+PLOT: +\\(.*\\)$" line)
  90. (org-plot/add-options-to-plist params (match-string 1 line))
  91. params)))
  92. (defun org-plot-quote-timestamp-field (s)
  93. "Convert field S from timestamp to Unix time and export to gnuplot."
  94. (format-time-string org-plot-timestamp-fmt (org-time-string-to-time s)))
  95. (defun org-plot-quote-tsv-field (s)
  96. "Quote field S for export to gnuplot."
  97. (if (string-match org-table-number-regexp s) s
  98. (if (string-match org-ts-regexp3 s)
  99. (org-plot-quote-timestamp-field s)
  100. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\""))))
  101. (defun org-plot/gnuplot-to-data (table data-file params)
  102. "Export TABLE to DATA-FILE in a format readable by gnuplot.
  103. Pass PARAMS through to `orgtbl-to-generic' when exporting TABLE."
  104. (with-temp-file
  105. data-file
  106. (make-local-variable 'org-plot-timestamp-fmt)
  107. (setq org-plot-timestamp-fmt (or
  108. (plist-get params :timefmt)
  109. "%Y-%m-%d-%H:%M:%S"))
  110. (insert (orgtbl-to-generic
  111. table
  112. (org-combine-plists
  113. '(:sep "\t" :fmt org-plot-quote-tsv-field)
  114. params))))
  115. nil)
  116. (defun org-plot/gnuplot-to-grid-data (table data-file params)
  117. "Export the data in TABLE to DATA-FILE for gnuplot.
  118. This means in a format appropriate for grid plotting by gnuplot.
  119. PARAMS specifies which columns of TABLE should be plotted as independent
  120. and dependant variables."
  121. (interactive)
  122. (let* ((ind (- (plist-get params :ind) 1))
  123. (deps (if (plist-member params :deps)
  124. (mapcar (lambda (val) (- val 1)) (plist-get params :deps))
  125. (let (collector)
  126. (dotimes (col (length (first table)))
  127. (setf collector (cons col collector)))
  128. collector)))
  129. (counter 0)
  130. row-vals)
  131. (when (>= ind 0) ;; collect values of ind col
  132. (setf row-vals (mapcar (lambda (row) (setf counter (+ 1 counter))
  133. (cons counter (nth ind row))) table)))
  134. (when (or deps (>= ind 0)) ;; remove non-plotting columns
  135. (setf deps (delq ind deps))
  136. (setf table (mapcar (lambda (row)
  137. (dotimes (col (length row))
  138. (unless (memq col deps)
  139. (setf (nth col row) nil)))
  140. (delq nil row))
  141. table)))
  142. ;; write table to gnuplot grid datafile format
  143. (with-temp-file data-file
  144. (let ((num-rows (length table)) (num-cols (length (first table)))
  145. (gnuplot-row (lambda (col row value)
  146. (setf col (+ 1 col)) (setf row (+ 1 row))
  147. (format "%f %f %f\n%f %f %f\n"
  148. col (- row 0.5) value ;; lower edge
  149. col (+ row 0.5) value))) ;; upper edge
  150. front-edge back-edge)
  151. (dotimes (col num-cols)
  152. (dotimes (row num-rows)
  153. (setf back-edge
  154. (concat back-edge
  155. (funcall gnuplot-row (- col 1) row
  156. (string-to-number (nth col (nth row table))))))
  157. (setf front-edge
  158. (concat front-edge
  159. (funcall gnuplot-row col row
  160. (string-to-number (nth col (nth row table)))))))
  161. ;; only insert once per row
  162. (insert back-edge) (insert "\n") ;; back edge
  163. (insert front-edge) (insert "\n") ;; front edge
  164. (setf back-edge "") (setf front-edge ""))))
  165. row-vals))
  166. (defun org-plot/gnuplot-script (data-file num-cols params &optional preface)
  167. "Write a gnuplot script to DATA-FILE respecting the options set in PARAMS.
  168. NUM-COLS controls the number of columns plotted in a 2-d plot.
  169. Optional argument PREFACE returns only option parameters in a
  170. manner suitable for prepending to a user-specified script."
  171. (let* ((type (plist-get params :plot-type))
  172. (with (if (eq type 'grid) 'pm3d (plist-get params :with)))
  173. (sets (plist-get params :set))
  174. (lines (plist-get params :line))
  175. (map (plist-get params :map))
  176. (title (plist-get params :title))
  177. (file (plist-get params :file))
  178. (ind (plist-get params :ind))
  179. (time-ind (plist-get params :timeind))
  180. (timefmt (plist-get params :timefmt))
  181. (text-ind (plist-get params :textind))
  182. (deps (if (plist-member params :deps) (plist-get params :deps)))
  183. (col-labels (plist-get params :labels))
  184. (x-labels (plist-get params :xlabels))
  185. (y-labels (plist-get params :ylabels))
  186. (plot-str "'%s' using %s%d%s with %s title '%s'")
  187. (plot-cmd (case type
  188. ('2d "plot")
  189. ('3d "splot")
  190. ('grid "splot")))
  191. (script "reset")
  192. ;; ats = add-to-script
  193. (ats (lambda (line) (setf script (concat script "\n" line))))
  194. plot-lines)
  195. (when file ; output file
  196. (funcall ats (format "set term %s" (file-name-extension file)))
  197. (funcall ats (format "set output '%s'" file)))
  198. (case type ; type
  199. (2d ())
  200. (3d (when map (funcall ats "set map")))
  201. (grid (if map (funcall ats "set pm3d map") (funcall ats "set pm3d"))))
  202. (when title (funcall ats (format "set title '%s'" title))) ; title
  203. (mapc ats lines) ; line
  204. (dolist (el sets) (funcall ats (format "set %s" el))) ; set
  205. ;; Unless specified otherwise, values are TAB separated.
  206. (unless (org-string-match-p "^set datafile separator" script)
  207. (funcall ats "set datafile separator \"\\t\""))
  208. (when x-labels ; x labels (xtics)
  209. (funcall ats
  210. (format "set xtics (%s)"
  211. (mapconcat (lambda (pair)
  212. (format "\"%s\" %d" (cdr pair) (car pair)))
  213. x-labels ", "))))
  214. (when y-labels ; y labels (ytics)
  215. (funcall ats
  216. (format "set ytics (%s)"
  217. (mapconcat (lambda (pair)
  218. (format "\"%s\" %d" (cdr pair) (car pair)))
  219. y-labels ", "))))
  220. (when time-ind ; timestamp index
  221. (funcall ats "set xdata time")
  222. (funcall ats (concat "set timefmt \""
  223. (or timefmt ; timefmt passed to gnuplot
  224. "%Y-%m-%d-%H:%M:%S") "\"")))
  225. (unless preface
  226. (case type ; plot command
  227. (2d (dotimes (col num-cols)
  228. (unless (and (eq type '2d)
  229. (or (and ind (equal (1+ col) ind))
  230. (and deps (not (member (1+ col) deps)))))
  231. (setf plot-lines
  232. (cons
  233. (format plot-str data-file
  234. (or (and ind (> ind 0)
  235. (not text-ind)
  236. (format "%d:" ind)) "")
  237. (1+ col)
  238. (if text-ind (format ":xticlabel(%d)" ind) "")
  239. with
  240. (or (nth col col-labels) (format "%d" (1+ col))))
  241. plot-lines)))))
  242. (3d
  243. (setq plot-lines (list (format "'%s' matrix with %s title ''"
  244. data-file with))))
  245. (grid
  246. (setq plot-lines (list (format "'%s' with %s title ''"
  247. data-file with)))))
  248. (funcall ats
  249. (concat plot-cmd " " (mapconcat #'identity
  250. (reverse plot-lines)
  251. ",\\\n "))))
  252. script))
  253. ;;-----------------------------------------------------------------------------
  254. ;; facade functions
  255. ;;;###autoload
  256. (defun org-plot/gnuplot (&optional params)
  257. "Plot table using gnuplot. Gnuplot options can be specified with PARAMS.
  258. If not given options will be taken from the +PLOT
  259. line directly before or after the table."
  260. (interactive)
  261. (require 'gnuplot)
  262. (save-window-excursion
  263. (delete-other-windows)
  264. (when (get-buffer "*gnuplot*") ; reset *gnuplot* if it already running
  265. (with-current-buffer "*gnuplot*"
  266. (goto-char (point-max))))
  267. (org-plot/goto-nearest-table)
  268. ;; Set default options.
  269. (dolist (pair org-plot/gnuplot-default-options)
  270. (unless (plist-member params (car pair))
  271. (setf params (plist-put params (car pair) (cdr pair)))))
  272. ;; collect table and table information
  273. (let* ((data-file (make-temp-file "org-plot"))
  274. (table (org-table-to-lisp))
  275. (num-cols (length (if (eq (first table) 'hline) (second table)
  276. (first table)))))
  277. (run-with-idle-timer 0.1 nil #'delete-file data-file)
  278. (while (eq 'hline (car table)) (setf table (cdr table)))
  279. (when (eq (cadr table) 'hline)
  280. (setf params (plist-put params :labels (first table))) ; headers to labels
  281. (setf table (delq 'hline (cdr table)))) ; clean non-data from table
  282. ;; Collect options.
  283. (save-excursion (while (and (equal 0 (forward-line -1))
  284. (looking-at "[[:space:]]*#\\+"))
  285. (setf params (org-plot/collect-options params))))
  286. ;; Dump table to datafile (very different for grid).
  287. (case (plist-get params :plot-type)
  288. (2d (org-plot/gnuplot-to-data table data-file params))
  289. (3d (org-plot/gnuplot-to-data table data-file params))
  290. (grid (let ((y-labels (org-plot/gnuplot-to-grid-data
  291. table data-file params)))
  292. (when y-labels (plist-put params :ylabels y-labels)))))
  293. ;; Check for timestamp ind column.
  294. (let ((ind (1- (plist-get params :ind))))
  295. (when (and (>= ind 0) (eq '2d (plist-get params :plot-type)))
  296. (if (= (length
  297. (delq 0 (mapcar
  298. (lambda (el)
  299. (if (string-match org-ts-regexp3 el) 0 1))
  300. (mapcar (lambda (row) (nth ind row)) table))))
  301. 0)
  302. (plist-put params :timeind t)
  303. ;; Check for text ind column.
  304. (if (or (string= (plist-get params :with) "hist")
  305. (> (length
  306. (delq 0 (mapcar
  307. (lambda (el)
  308. (if (string-match org-table-number-regexp el)
  309. 0 1))
  310. (mapcar (lambda (row) (nth ind row)) table))))
  311. 0))
  312. (plist-put params :textind t)))))
  313. ;; Write script.
  314. (with-temp-buffer
  315. (if (plist-get params :script) ; user script
  316. (progn (insert
  317. (org-plot/gnuplot-script data-file num-cols params t))
  318. (insert "\n")
  319. (insert-file-contents (plist-get params :script))
  320. (goto-char (point-min))
  321. (while (re-search-forward "$datafile" nil t)
  322. (replace-match data-file nil nil)))
  323. (insert (org-plot/gnuplot-script data-file num-cols params)))
  324. ;; Graph table.
  325. (gnuplot-mode)
  326. (gnuplot-send-buffer-to-gnuplot))
  327. ;; Cleanup.
  328. (bury-buffer (get-buffer "*gnuplot*")))))
  329. (provide 'org-plot)
  330. ;; Local variables:
  331. ;; generated-autoload-file: "org-loaddefs.el"
  332. ;; End:
  333. ;;; org-plot.el ends here