gpgui help

# gpgui ヘルプドキュメント

for ver 1.0.0 - 1.1.0

目次

- gpguiについて
- 必要環境
- 準備
- 起動方法
- 使い方

## gpguiについて

gpguiは、gnuplotを用いて素早く2次元データプロットグラフを 作成するために作られたGUIフロントエンドです。 特に学術目的でグラフを作成する用途を念頭に置いており、 レポート作成や学会発表等に利用するグラフの作成に適しています。

gnuplotはグラフプロットのための強力なソフトであり、 学術目的にも適した美しいグラフを作成することができます。 しかし数多くのコマンドを駆使する必要があり、 グラフを作成しようとするたびにコマンドを記述したスクリプトを用意し、 スクリプトを編集しながら作業することになります。

gpguiではこのスクリプトファイルの作成を手動ですることなく、 GUI上で操作するだけでツールがgnuplotにコマンドを渡し、グラフを 簡単に作成することができます。 また、外部コマンドと連携することでGUI上からpngファイルへの変換や epsファイルおよびpngファイル作成後のプレビューも行うことが できます。

さらにグラフを作成する際に使用したコマンドをスクリプトファイルに出力し、 自分でカスタマイズを加えることが可能です。 また、出力だけでなくスクリプトの読み込みにも対応しており、 gnuplotコマンドのスクリプトを読み込ませることができます。 これはgpguiで出力したものであってもなくても構いません。 この機能は作業中の状態をファイルに保存する用途にも使えます。

## 必要環境

- 動作環境
  - UNIX系OS
  - gnuplot(4.2以上推奨)
  - ruby/Gtk2
- 外部コマンド(オプション設定で変更可能)
  - epsビューア(デフォルト：gv)
  - epsからpngへの変換コマンド(デフォルト：epstoimg)
  - pngビューア(デフォルト：eog)
  - エディタ(デフォルト：gedit)

## 準備

- まず、rubyをインストールしてください。ほとんどの場合 パッケージ管理システムで用意されていると思います。

- 次に、ruby/Gtk2環境をインストールします。 パッケージ管理システムで用意されていない場合は公式サイト
  http://ruby-gnome2.sourceforge.jp/
  にアクセスしてダウンロードし、インストールしてください。

- gnuplotについてはバージョン4.2以上が望ましいです。4.2未満でも 一応動作しますが、一部の機能が無効になります。

- そして外部コマンドが用意されているか確認してください。 これらのコマンドはメニューのオプション設定で後から変更し、 別のコマンドを割り当てることが可能です。

  これらがなくてもgpgui単体でgnuplotスクリプトを吐き出すことはできます。

  - epsビューア(デフォルト：gv)

    デフォルトで割り当てているgv は動作の軽いps/epsビューアです。大抵の環境ではパッケージ管理システムで用意されていると思います。

  - epsからpngへの変換コマンド(デフォルト：epstoimg)

    デフォルトで割り当てているepstoimg はpythonを利用したPostScript/イメージファイルの変換スクリプトです。 Ghostscriptに付属でついてくるpstoimgよりもかなりきれいに変換 することができます。詳細については公式ページ
    http://imgtops.sourceforge.net/
    を参照してください。

  - pngビューア(デフォルト：eog)

    デフォルトで割り当てているeogはGnome環境でのデフォルト画像ビューアです。

  - エディタ(デフォルト：gedit)

    デフォルトで割り当てているgeditはGnome環境でのデフォルトエディタです。

## 起動方法

ダウンロードしたファイルを解凍したディレクトリで コマンドラインから

ruby gpgui.rb

とタイプしてください。

## 使い方

- メニュー
- 設定
- 「全般」タブ
- 「系列」タブ
- 「X軸」「Y軸」「Y2軸」タブ
- 「凡例」タブ
- 「その他」タブ
- 処理実行ボタン

### メニュー

- ファイル
  - スクリプト読込

    gnuplotスクリプトを読み込みます。 ここで指定するファイルはgnuplotのコマンドを 羅列したファイルです。 自分で記述したもの、gnuplotのsaveコマンドで出力したもの、 gpguiのスクリプト書き出し機能で出力したもの のいずれも指定可能です。

    gpguiのスクリプト書き出し機能で出力したものには コメント部にgnuplotコマンド以外の情報が記述されており、 それを用いた場合スクリプト書き出しをしたときのgpguiの状態を 再現して作業の続きを再開することができます。

  - 終了

    gpguiを終了します。

