いんちょき通信

GnuplotグラフをWEB用に出力する

新年度が始まってから、妙にGnuplotについて書いた記事のアクセスが多いので、ここは読者に迎合してGnuplotに関する記事を書いてみようと思う。

現在日常的に使用しているPCにGnuplotが入っていなかったので、ダウンロードのため久しぶりにGnuplotの公式ページを訪れてみた。

そこのサポートフォーマットについて見てみると、「mouseable web display formats: HTML5, svg」とあり、どうも知らない間にSVGとHTML5(canvas要素)に対応しているらしい。早速、詳細を確かめるべく公式マニュアルをざっくり読んでみると、次のような記載があった。

CANVAS

set terminal canvas {size , } {background }
{font {}{,}} | {fsize }
{{no}enhanced} {linewidth }
{rounded | butt}
{solid | dashed {dashlength 
}}
{standalone {mousing} | name ''}
{jsdir 'URL/for/javascripts'}
{title ''}

SVG

set terminal svg {size , {|fixed|dynamic}}
{{no}enhanced}
{fname ""} {fsize }
{mouse} {standalone | jsdir }
{name }
{font "{,}"}
{fontfile }
{rounded|butt} {solid|dashed}

要するに、JPEGやPNG、EPSなんかの画像出力と同じようにset terminalでsvgまたはcanvasと指定してあげるとよいということらしい。案外あっけなかった。

せっかくなので、Gnuplotのでもページから拝借した次のスクリプトを出力してみる。

surface1.4.gnu

# set terminal pngcairo  transparent enhanced font "arial,10" fontscale 1.0 size 500, 350 
# set output 'surface1.4.png'
set grid nopolar
set grid xtics nomxtics ytics nomytics noztics nomztics \
 nox2tics nomx2tics noy2tics nomy2tics nocbtics nomcbtics
set grid layerdefault   linetype -1 linecolor rgb "gray"  linewidth 0.200,  linetype -1 linecolor rgb "gray"  linewidth 0.200
set samples 21, 21
set isosamples 11, 11
set title "3D gnuplot demo" 
set xlabel "X axis" 
set xlabel  offset character -3, -2, 0 font "" textcolor lt -1 norotate
set xrange [ -10.0000 : 10.0000 ] noreverse nowriteback
set ylabel "Y axis" 
set ylabel  offset character 3, -2, 0 font "" textcolor lt -1 rotate by -270
set yrange [ -10.0000 : 10.0000 ] noreverse nowriteback
set zlabel "Z axis" 
set zlabel  offset character -5, 0, 0 font "" textcolor lt -1 norotate
splot x**2+y**2, x**2-y**2, x*y, (x**3+y**3)/10

このスクリプトのsplotを実行する前に次のコードを挿入する。

set terminal svg
set output "sample_svg.svg

これで出力したSVGが次のようになる。

つぎにHTML5で出力するときも同様に

set terminal canvas
set output "sample_canvas.html"

この場合はcanvas要素とjavascriptを含んだhtmlファイルが生成される。javascriptファイルだけ生成したい場合はset terminal canvs name "sample_canvas" とする必要がある。また、「canvastext.js」、「gnuplot_common.js」、「gnuplot_mouse.css」が必要となるので、gnuplotインストールディレクトリ以下の「share/js」からコピーし、html内の参照パスを書き換える必要がある。

ちなみに出力はリンク先のようになる。

グラフを公開するときには便利な機能かなと思う。

C/C++からgnuplotを使う

C/C++からgnuplotを使うと題しているが、そもそもgnuplotとは何かについて簡単に紹介する。gnuplot公式サイトにあるとおり、"Gnuplot is a portable command-line driven graphing utility" つまり、コマンドラインベースのグラフ描画ツールである。クロスプラットフォームで、Linuxだけではなく、Windows、Mac用のバイナリも用意されている。

gnuplot自体の詳細な使い方は、公式ドキュメントや下に挙げたWebサイトを参照してほしい。ちなみに私が卒論や修論を書いたときには「使いこなすgnuplot」と「LaTeX2e 美文書作成入門 」を見ながら書いたが、「使いこなすgnuplot」の在庫がなくなってきているようだ。

ここからが本題で、C/C++で書いたプログラムの結果をグラフにする場合の作業を考えると、一般に次のようになる。

1. プログラムから結果をCSVなどでファイル出力する。
2. 出力したCSVファイルをgnuplotに入力しグラフを作成する。

作成するグラフが1つや2つのときはちょっとした手間くらいですむが、いろいろな条件で多数のグラフを作成するとなると、なんとかして自動化をしたくなる。スクリプト化してしまうというのも一つの方法で、私もスクリプト化してグラフの画像ファイルを自動生成していた。じゃあスクリプトでとなると話が終わってしまうので、もう一つの方法として、プログラム内からgnuplotを呼び出してしまうという方法がある。

