module NumRu::GGraph - Gphysライブラリマニュアル日本語版（非公式）

RubyDCLを利用したGPhysのためのグラフィックライブラリです。

このモジュールはGPhysを利用していますが、その一部ではありません。より具体的に言うと、このモジュールはGPhysディストリビューションに含まれていますが、NumRu::GPhysクラスはそれについて知らず、GGraphはパブリックメソッドのみによってGPhysにアクセスします。

モジュール関数

margin_info(program=nil, data_source=nil, char_height=nil, date=nil, xl=0.0, xr=0.0, yb=nil, yt=0.0)

下部余白に表示される文字列を設定する

このメソッドはDCL.slmgn(xl, xr, yb, yt)と同様に余白の幅を設定し、1番目と2番目の余白文字列をprogramとdataとして設定します。

引数

program (String or nil) : 下部余白の左側に挿入される文字列で、実行ファイル名を表す。nilの場合は$0の完全パスが使用される
data_source (String or nil) : 下部余白の右側に挿入される文字列で、データファイル名あるいはデータが位置するディレクトリ名を表す。nilの場合は現在のディレクトリの完全パスが使用される（しかし、プログラムのディレクトリと同じ場合は何も表示しない）
date (true, false, nil) : 本日の日付を挿入するかどうか。（true: 常に挿入する, nil: program.lengthが十分に短ければ挿入する, false: 常に挿入しない）
char_height (Float or nil) : V座標で表示する文字列の高さ。nilの場合は内部的に定義される
xl, xr, yb, yl (Float --- nil is available for yb) : V座標における余白サイズ。余白はDCL.slmgn(xl, xr, yb, yt)と同様に設定される。ybがnilの場合は内部的に2.0 * char_heightとして定義される

title(string)

DCL.uxmttl('t',string,0.0)によって題名を表示する。contourなどのグラフィックメソッドはデフォルトでこれを実行する

返り値

annotate(str_ary)

ビューポートの右側余白にテキストを表示する。contourなどのグラフィックメソッドはデフォルトでこれを実行する

引数

str_ary (Array of String) :

返り値

fig(xax=nil, yax=nil, options=nil)

ビューポート、ウィンドウ、座標変換ID（itr）を2つの1次元VArray（xaxおよびyax）で設定し、図を定義する（投影法が任意のパラメータitrで指定されていればVArrayは必要ない）
与えられたオプションに従ってDCL.grfrmもしくはDCL.grfigが実行される。

引数