- オプション
  - 設定...

    オプション設定ウィンドウを開きます。

- ヘルプ
  - About

    このソフトについて表示します。

### 設定

メニューの「オプション」>「設定...」から開く オプション設定ウィンドウで設定できる項目です。

ここでの設定内容はホームディレクトリに".gpgui"というファイルを 生成して保存されます。

- コマンド

  使用する外部コマンドの設定です。コマンドの呼出の際は シェルを経由しますので、環境変数$PATHが参照されます。 絶対パスでの記述も可能です。

  - gnuplot

    gnuplot起動コマンドを入力します。 gpguiはここで指定したプログラムの標準入力に コマンドを送信します。

    デフォルト値："gnuplot"

  - epsビューア

    eps出力ファイルを表示するのに使用するコマンドです。 ここで指定したプログラムの引数としてepsファイル名が 渡されます。

    デフォルト値："gv"

  - eps->png変換

    デフォルト値："epstoimg -q -w 1000 -o %p %e"

  - pngビューア

    png出力ファイルを表示するのに使用するコマンドです。 ここで指定したプログラムの引数としてpngファイル名が 渡されます。

    デフォルト値："eog"

  - データファイルビューア

    データファイルを表示及び編集するのに使用するコマンドです。 ここで指定したプログラムの引数としてデータファイル名が 渡されます。

    デフォルト値："gedit"

- フォント

  フォントに関する設定です。

  - 出力に使うフォント名

    epsプレビュー・eps/png出力に使用されるフォント名です。

### 「全般」タブ

ここでは、データファイルプロットに必要な基本情報を設定します。

- データファイル

  gnuplotでプロット対象となるデータファイルを この項目で指定します。

  - ファイルパス

    データファイルのファイル名を指定します。 フルパス・相対パスともに使用可能です。

    「参照...」ボタンを押すとファイルブラウザから選択することが できます。また、「閲覧...」ボタンを押すと オプション設定で 設定したエディタを起動してデータファイルを開きます。

  対応するgnuplotコマンド：plot "データファイル" ...

- 区切り文字

  データファイル中の項目の区切り文字を指定します。

  - スペース：区切り文字をスペースに設定します。
  - コンマ：区切り文字をコンマに設定します。
  - タブ：区切り文字をタブに設定します。

  対応するgnuplotコマンド：set datafile separator "区切り文字"

- コメント開始文字

  データファイル中でコメント行の開始を示す文字を この項目で指定します。

  - 文字を続けて列挙

    コメント行の行頭を示す文字を続けて記述します。 コメント開始文字は1文字です。複数文字でコメント開始を 示すことはできません。

  対応するgnuplotコマンド：set datafile commentschars "コメント開始文字"

- スクリプト出力

  スクリプト出力機能で書き込むスクリプトファイルを ここで指定します。

  - ファイルパス

    スクリプトファイルのパスを指定します。 絶対パス・相対パスともに使用可能です。

    「参照...」ボタンを押すとファイルブラウザから選択することが できます。

  対応するgnuplotコマンドはありません。

- eps出力

  eps出力機能で書き込むepsファイルを ここで指定します。

  - ファイルパス

    epsファイルのパスを指定します。 絶対パス・相対パスともに使用可能です。

    「参照...」ボタンを押すとファイルブラウザから選択することが できます。

  対応するgnuplotコマンド：set output "ファイルパス"

- png出力

  png出力機能で書き込むpngファイルを ここで指定します。

  - ファイルパス

    pngファイルのパスを指定します。 絶対パス・相対パスともに使用可能です。

    「参照...」ボタンを押すとファイルブラウザから選択することが できます。

  対応するgnuplotコマンドはありません。

### 「系列」タブ

ここではプロットするデータ系列の登録、及び系列ごとの データ列指定や計算式・見た目の設定などを行います。