「gnuplot C」や「gnuplot C++」をキーワードとして検索すると、大きく2つの方法があるようだった。

1. system()関数をつかってシェルやコマンドプロンプトにコマンドを送る
2. パイプをつかってgnuplotのプロセスにコマンドを送る

system関数を送る方は事前にスクリプトでも用意しておき、それを呼び出す文字列をsystem関数の引数とすればいい。ただ、事前にスクリプトを用意しておくことを考えると、2のパイプを使って操作した方が汎用性が高く、使い勝手がよさそうに感じた。

まずは大まかな流れを以下に示す。

1. popen (Windowsの場合は_popen)関数でgnuplotのプロセスとの間にパイプを開く。
2. 1で作成したパイプにfprintfなどでgnuplotのコマンドを入力する。
3. fflushを実行し、2でバッファに溜まっているコマンドをgnuplotのプロセスに書き込む。
4. pclose (Windowsの場合は_pclose)関数でgnuplotのプロセスとの間のパイプを閉じる。

実際のコードは次の通り

#include <cstdio>
#include <cstdlib>

using namespace std;

int main(int argc, char* argv[], char* envp[])
{
	FILE* gnuplot = _popen("pgnuplot", "w") //Linuxではpopen
	fprintf(gnuplot, "plot sin(x)\n"); //y=sin(x)を描画する
	fflush(gnuplot); //バッファを書き出す

	return EXIT_SUCCESS;
}

実行すると次のようなグラフが表示される。

このコードは「gnuplot をC/C++から使う方法」の情報を参照した。サイト内にgnuplotクラスを作成したという記述はあったが、ダウンロードはできなかった。また、「凹みTips」では、この方法でgnuplotクラスを作成していた。

また、stdioではなくiostreamを使えないかと調べたところ、「Boost C++ Libraries」のiostreamを使用すれば、うまくいきそうだという情報もあったが、それはまた今度で。

<gnuplot参考サイト>

• TeX Wiki : gnuplotページ 
• gnuplot のページ (Takeno Lab)
• gnuplotスクリプトの解説

ブログに数式を埋め込んでみる

ブログに数式を表示したいと思い、調べてみると奥村先生のブログに行き当たった。Google Chart APIというものが紹介されていたので、早速試してみる。

<img src="http://chart.apis.google.com/chart?cht=tx&amp;chl=x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}" alt="" />

ようは"chl="の後ろにTeXコマンドで数式を書けばいいようだ。

<img src="http://chart.apis.google.com/chart?cht=tx&amp;chl=\b{\nu}_c=\b{\nu}_p%2B\b{a}dt" alt="" />

URL中に使えない文字は%16進2桁で指定する必要がある。上記の例だと"+"が"%2B"になっている。詳細はMathematical (TeX) Formulasに載っている。

ちなみにこのGoogle Chart APIは名前の通り、本来はチャートをWEB上に表示するためのものらしい。

doxygenで複数言語のドキュメントを生成してみる

前回の記事でドキュメントの生成に目処が立ったので、ちょっと欲張って複数言語のドキュメントを生成してみることにした。とりあえず、英語版ドキュメントと日本後版ドキュメントを出力できるようなコメントの書き方を考えてみる。

何らかの方法で条件付き解釈ができればいいと考えてドキュメントを眺めていると、やっぱり"if"と"endif"がいるじゃないか。doxygen設定のENABLE_SECTIONに定義があるかどうかで条件分岐ができるようだ。しかも例として複数言語で分ける書き方が載っている。まさに求めていたものそのものだ。

とりあえず、ドキュメントの勧めにしたがい"\english = if english"、"\endenglish = endif"、"\japanese = if japanese"、"\endjapanese = endif"というエイリアスを作成した。

さっそくこいつらを使ってコメントを書き換えてみると、要約説明が長くなりすぎる。かといって改行すると詳細説明として解釈されてしまう。困ったときはドキュメントとばかりにドキュメントを調べていると、"\brief"コマンドを使って要約説明を指定できるようだ。そんなこんなでたどり着いた記述方法はこんな感じ。

/**
\english
\brief 英語の要約説明

英語の詳細説明
\warning 警告があればその英語の説明
\param 引き数名 英語の説明
\param 引き数名 英語の説明
\return 戻り値の英語の説明
\endenglish
\japanese
\breif 日本後の要約説明

日本後の詳細説明
\warning 警告があればその日本後の説明
\param 引き数名 日本後の説明
\param 引き数名 日本後の説明
\return 戻り値の日本後の説明
\endjapanese
*/