xax (VArray) : （投影法が指定されない場合のみ）図のx（水平）座標を代表するVArray。ウィンドウのxの幅(DCLにおけるUXMINとUYMAX)はxax.valの最大値と最小値によって決定される。デフォルトでは、最小値と最大値は左と右の境界にそれぞれ配置されるが、xaxが'positive'属性を持ちその値が'down'などの場合は逆転する（options参照）
yax (VArray): （投影法が指定されない場合のみ） xaxと同様。図のy（鉛直）座標を代表する
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
new_frame	true	DCL.grfrmで新しいフレームを定義するかどうか(falseならば、DCL.grfigを実行する)
no_new_fig	false	trueならば、 DCL.grfrmとDCL.grfigはどちらも実行されない（new_frameを上書きする）ので、あらかじめどちらかを実行する必要がある。grfrmもしくはgrfigによってリセットされるDCLパラメータを設定するのに便利
itr	1	座標変換番号
viewport	[0.2, 0.8, 0.2, 0.8]	[vxmin, vxmax, vymin, vymax]
eqdistvpt	false	ビューポートをxとyが等間隔になるように修正する（itr=1～4のみ）
window	nil	(itr<10,>50において) [uxmin, uxmax, uymin, uymax]。各要素はnilでもよい（itr<5,>50の場合のみ）
xreverse	positive:down,units:hPa	(itr<10,>50の場合)条件を満たしていればUXMINに最大値、UXMAXに最小値を配置する（nil:常に実行しない, true:常に実行する,　String:属性が指定された値を持てば実行("key:value,key:value,..")）
yreverse	positive:down,units:hPa	(itr<10,>50の場合)条件を満たしていればUYMINに最大値、UYMAXに最小値を配置する（nil:常に実行しない, true:常に実行する,　String:属性が指定された値を持てば実行("key:value,key:value,..")）
round0	false	expand window range to good numbers (effective only to internal window settings)
round1	false	expand window range to good numbers (effective even when "window" is explicitly specified)
similar	nil	（直角曲線座標のみ）直角曲線座標での相似変換のための3つの要素を持つ浮動小数配列。DCL::grssim:[simfac,vxoff,vyoff]で与えられる。simfacはスケーリングファクター、[vxoff,vyoff]は原点移動
map_axis	nil	(全ての地図投影に対して) DCL::umscnt: [uxc, uxy, rot]で与えられる浮動少数配列。[uxc, uyc]は接点（もしくは円筒投影における上側の極）、rotは回転角度。nilの場合は内部的に決定(units: degrees)
map_radius	nil	(itr>=20の円錐/方位角投影に対して) 接点周りの半径(units: degrees)
map_fit	nil	(itr=10(円筒),11(メルカトル)のみ)true:データウィンドウにグラフを合わせる（map_windowとmap_axisは上書きされる）, false:合わせない（map_windowとmap_axisが使われる）, nil:itr==10の場合はtrue,itr==11の場合はfalse
map_rsat	nil	(itr=30のみ)地球中心からの衛星距離(sgpack用のパラメータ"RSAT")
map_window	[-180, 180, -75, 75]	(itr<20: 円筒投影に対して)地図を描く緯度経度ウィンドウ[lon_min, lon_max, lat_min, lat_max ](units: degres)
help	false	trueの場合、ヘルプメッセージを表示

返り値

起こりうるエラー

NumRu::DCL関係 / TypeError関係
optionsがオプション名にマッチしないキーを持っている
optionsが曖昧なキーを持っている

set_fig(options)

figのオプションの初期値を変更

引数

options (Hash) : figのoptionsと同じ

返り値

置換された値（このメソッドが実行される前の値）を持つHash

起こりうるエラー

fig参照

next_fig(options)

次のfigの実行時のみオプション値が有効になるように設定（その後はクリアされる）
次のfigの実行時にオプション値が明示的に指定されている場合、これらの値は上書きされる

引数

options (Hash) : figのoptionsと同じ

返り値

起こりうるエラー

fig参照

axes(xax=nil, yax=nil, options=nil)

（デフォルトで）xaxとyaxがnil以外の場合、それらの情報を用いて軸を描く

引数

xax (nil or VArray): nil以外の場合、xtitleとxunits(以下参照)を定義するために'long_name'属性と'units'属性が読み込まれる。これらはxtitleとxunitsを明示的に指定することで上書きされる
yax (nil or VArray): nil以外の場合、ytitleとyunits(以下参照)を定義するために'long_name'属性と'units'属性が読み込まれる。これらはytitleとyunitsを明示的に指定することで上書きされる
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
xside	tb	xaxesを描く場所（t,b,uの組み合わせ）
yside	lr	yaxesを描く場所（l,r,uの組み合わせ）
xtitle	nil	x軸の題名（nilの場合は内部的に決定）
ytitle	nil	y軸の題名（nilの場合は内部的に決定）
xunits	nil	x軸の単位（nilの場合は内部的に決定）
yunits	nil	y軸の単位（nilの場合は内部的に決定）
xtickint	nil	x軸の目盛間隔（nilの場合は内部的に決定）
ytickint	nil	y軸の目盛間隔（nilの場合は内部的に決定）
xlabelint	nil	x軸のラベル間隔（nilの場合は内部的に決定）
ylabelint	nil	y軸のラベル間隔（nilの場合は内部的に決定）
xmaplabel	nil	"lon"("lat")の場合、DCLExt::lon_ax(DCLExt::lat_ax)を用いてxaxesを描く。それ以外は、DCL::usxaxsを使用
ymaplabel	nil	"lon"("lat")の場合、DCLExt::lon_ax(DCLExt::lat_ax)を用いてyaxesを描く。それ以外は、DCL::usyaxsを使用
time_ax	nil	カレンダータイプの時間軸の形式。nil:自動選択、false:軸の単位がsince fieldを持つ時間的なものであっても、時間軸を使わない、"h":nilと似ているが、dclext_datetime_ax.rb中の時間(hour)的解像度のdatetime_axを使う、"ymd":"h"と似ているが、DCL.uc[xy]aclを用いてy-m-d型を使う
help	false	trueの場合、ヘルプメッセージを表示