- プロットするデータ系列

  ここではプロットするデータ系列を登録します。 ここで登録した数の分のグラフが描かれることになります。

  「追加」ボタンを押すと系列を新たに一つ追加登録します。

  「削除」ボタンを押すとその系列を削除します。

  「↑」「↓」ボタンで系列の順序を入れ替えることができます。 この順序は凡例の順序に反映され、またこの順序でグラフが上から 重ね書きされていくので、グラフが交差する部分では 後の順序のグラフが描画されることになります。

  データ系列ごとに設定できる項目は次の通りです。

  - X(x=n列目), Y(y=n列目)

    どの列を使ってプロットするのかを指定します。 例えば2列目なら、データ区切り文字で区切られた 部分で2番めのデータを使うという意味です。

    系列を新たに追加したときは、X値として1列目、 Y値として現在あるデータ列のうち列が最も大きい数字のもの +1番めの列が設定されます。

    対応するgnuplotコマンド：plot "データファイル" using x:y

  - Xプロット式, Yプロット式

    実際にプロットに使用する値を計算する式を指定します。 使用する列として指定した列の値を変数x,yとして 式に含めることができます。 デフォルトではx*1e0、つまり列の値そのものが適用されます。

    例えば、Y値として使用したい列を100倍してプロットする場合、 Yプロット式に"y*1e3"を指定します。

    また、プロット式にx,yを含めないときはx,yとして指定した列に 関係なくプロット値が計算されます。

    例えば、2列目と3列目の2乗平均をY値としてプロットしたい場合は Yプロット式に"sqrt($2**2+$3**3)"を指定します。

    対応するgnuplotコマンド：plot "データファイル" using Xプロット式:Yプロット式

  - 第2Y軸

    このチェックボックスをオンにすると、グラフを第2Y軸に 対してプロットします。

    対応するgnuplotコマンド：plot "データファイル" axis x1y2

  - タイトル

    系列のタイトルを設定します。これは凡例の表記に使用されます。 空にした場合、凡例にこの系列は表示されません。

    対応するgnuplotコマンド：plot "データファイル" title "タイトル"

  - スタイル

    プロットスタイルを設定します。 「線のみ」「線とポイント」「ポイントのみ」 から選択することができます。

    対応するgnuplotコマンド：plot "データファイル" with スタイル

  - 色

    プロットに使用する色を設定します。

    対応するgnuplotコマンド：set style line N linecolor rgb "色"
    (set style increment user が必要)

  - ポイント

    プロットに使用するポイントの種類を指定します。

    プロットスタイルで「線のみ」を指定した場合 この指定は意味を持ちません。

    対応するgnuplotコマンド：set style line N pointtype ポイント
    (set style increment user が必要)

  - 線幅

    プロットに使用する線の幅を指定します。

    プロットスタイルで「ポイントのみ」を指定した場合 この指定は意味を持ちません。

    対応するgnuplotコマンド：set style line N linewidth 線幅
    (set style increment user が必要)

  - 線種

    プロットに使用する実線/破線の種類を指定します。

    プロットスタイルで「ポイントのみ」を指定した場合 この指定は意味を持ちません。

    対応するgnuplotコマンド：set style line N linetype 線種
    (set style increment user が必要)

- 全体に適用

  ここで指定した値は登録されたプロット系列全てに適用されます。

  - ポイントサイズ

    プロットに使用するポイントの大きさを指定します。

    対応するgnuplotコマンド：set pointsize ポイントサイズ

  - Xプロット式、Yプロット式、スタイル、線幅

    これらについては、個別に設定するときと 設定できる内容は同一です。

- ポイント順をリセット

  登録された系列群のポイントの種類の順序をデフォルトに戻します。

- 色順をリセット

  登録された系列群の色の順序をデフォルトに戻します。

### 「X軸」「Y軸」「Y2軸」タブ

ここでは軸ごとに設定を行います。ラベル・スケール・ 数値表示形式・範囲・目盛・グリッドの設定を行えます。

各軸で設定できる項目はまったく同等です。