英語の出力用にはENABLE_SECTIONにenglishを定義し設定をdoxyfile_enとして保存しておく。同じように日本後の設定にはENABLE_SECTIONにjapaneseを定義し、前回のTeX日本語対策として設定した"LATEX_CMD_NAME : platex -kanji=utf8"とPDFLATEXのチェックを外しdoxyfile_jaとして保存しておく。

それぞれを出力した結果はこんな感じ。

• DGL**ドキュメント(日本語)
• DGL** Document (English)

PDFはこんな感じになる。

• refman.pdf (日本語)をダウンロード
• refman.pdf (English)をダウンロード

この調子で他のものにもコメントをつけていくことにする。

doxygenを使ってドキュメントを作成してみる

前々から何かコードを書くたびに、ドキュメントとコメントがないのがいけていないと言い続けてきたが、完全されないまま今に至っていた。

しかし、徐々に書いたコードが増えてきて、自分でもよくわからなくなってきたので、しぶしぶドキュメントを作成することを決意した。決意はしたものの、ちまちまと手で書くのはやはり面倒なので、できるだけ自動生成をしてやろうと思い、doxygenを使おうことにした。

ざっとdoxygenのマニュアルを眺めると、どうやらこんな感じで書けばいいらしい。

/// 要約説明
空白行
/// 詳細説明
/// 詳細説明の続き

こんな感じ書いてやると、直後のクラスや関数の説明と解釈してくれるようだ。要は1行で要約を書いて空行を挟んで詳細説明を書けばいいらしい。

ここで少し欲張ってみることにして、もう少しドキュメントをちゃんと読んでみることにした。よく読むと、引数やメンバ変数などにも説明をつけれるようだ。どうも"\param 変数名 説明"を詳細説明の中に入れるといいらしい。さらに、変数の前にも上に書いたスタイルで説明を追加できるようだ。

こんな感じで、dglwindow.hppにはなんとかコメントを追加し終わった。その結果をdoxygenでhtmlとして出力したのがこちら。

次にdoxygenではTeX出力もしてくれるということがわかったので、TeX→PDFに挑戦した。

何も考えずにTeXアウトプットを選択すると、makeするときに失敗する。デフォルトの設定ではlatexコマンドを使用するようなので、platexにして文字コードをUTF-8を使用するようにした。また、PDFLaTeXも日本後では失敗するようなので、こちらも使用しないように変更した。

LATEX_CMD_NAME : platex -kanji=utf8
PDFLATEX : チェックを外す

出力ディレクトリで、次のコマンドを実行するとPDFが作成される。

$ make && dvipdfmx refman

結果はこちら→>refman.pdfをダウンロード

なかなかそれっぽいものができた。

MacにTeXを導入したときの備忘録

以前の記事でMacにGentoo Prefixを導入してみたが、その動機の大部分を占めていたのはTeX環境を簡単に導入するということだった。しかし、Gentoo PrefixではTeXパッケージがマスクされているので、そのままでは導入できなかった。

というわけで簡単に諦めて、MacTeXパッケージをここからダウンロードしてきてインストールした。サイズが若干でかい(1.5GBくらい)が、RedHatなんかのなぞにでかいISOファイルよりはましだと思うことにした。

ダウンロードさえしてしまえば、インストールはインストーラが勝手にやってくれるので、特に困ることもなく完了。

それだけでは、つまらないのでTeX周りの環境も多少整えることにした。とりあえずEmacsでソースは書くことになりそうだから、YaTeXは必須だろうと思いインストールすることにした。そのときに調べていて気がついたことだが、Carbon Emacsでは"HELP"→"Carbon Emacs Package"→"Net-Install"→"YaTeX"とすると自動でダウンロードしてインストールまでしてくれるらしい。便利な世の中になったもんだ。

インストールが完了したので(自分は何もしていないが)自動起動設定をすることにした。これもたいしたことはなく、"${HOME}/.emacs"ファイルに

1. (setq auto-mode-alist
2.       (cons (cons "\\.tex$" 'yatex-mode) auto-mode-alist))
3. (autoload 'yatex-mode "yatex" "Yet Anothoer LaTeX mode" t)

と追記すればOK。

以前にTeXを使っていたときはDVIファイルはあまり扱わず、たいていPDFに変換していた記憶から、コンパイルの時についでにPDFにまで変換してしまうラッパーを作った。

1. #! /bin/bash
2. LATEX=platex
3. DVIPDF=dvipdfmx
4. ${LATEX} ${1}
5. ${DVIPDF} ${1//'.tex'/'.dvi'}

これをplatexコマンドの代わりに指定すればDVIファイルとPDFファイルの両方を作成してくれる。".emacs"には

(setq tex-command "platexpdf")

こんな感じで書いておけばOK。もちろんパスを通しておくか、そうじゃなければフルパスで書く。

TeX関連の参考URL

• TeX Wiki 奥村先生のところ
• MacWiki リスト/TeX
• YaTeX