返り値

起こりうるエラー

NumRu::DCL関係 / TypeError関係
optionsがオプション名にマッチしないキーを持っている
optionsが曖昧なキーを持っている

set_axes(options)

axes用オプションの初期値を変更する

引数

options (Hash) : axesのoptionsと同じ

返り値

置換された値（このメソッドが実行される前の値）を持つHash

起こりうるエラー

axes参照

next_axes(options)

次のaxesの実行時のみオプション値が有効になるように設定（その後はクリアされる）
次のaxesの実行時にオプション値が明示的に指定されている場合、これらの値は上書きされる

引数

options (Hash) : axesのoptionsと同じ

返り値

起こりうるエラー

axes参照

sim_trn?

現在の座標変換が直交曲線座標かどうかを返す。座標変換はfigもしくはDCL::grstrfによって確定されていなければならない。主に内部用だが、ユーザーの使用も可能

返り値

true or false

polar_coordinate_boundaries(xax=nil,yax=nil)

極座標で境界を描く

引数

xax (VArray): 半径方向座標系の格子点
yax (VArray): 方位角方向座標系の格子点

返り値

map_trn?

現在の座標変換が地図投影かどうかを返す。座標変換はfigもしくはDCL::grstrfによって確定されていなければならない。主に内部用だが、ユーザーの使用も可能

返り値

true or false

map(options=nil)

（地図投影に対して）地図格子や周縁、海岸線などを描く

引数

options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
lim	true	周縁を描く(t or f)
grid	true	地図格子を描く(t or f)
vpt_boundary	false	ビューポートの境界を描く(f, t もしくは線幅として1,2,3..)
wwd_boundary	false	ワークステーションの境界を描く(f, t もしくは線幅として1,2,3..)
fill	false	coast_worldかcoast_japanがtrueの場合、その地図を塗りつぶす(t or f)
coast_world	false	世界の海岸線を描く(t or f)
border_world	false	国境を描く(t or f)
plate_world	false	プレート境界を描く(t or f)
state_usa	false	アメリカ合衆国の州の境界を描く(t or f)
coast_japan	false	日本の海岸線を描く(t or f)
pref_japan	false	日本の県境を描く(t or f)
dgridmj	nil	主要な緯度線と経度線の間隔。nilの場合、内部的に決定(units: degrees)（これはUMPACKパラメータで、uminitかgrfrmが実行される際に無効になる）
dgridmn	nil	補助的な緯度線と経度線の間隔。nilの場合、内部的に決定(units: degrees)（これはUMPACKパラメータで、uminitかgrfrmが実行される際に無効になる）
help	false	trueの場合、ヘルプメッセージを表示

返り値

起こりうるエラー

座標変換が確定していないかその変換が地図投影でない場合に実行された
NumRu::DCL関係 / TypeError関係
optionsがオプション名にマッチしないキーを持っている
optionsが曖昧なキーを持っている

set_map(options)

map用オプションの初期値を変更する

引数

options (Hash) : mapのoptionsと同じ

返り値

置換された値（このメソッドが実行される前の値）を持つHash

起こりうるエラー

map参照

next_map(options)

次のmapの実行時のみオプション値が有効になるように設定（その後はクリアされる）
次のmapの実行時にオプション値が明示的に指定されている場合、これらの値は上書きされる

引数

options (Hash) : mapのoptionsと同じ

返り値

起こりうるエラー

map参照

line(gphys, newframe=true, options=nil)