- ラベル(軸のタイトル)

  ここでは、軸につけるラベルの設定をします。

  - ラベル

    ラベルとして表示する文字列を設定します。

    対応するgnuplotコマンド：set xlabel "ラベル"
    (ylabel, y2labelについても同様)

  - 位置調整

    ラベルの表示位置を調整します。調整できる方向は 軸に対して垂直な方向で、距離に相当する文字数で指定します。 軸から離れる方向を正とし、負の値も指定可能です。

    対応するgnuplotコマンド：set xlabel "ラベル" offset 0,-位置調整
    set ylabel "ラベル" offset -位置調整,0
    set y2label "ラベル" offset 位置調整,0

  - フォントサイズ

    ラベルのフォントサイズを指定します。

    対応するgnuplotコマンド：set xlabel font "フォント名,フォントサイズ"
    (ylabel, y2labelについても同様)

- スケール

  軸のスケールを設定します。

  - 線形

    スケールを線形に設定します。

    対応するgnuplotコマンド：unset logscale x
    y, y2についても同様

  - 対数

    スケールを対数に設定します。

    対応するgnuplotコマンド：set logscale x
    y, y2についても同様

- 数値表示形式

  ここでは軸に表示する数値の表示について設定します。

  - 自動/小数のみ/指数のみ/小数+指数

    軸に表記する数値の書式を選択します。

    「自動」では、数値は自動で判断された書式で表示されます。

    この書式では小数部分の末尾の0は表示されません。

    対応するgnuplotコマンド：set format x "%g"
    (y, y2についても同様)

    「小数のみ」では、数値は小数で表示されます。

    対応するgnuplotコマンド：set format x "%.0f" (小数点以下の桁0の場合)
    (y, y2についても同様)

    「指数のみ」では、数値を浮動小数点表記したときの 指数部分のみが「10n」として表示されます。

    対応するgnuplotコマンド：set format x "10^{%T}"
    (y, y2についても同様)

    「小数+指数」では、数値を浮動小数点表記し、 「小数部×10n」として表示されます。

    対応するgnuplotコマンド：set format x "%.0t{/Symbol \264}10^{%T}" (小数点以下の桁0の場合)
    (y, y2についても同様)

  - 小数点以下の桁

    数値の書式中の小数点以下の桁を設定します。 数値の書式に「指数のみ」を指定した場合、 ここの設定は意味を持ちません。

  - フォントサイズ

    軸に表示する数値のフォントサイズを指定します。

    対応するgnuplotコマンド：set xtics font "フォント名,フォントサイズ"
    (ytics, y2ticsについても同様)

- 範囲

  軸の最大値・最小値を指定します。自動とするには、アスタリスク "*"を指定します。

  - 最小値

    軸の最小値を指定します。

  - 最大値

    軸の最大値を指定します。

  対応するgnuplotコマンド：set xrange [最小値:最大値]
  (yrange, y2rangeについても同様)

- 目盛

  ここでは軸に振る目盛について設定します。デフォルトではすべて自動です。

  - 目盛を手動で振る

    このチェックボックスをオンにすると、目盛の最小値・最大値・間隔を 指定して手動で目盛を振ることができます。オフにした場合、目盛は 自動で振られます。

  - 最小値/最大値/間隔

    最小値：目盛を振る最小の値を指定します。

    最大値：目盛を振る最大の値を指定します。

    間隔：目盛の間隔を指定します。

    対応するgnuplotコマンド：set xtics 最小値,間隔,最大値
    (ytics, y2ticsについても同様)

  - 小目盛を手動で振る

    このチェックボックスをオンにすると、小目盛の目盛分割数を 手動で設定することができます。

  - 小目盛で目盛をn分割する

    小目盛で大目盛を分割する数を指定します。ここで指定するのは 分割数であって、大目盛の間に入る小目盛の数ではないことに 注意してください。小目盛の数+1が指定する値になります。

    対応するgnuplotコマンド：set mxtics 分割数
    (mytics, my2ticsについても同様)

- グリッドを表示

  グリッドを表示する場合はチェックボックスをオンにします。

  対応するgnuplotコマンド：set grid xtics
  (ytics, y2ticsについても同様)

- 小目盛グリッド

  小目盛グリッドを表示する場合はチェックボックスをオンにします。

  対応するgnuplotコマンド：set grid mxtics
  (mytics, my2ticsについても同様)

### 「凡例」タブ

ここでは凡例の設定を行います。凡例自体の表示切り替え・ 位置・表示形式の調整が行えます。

- 凡例を表示する

  このチェックボックスをオンにすることで、凡例を表示させます。 オフの場合、凡例は表示されず、「凡例」タブでの設定内容は意味を持ちません。

  対応するgnuplotコマンド：set nokey (チェックボックスがオフ)

