Gphysライブラリマニュアル日本語版(非公式) - class NumRu::Grid
物理量の離散化格子を処理するクラスです。
クラスメソッド
Grid.new( *axes )
コンストラクタ
返り値
Gridオブジェクト
インスタンスメソッド
axnames
軸の名前を返す。
返り値
StringのArrayオブジェクト
lost_axes
処理中に失われた軸上の情報を返す。
例えば描画の注釈に便利(適用にはGGraphのコードを参照)。
返り値
StringのArrayオブジェクト
axis(dim_or_dimname)
Axisオブジェクトを返す。
引数
dim_or_dimname
(String or Integer) : 軸の指定
返り値
Axisオブジェクト
dim_index(dimname)
dimension
の整数ID(ゼロからカウント)を返す。
引数
dimname
(String or Integer) : これが整数の場合、このメソッド自明
返り値
Integerオブジェクト
coord_dim_indices(coordname)
座標系の名前 → 次元インデックス
引数
coordname
(String) : 座標系の名前
返り値
座標系が存在する場合は次元インデックスを持つArrayオブジェクト(座標系が1次元の場合、配列の長さは1)
Arrayオブジェクト
Integerオブジェクト
nil
set_axis(dim_or_dimname,ax)
軸を設定する。
引数
dim_or_dimname
(String or Integer) : 軸を指定
ax
(Axis) : 軸
返り値
self
set_lost_axes( lost )
失われた軸上の情報を設定する
返り値
self
add_lost_axes( lost )
既に存在する軸に失われた軸の情報を追加する。
返り値
self
delete_axes( at, deleted_by=nil )
軸を消去する。
引数
at
(String or Integer) : 軸を指定
deleted_by
(String or nil) : nilでない場合、内部のlost-axis情報に書き込まれる。このメソッドが実行されるメソッドの名前を挿入するのがベスト
返り値
Gridオブジェクト
copy
メモリ上に深いクローンを作成
返り値
Gridオブジェクト
merge(other)
基本的にselfの軸のコピーを用いて2つの格子を結合するが、selfの中の軸の長さが1でその他の軸の長さのほうが長い場合は、他の軸が使われる。
引数
other
(Grid)
返り値
Gridオブジェクト
shape
selfの形状を返す。
返り値
IntegerのArrayオブジェクト
[*slicer]
部分集合を返す。
引数
NArray#[]、NetCDFVar#[]等と同じ
返り値
Gridオブジェクト
cut(*args)
[]
と同じだが、物理座標系によって部分集合を指定する。
引数
pattern 1:
[]
と同様だが、1番目の引数は1番目の次元の部分集合を指定する
pattern 2: Hashオブジェクト。キーは軸の名前。
例
Pattern 1
gphys.cut(135.5,0..20.5,false)
Pattern 2
gphys.cut({'lon'=>135.5,'lat'=>0..20})
返り値
Arrayオブジェクト : [Gridオブジェクト,
slicer
]。
slicer
は(GPhys#cutで使うため、)varrayに対応する部分集合を作るために使われる配列
cut_rank_conserving(*args)
cut
と同様だが、あらゆる次元(長さが1でも)も失わずに階数を維持する。
cut_assoccoord(hasharg)
関連座標について切り取る。
cut
と同様だが、引数がHashオブジェクトのときはハッシュキーが関連座標の名前になる。
change_axis(dim, axis)
軸を置き換える。(新たなオブジェクトを返す)
引数
dim_or_dimname
(String or Integer) : 軸の指定
axis
(Axis)
返り値
Gridオブジェクト
transpose( *dims )
転置する。
引数
dims
(integers) : 例えば、2次元オブジェクトを転置するなら[1,0]、3次元オブジェクトならば、[1,0,2]、[2,1,0]など
返り値
Gridオブジェクト