gphysが2次元以上の場合、(GPhys#firstIDを用いて)1次元目を選択し、折れ線を描く

引数

gphys (GPhys) : データを描くGPhysオブジェクト
newframe (true/false) : trueの場合、内部的にfig、axes、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
title	nil	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
exchange	false	x軸とy軸の交換
index	1	ライン/マークのインデックス
type	1	ラインタイプ
label	nil	Stringが与えられた場合、ラベルとして表示
max	nil	データの最大値
min	nil	データの最小値
legend	nil	挿入するラインタイプとインデックスの凡例。nil（初期値）ならば表示しない。凡例としてStringを設定。trueならばGPhysオブジェクトが持つ名前を凡例として使用
legend_vx	nil	(legendがtrueの場合に有効) 凡例線の左辺のビューポートにおけるxの値(正の浮動小数)、もしくはnilで自動設定（ビューポートの右側に表示）、負の浮動小数で左に相対移動
legend_dx	nil	(legendがtrueの場合に有効)凡例線の長さ
legend_vy	nil	(legendがtrueの場合に有効)凡例のビューポートにおけるyの値（浮動小数、もしくはnilで自動設定）
legend_size	nil	(legendがtrueの場合に有効)凡例の文字サイズ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)
help	false	trueの場合、ヘルプメッセージを表示

返り値

mark(gphys, newframe=true, options=nil)

lineと同様だが、曲線を描く代わりにマークをプロットする

引数

gphys (GPhys) : データを描くGPhysオブジェクト
newframe (true/false) : trueの場合、内部的にfig、axes、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
title	nil	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
exchange	false	x軸とy軸の交換
index	1	マークのインデックス
type	2	マークタイプ
size	0.01	マークサイズ
max	nil	データの最大値
min	nil	データの最小値
legend	nil	挿入するマークタイプとインデックス、サイズの凡例。nil（初期値）ならば表示しない。trueならばGPhysオブジェクトが持つ名前を凡例として使用
legend_vx	nil	((legendがtrueの場合に有効) 凡例線の左辺のビューポートにおけるxの値(正の浮動小数)、もしくはnilで自動設定（ビューポートの右側に表示）、負の浮動小数で左に相対移動
legend_vy	nil	(legendがtrueの場合に有効)凡例のビューポートにおけるyの値（浮動小数、もしくはnilで自動設定）
legend_size	nil	(legendがtrueの場合に有効)凡例の文字サイズ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)
help	false	trueの場合、ヘルプメッセージを表示

返り値

scatter(fx, fy, newframe=true, options=nil)

散布図（markと同様にuumrkzを使用）

引数

fx, fy (GPhys) : xとyの位置
newframe (true/false) : trueの場合、内部的にfig、axes、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション

オプション名	初期値	説明
title	""	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
index	1	マークのインデックス
type	2	マークタイプ
size	0.01	マークサイズ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
xintv"	1	データサンプリングにおけるxの間隔
yintv	1	データサンプリングにおけるyの間隔
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)
help	false	trueの場合、ヘルプメッセージを表示

color_scatter(fx, fy, fz, newframe=true, options=nil)

値によってカラーリングされた散布図
カラーリングはちょうどtoneでのように、fzに関して行われる。このメソッドの後にcolor_barを実行することでカラーバーを描ける

引数

fx, fy (GPhys) : xとyの位置
fz (GPhys) : 色の基準となる値
newframe (true/false) : trueの場合、内部的にfig、axes、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション

オプション名	初期値	説明
title	""	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
index	3	マークインデックス(1-9)
type	10	マークタイプ
size	0.01	マークサイズ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
clr_min	nil	整数(10..99)が指定された場合、最小データ値のための色番号として使用(uepackパラメータの"icolor1"を設定することでも同様に可能)
clr_max	nil	整数(10..99)が指定された場合、最大データ値のための色番号として使用(uepackパラメータの"icolor2"を設定することでも同様に可能)
keep	false	前に使われたトーンレベルとパターンを使用
min	nil	最小トーンレベル
max	nil	最大トーンレベル
nlev	nil	レベルの個数
interval	nil	コンター間隔
log	nil	近似的にログスケールされたレベル(DCLExt::quasi_log_levelsを使用)
log_cycle	3	(logが有効な場合)1オーダーにおけるレベルの個数(1,2,3)
levels	nil	トーンレベル（数値的なArray/NArray）。patternsと共に作用する
patterns	nil	(<<tone>>))のpattersオプションと同様だが、ここではカラーパート（4,5桁目）のみ使用（例パターン:38999 → カラー:38）
xintv	1	データサンプリングにおけるxの間隔
yintv	1	データサンプリングにおけるyの間隔
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)
help	false	trueの場合、ヘルプメッセージを表示