- 位置

  ここでは凡例を表示する位置を設定します。指定できる位置は グラフの内側四隅、およびグラフ外側の右側上/中/下、 グラフの下の左/中央/右です。

  対応するgnuplotコマンド：set key 位置指定ワード1 位置指定ワード2
  (位置指定ワード1,2はleft/right/top/bottom/rmargin/bmarginの組み合わせです。)

- 表示

  ここでは凡例の表示に関する設定を行います。

  - 左揃え/右揃え

    凡例の説明文の揃え位置を選択します。

    対応するgnuplotコマンド：set key Right / set key Left

  - 記号と説明を左右反転（記号が左）

    このチェックボックスをオンにすると、凡例の記号サンプルが右に、 説明文が左になります。オフでは逆になります。

    対応するgnuplotコマンド：set key reverse

  - 上下間隔

    凡例が縦に並ぶときの上下間隔を、デフォルト間隔の 倍数として指定します。

    対応するgnuplotコマンド：set key spacing 上下間隔

  - 幅調整

    ここでは凡例の説明文の表示幅調整を行います。 説明文の幅はgnuplot内では フォントサイズの文字数倍で計算されているため、 等幅でない(プロポーショナルな)フォントでは実際の幅と ずれてしまいます。そこに補正をかけるのが目的です。

    幅として加算したい分の文字数で指定します。負の値も指定可能です。

    対応するgnuplotコマンド：set key width 幅調整

  - フォントサイズ

    凡例のフォントサイズを指定します。

    gnuplotには凡例自体のフォントサイズを指定する方法がありません。 しかし、凡例以外のフォントサイズは指定しておけるので、 ターミナルのデフォルトのフォントサイズを変更して 凡例のみに影響をあたえることができます。

    対応するgnuplotコマンド：set terminal postscript "フォント名" フォントサイズ

### 「その他」タブ

ここではいままでの設定項目でカバーしきれなかった 部分の設定を行うことができます。

- 余白

  ここでは、グラフ周囲の余白を設定することができます。 この余白はグラフ描画領域から、全描画領域までの距離であり、 軸に表示する数値や軸ラベルが描画される部分を含みます。

  上下左右のテキストボックスに、設定したい余白に相当する 長さ分の文字数を入力します。

  対応するgnuplotコマンド：set rmargin 文字数
  (lmargin, tmargin, bmarginについても同様)

- 縦横比

  グラフの縦横比を設定します。これは軸に表示する数値・軸タイトル・凡例を 含んだ描画領域全体の縦横比であり、 グラフ領域のみの縦横比ではないことに注意してください。

  横方向は5インチ、縦方向は3インチ以下にならないように サイズを計算して出力します。

  対応するgnuplotコマンド：set terminal postscript size Xサイズ・Yサイズ

### 処理実行ボタン

ウィンドウ下部にある各種処理に関連付けられたボタンを押すことで、 処理を実行することができます。

- スクリプト出力

  現在の設定でgnuplotスクリプトを出力します。 このファイルの内容は epsプレビュー・eps出力に使われる内容と同じです。

- epsプレビュー

  現在の設定を利用してepsファイル出力のプレビューを行います。 一時ファイルに書き込むこと以外は「eps出力」と同じです。

- eps出力

  現在の設定を利用してepsファイルを出力します。 このepsファイルはgnuplotのepsターミナルを利用して出力されます。 スクリプト出力で出力したファイルを gnuplotで処理させてもまったく同じものを得ることができます。

  オプション設定で epsビューアが正しく設定されていれば、自動的にビューアを 起動し、出力結果を表示します。

  ビューアが起動できない場合はepsファイルを生成した旨の メッセージを表示します。

- png出力

  現在の設定を利用してpngファイルを出力します。 これは一旦epsファイルを出力した後、 オプション設定 で設定した変換コマンドを使用して epsからpngへと変換を行います。

  オプション設定で pngビューアが正しく設定されていれば、自動的にビューアを 起動し、出力結果を表示します。

  ビューアが起動できない場合はpngファイルを生成した旨の メッセージを表示します。

Copyright ©2008 Takaaki Kasai