add_mode_vectors(mean, modes, options)

散布図にモードベクトルを重ねて描く。scatter/color_scatterの後に実行する

引数

mean : ベクトルの中心を決定する
modes : [2,2]、[2,1]、[2]の形状を持つ2次元モードベクトル（例えばEOFモード）
- 1番目のモードはモード[true,0]、2番目のモードはモード[true,1]
options (Hash) : デフォルトの振る舞いを変更するオプション

オプション名	初期値	説明
lineindex	1	ラインインデックス
linetype	1	ラインタイプ
fact	2	スケーリングファクター（各サイドにおいて、ラインの長さ=stddev×fact）
style	'line'	表示しているモードのスタイル(line, arrow, ellipse)

tone_and_contour(gphys, newframe=true, options=nil)

toneとcontourを続けて実行。それぞれに対してオプションを指定できる。

注意

これらのメソッドに存在しないオプションキーは単純に無視される。そのため、単体でcontourやtoneを実行する際とは異なり、スペルチェックのようなフィードバックは行われない。また、toneのヘルプメニューのみ表示可能
numru-misc-0.0.6かそれ以上が必要

contour(gphys, newframe=true, options=nil)

gphysが3次元以上の場合は、（GPhys$first2Dを用いて）最初の2次元を選択しコンターを描く
コンターレベルは次のように決まる

set_contour_levelsが実行されないかlevelsオプションで明示的に指定されない場合は、コンターレベルはこのメソッドによって設定される
コンターレベルがこのメソッドで設定されているときは、levelsオプションは最も高い優先を持つ。これが指定されている場合は、index、line_type、label、label_heightの各オプションが使用される。levelsが指定されていない場合は、線形増加のコンターレベルはmin、max、nlev、interval、nozero、coloring、clr_min、clr_maxの各オプションを使用して設定される。これらはDCLExt::ud_set_linear_levsによって解釈される。線形レベル設定の初期値はset_linear_contour_optionsで変更可能

引数

gphys (GPhys) : データを描くGPhysオブジェクト
newframe (true/false) : trueの場合、内部的にfig、axes、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
title	nil	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
transpose	false	x軸とy軸の交換
exchange	false	transposeオプションと同じ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
keep	false	前に使われたコンターレベルを使用
min	nil	コンターレベルの最小値
max	nil	コンターレベルの最大値
nlev	nil	レベルの個数
interval	nil	コンターの間隔
nozero	nil	ゼロコンターを消去
coloring	false	ud_coloringでカラーコンターを設定
clr_min	13	(coloringが有効な場合) 最小データ値のための最小カラー番号
clr_max	99	(coloringが有効場合) 最大データ値のための最大カラー番号
help	false	trueの場合、ヘルプメッセージを表示
log	nil	近似的にログスケールされたレベル(DCLExt::quasi_log_levelsを使用)
log_cycle	3	(logが有効な場合)1オーダーにおけるレベルの個数(1,2,3)
levels	nil	コンターレベル(数値的なArray/NArray)
index	nil	(levelsが有効な場合)ラインインデックス（整数のArray/NArray、整数、nil）
line_type	nil	(levelsが有効な場合)ラインタイプ（整数のArray/NArray、整数、nil）
label	nil	(levelsが有効な場合)コンターレベル（StringのArray/NArray、String、true、false、nil）。nilを推奨
label_height	nil	(levelsが有効な場合)ラベルの高さ（NumericのArray/NArray、Numeric、nil）。nilを推奨
xintv	1	データサンプリングにおけるxの間隔
yintv	1	データサンプリングにおけるyの間隔
xcoord	nil	x軸の座標変数名
ycoord	nil	y軸の座標変数名
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)

返り値

set_contour_levels(options)

オプションレベルの値によって明示的にcontour用のコンターレベルを設定する

引数

options (Hash) : デフォルトの振る舞いを変更するオプション。levelsオプションは必須（つまり任意ではない）。サポートされるオプションはlevels、index、line_type、label、label_height。これらの説明はcontour参照

clear_contour_levels

set_contour_levelsによってコンターレベルを消去する

set_linear_contour_options(options)

contourで設定される線形のコンターレベルについてオプションの初期値を変更する

引数

options (Hash) : contourのoptionsと同様だが、サポートされるオプションはmin、max、nlev、interval、nozero、coloring、clr_min、clr_maxに限られる

返り値

置換された値（このメソッドが実行される前の値）を持つHash

next_linear_contour_options(options)

set_linear_contour_optionsと同様だが、次のcontourの実行のみ設定が有効.

tone(gphys, newframe=true, options=nil)

gphysが3次元以上の場合は、（GPhys$first2Dを用いて）最初の2次元を選択しトーンあるいはシェードに色をつける
トーンレベルは次のように決定される

set_tone_levelsによって設定されるかlevelsオプション（任意で"patterns"オプションも）が明示的に指定されない限り、トーンレベルはこのメソッドによって設定される
コンターレベルとパターンがこのメソッドで設定される場合、

levelオプションは最も高い優先を持つ。これが指定されている場合は、トーンレベルとパターンはDCLExt::ue_set_toneを用いて決定される。ここでは、トーンパターンはpatternsオプションで設定することができる
現在、levelsオプションが指定されている場合に限りpatternsオプションは有効であり、それ以外では無視され、(DCL.uegtlbを用いて)内部的に決定される
そうでない場合、ltone=true（これが初期値）ならば線形トーンレベルが設定され、ltone=falseならばシェードが設定される。シェードはDCLのUDPACKの中で次のパラメータによって決定される。そのため、ここではltone=falseであるかに関わらず、DCL.udpget('ltone')==trueならば色付けが行われる。線形レベルがこのメソッドで設定される際、min、max、nlev、intervalの各オプションが指定されていたら使用される。これらはDCLExt::ue_set_linear_levsによって解釈される。これらの初期値はset_linear_tone_optionsによって変更できる。

引数

gphys (GPhys) : データを描くGPhysオブジェクト
newframe (true/false) : trueの場合、内部的にfig、axes（あるいは[map>#map]]）、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
title	nil	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
ltone	true	udpackパラメータのltoneと同様
tonf	false	DCL.uetoneの代わりにDCL.uetonfを使う
tonb	false	DCL.uetoneの代わりにDCL.uetonbを使う
tonc	false	DCL.uetoneの代わりにDCL.uetoncを使う
clr_min	nil	整数(10..99)が指定された場合、最小データ値のための色番号として使用(uepackパラメータの"icolor1"を設定することでも同様に可能)
clr_max	nil	整数(10..99)が指定された場合、最大データ値のための色番号として使用(uepackパラメータの"icolor2"を設定することでも同様に可能)
transpose	false	x軸とy軸を交換
exchange	false	transposeと同じ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
keep	false	前に使われたトーンレベルとパターンを使用
color_bar	false	カラーバーを追加。ただし、これはクイックルックのためのものなので、オプションをフルコントロールするためにはGGraph::color_barメソッドを明示的に使用する
min	nil	トーンレベルの最小値
max	nil	トーンレベルの最大値
nlev	nil	レベルの個数
interval	nil	コンターの間隔
help	false	trueの場合、ヘルプメッセージを表示
log	nil	近似的にログスケールされたレベル(DCLExt::quasi_log_levelsを使用)
log_cycle	3	(logが有効な場合)1オーダーにおけるレベルの個数(1,2,3)
levels	nil	トーンレベル(NumericのArray/NArray)。patternsと共に作用する
patterns	nil	トーンパターン(NumericのArray/NArray)。levelsとともに作用する
xintv	1	データサンプリングにおけるxの間隔
yintv	1	データサンプリングにおけるyの間隔
xcoord	nil	x軸の座標変数名
ycoord	nil	y軸の座標変数名
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)

返り値

color_bar (options=nil)

DCLext.color_barを実行してカラーバーを描く

set_tone_levels(options)

値によって明示的にトーンにトーンレベルを設定する

引数

options (Hash) : デフォルトの振る舞いを変更するオプション。サポートされるオプションはlevelsとpatterns。どちらも明示的に指定されなければならない（つまり任意ではない）

clear_tone_levels

set_tone_levelsによってトーンレベルセットをクリアする

set_linear_tone_options(options)

toneの線形トーンレベルについてオプションの初期値を変更する

引数

options (Hash) : toneのoptionsと同様だが、サポートされるオプションはmin、max、nlev、intervalに制限される

返り値

置換された値（このメソッドが実行される前の値）を持つHash

next_linear_tone_options(options)

set_linear_tone_optionsと同様だが、次のtoneの実行のみ設定が有効

set_unit_vect_options(options)

next_unit_vect_options(options)

vector(fx, fy, newframe=true, options=nil)

DCL_Ext::flow_vectを用いて2次元ベクトルを描く。これは物理（”U”）座標系のベクトルをスケールする

引数

fx, fy (GPhys) : ベクトル
newframe (true/false) : trueの場合、内部的にfig、axes（あるいはmap）、title、annotateを実行。falseの場合、折れ線のみを描く（既にある図に描き足す）
options (Hash) : デフォルトの振る舞いを変更するオプション。キーと値のオプション名(String)を持つハッシュ。オプションはNumRu::Misc::KeywordOptAutoHelpによって解釈されるため、その意味が明確な場合は（値を省略することで）キーを短縮できる

オプション名	初期値	説明
title	nil	図の題名（nilの場合、内部的に決定）
annotate	true	falseの場合、newframe==trueであっても右側余白に文字を挿入しない
transpose	false	x軸とy軸を交換
exchange	false	transposeと同じ
map_axes	false	[itr=10(円筒形)の場合のみ使用]trueならば、GGraph::axesを実行してitr=1へ一時的に変更して軸を描く
flow_vect	true	trueならば、ベクトルの描画にDCLExt::flow_vectを使用。その他の場合はDCL::ugvectを使用
flow_itr5	false	trueならば、ベクトルの描画にDCLExt::flow_itr5を使用。その他の場合は、DCLExt::flow_vectもしくはDCL::ugvectを使用
keep	false	前の実行と同様のベクトルスケーリングを使用。現在はflow_vectがtrueの場合のみ作用する
xintv	1	(flow_vectが有効の場合のみ有効)データサンプリングにおけるxの間隔
yintv	1	(flow_vectが有効の場合のみ有効)データサンプリングにおけるyの間隔
factor	1.0	(flow_vectが有効の場合のみ有効）矢印の長さを拡大/縮小するスケーリングファクター
unit_vect	false	単位ベクトルを表示
max_unit_vect	false	(flow_vectとunit_vectの両方が有効の場合のみ有効）trueなら単位ベクトルをスケールするために最大の矢印を使用、それ以外はV座標系に合わせる
help	false	trueの場合、ヘルプメッセージを表示
xcoord	nil	x軸の座標変数名
ycoord	nil	y軸の座標変数名
slice	nil	描画する前にデータをGPhys#[]メソッドへ渡して部分集合化するArray(適用される順番: slice → cut → mean)
cut	nil	描画する前にデータをGPhys#cutメソッドへ渡して部分集合化するArrayもしくはHash(適用される順番: slice → cut → mean)
mean	nil	描画する前にデータをGPhys#meanへ渡して平均化するArray(適用される順番: slice → cut → mean)

返り値

このページを編集するこのページを元に新規ページを作成

印刷する

カテゴリ：
学問・理系
総合

module NumRu::GGraph - Gphysライブラリマニュアル日本語版（非公式）先頭へ